Class StudentNewsSurvey

Hierarchy

StudentNewsItem
- StudentNewsSurvey

Index

Constructors

constructor

new StudentNewsSurvey(client, data, categories): StudentNewsSurvey
Parameters
- client: Pronote
- data: {
      L?: string;
      N: string;
      auteur: string;
      categorie: PronoteValue<24, {
          L: string;
          N: string;
      }>;
      dateCreation: PronoteValue<7, string>;
      dateDebut: PronoteValue<7, string>;
      dateFin: PronoteValue<7, string>;
      elmauteur: PronoteValue<24, {
          G: number;
          L: string;
          N: string;
      }>;
      estAuteur: boolean;
      estInformation: boolean;
      estProlonge: boolean;
      estSondage: boolean;
      genrePublic: number;
      listeQuestions: PronoteValue<24, {
          L: string;
          N: string;
          P: number;
          avecMaximum: boolean;
          genreReponse: PronoteApiNewsQuestionType;
          listeChoix: PronoteValue<24, {
              L: string;
              N: string;
              estReponseLibre?: boolean;
              rang: number;
          }[]>;
          listePiecesJointes: PronoteValue<24, PronoteApiAttachment[]>;
          nombreReponsesMax: number;
          rang: number;
          reponse: PronoteValue<24, {
              N: string;
              avecReponse: boolean;
              estRepondant: boolean;
              estReponseAttendue: boolean;
              reponduLe?: PronoteValue<7, string>;
              strRepondant?: string;
              valeurReponse?: string | {
                  V: string;
                  _T: number;
              };
              valeurReponseLibre?: string;
          }>;
          tailleReponse: number;
          texte: PronoteValue<21, string>;
          titre: string;
      }[]>;
      lue: boolean;
      prenom: string;
      public: PronoteValue<24, {
          G: PronoteApiUserResourceType;
          L: string;
          N: string;
          P: number;
      }>;
      reponseAnonyme: boolean;
  }
  - Optional L?: string
    Title of the news.
    Example
    "Coucou tout le monde !"
  - N: string
  - auteur: string
    Full name of the author of this news.
    Example
    "John D."
  - categorie: PronoteValue<24, {
    L: string;
    N: string;
    }>
    Category this news belongs to.
  - dateCreation: PronoteValue<7, string>
    Full date this news was created.
    Example
    "15/02/2024 23:09:10" // in the server timezone
  - dateDebut: PronoteValue<7, string>
    Date this news should be displayed.
    Example
    "15/02/2024"
  - dateFin: PronoteValue<7, string>
    Date this news should be stopped from being displayed.
    Example
    "06/07/2024"
  - elmauteur: PronoteValue<24, {
        G: number;
        L: string;
        N: string;
    }>
    More information about the author ? TODO: Find out for why this is needed ?
  - estAuteur: boolean
    Whether you are the author of this news.
  - estInformation: boolean
    Whether this news is actually a news or not.
  - estProlonge: boolean
    TODO: Not sure what this does.
  - estSondage: boolean
    Whether this news is actually a survey or not.
  - genrePublic: number
  - listeQuestions: PronoteValue<24, {
        L: string;
        N: string;
        P: number;
        avecMaximum: boolean;
        genreReponse: PronoteApiNewsQuestionType;
        listeChoix: PronoteValue<24, {
            L: string;
            N: string;
            estReponseLibre?: boolean;
            rang: number;
        }[]>;
        listePiecesJointes: PronoteValue<24, PronoteApiAttachment[]>;
        nombreReponsesMax: number;
        rang: number;
        reponse: PronoteValue<24, {
            N: string;
            avecReponse: boolean;
            estRepondant: boolean;
            estReponseAttendue: boolean;
            reponduLe?: PronoteValue<7, string>;
            strRepondant?: string;
            valeurReponse?: string | {
                V: string;
                _T: number;
            };
            valeurReponseLibre?: string;
        }>;
        tailleReponse: number;
        texte: PronoteValue<21, string>;
        titre: string;
    }[]>
  - lue: boolean
    Whether this news have been read or not.
  - prenom: string
    Student's first name.
  - public: PronoteValue<24, {
        G: PronoteApiUserResourceType;
        L: string;
        N: string;
        P: number;
    }>
    Student's more info. This is needed to update the news' state.
  - reponseAnonyme: boolean
    Whether your response is anonymous or not.
- categories: StudentNewsCategory[]
Returns StudentNewsSurvey
Overrides StudentNewsItem.constructor
- Defined in parser/news.ts:197

Properties

`Private` `Readonly` #author

#author: string

`Private` `Readonly` #category

#category: StudentNewsCategory

`Private` `Readonly` #client

#client: Pronote

`Private` `Readonly` #creationDate

#creationDate: Date

`Private` `Readonly` #endDate

#endDate: Date

`Private` `Readonly` #id

#id: string

`Private` `Readonly` #isAnonymous

#isAnonymous: boolean

`Private` `Readonly` #public

#public: PronoteApiNewsPublicSelf

`Private` `Readonly` #questions

#questions: StudentNewsItemQuestion[]

`Private` #read

#read: boolean

`Private` `Readonly` #startDate

#startDate: Date

`Private` `Optional` `Readonly` #title

#title?: string

Accessors

`Private` #stateInformation

get #stateInformation(): {
    id: string;
    public: PronoteApiNewsPublicSelf;
    title: string;
}
Internal helper to get the current news state information.

Returns {
    id: string;
    public: PronoteApiNewsPublicSelf;
    title: string;
}
- id: string
- public: PronoteApiNewsPublicSelf
- title: string
Inherited from StudentNewsItem.#stateInformation
- Defined in parser/news.ts:90

author

get author(): string
Name of the author of the information / survey.

Returns string
Example
```
"John D."
```
Inherited from StudentNewsItem.author
- Defined in parser/news.ts:171

creationDate

get creationDate(): Date
Returns Date
Inherited from StudentNewsItem.creationDate
- Defined in parser/news.ts:155

endDate

get endDate(): Date
Returns Date
Inherited from StudentNewsItem.endDate
- Defined in parser/news.ts:163

id

get id(): string
Returns string
Inherited from StudentNewsItem.id
- Defined in parser/news.ts:143

isAnonymous

get isAnonymous(): boolean
Whether your response is anonymous or not.

Returns boolean
- Defined in parser/news.ts:216

public

get public(): PronoteApiNewsPublicSelf
Low level data about the public information of the user that'll send answers. Used internally when sending answers to the server.

Most of the time, you won't need this.

Returns PronoteApiNewsPublicSelf
Inherited from StudentNewsItem.public
- Defined in parser/news.ts:181

questions

get questions(): StudentNewsItemQuestion[]
List of the questions contained in this survey. You can answer them by reassigning the answer property.

Returns StudentNewsItemQuestion[]
Example
```
question.answer = "[1..2]";
```
- Defined in parser/news.ts:211

read

get read(): boolean
Whether this news have been read or not.

Returns boolean
Inherited from StudentNewsItem.read
- Defined in parser/news.ts:188

startDate

get startDate(): Date
Returns Date
Inherited from StudentNewsItem.startDate
- Defined in parser/news.ts:159

title

get title(): undefined | string
Returns undefined | string
Inherited from StudentNewsItem.title
- Defined in parser/news.ts:147

Methods

answer

answer(answers?, alsoMarkAsRead?): Promise<void>
Answers the survey with the given answers. By default, it'll answer with the questions that were given when the survey was created.

You can either manipulate the questions directly or pass in your own answers.
Parameters
- answers: StudentNewsItemQuestion[] = ...
- alsoMarkAsRead: boolean = true
Returns Promise<void>
- Defined in parser/news.ts:226

delete

delete(): Promise<void>
Will delete the news from the user's news feed.

Returns Promise<void>
Remark
You can never get the news back after this.
Inherited from StudentNewsItem.delete
- Defined in parser/news.ts:119

markAsRead

markAsRead(status?): Promise<void>
Patches the read state of the news to the given value.
Parameters
- status: boolean = true
Returns Promise<void>
Remark
Will do nothing if this.read === status.
Inherited from StudentNewsItem.markAsRead
- Defined in parser/news.ts:102

patchQuestions

patchQuestions(questions, alsoMarkAsRead?): Promise<void>
Low level method, used internally to patch questions (from acknowledge() and answer()).

Most of the time, you won't need this.
Parameters
- questions: StudentNewsItemQuestion[]
- alsoMarkAsRead: boolean = true
Returns Promise<void>
Inherited from StudentNewsItem.patchQuestions
- Defined in parser/news.ts:132

Class StudentNewsSurvey

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional L?: string

Example

N: string

auteur: string

Example

categorie: PronoteValue<24, { L: string; N: string; }>

dateCreation: PronoteValue<7, string>

Example

dateDebut: PronoteValue<7, string>

Example

dateFin: PronoteValue<7, string>

Example

elmauteur: PronoteValue<24, { G: number; L: string; N: string; }>

estAuteur: boolean

estInformation: boolean

estProlonge: boolean

estSondage: boolean

genrePublic: number

lue: boolean

prenom: string

public: PronoteValue<24, { G: PronoteApiUserResourceType; L: string; N: string; P: number; }>

reponseAnonyme: boolean

Returns StudentNewsSurvey

Properties

Private Readonly #author

Private Readonly #category

Private Readonly #client

Private Readonly #creationDate

Private Readonly #endDate

Private Readonly #id

Private Readonly #isAnonymous

Private Readonly #public

Private Readonly #questions

Private #read

Private Readonly #startDate

Private Optional Readonly #title

Accessors

Private #stateInformation

Returns { id: string; public: PronoteApiNewsPublicSelf; title: string; }

id: string

public: PronoteApiNewsPublicSelf

title: string

author

Returns string

Example

category

Returns StudentNewsCategory

creationDate

Returns Date

endDate

Returns Date

id

Returns string

isAnonymous

Returns boolean

public

Returns PronoteApiNewsPublicSelf

questions

Returns StudentNewsItemQuestion[]

Example

read

Returns boolean

startDate

Returns Date

title

Returns undefined | string

Methods

answer

Parameters

Returns Promise<void>

`Optional` L?: string

categorie: PronoteValue<24, {
L: string;
N: string;
}>

elmauteur: PronoteValue<24, {
G: number;
L: string;
N: string;
}>

public: PronoteValue<24, {
G: PronoteApiUserResourceType;
L: string;
N: string;
P: number;
}>

`Private` `Readonly` #author

`Private` `Readonly` #category

`Private` `Readonly` #client

`Private` `Readonly` #creationDate

`Private` `Readonly` #endDate

`Private` `Readonly` #id

`Private` `Readonly` #isAnonymous

`Private` `Readonly` #public

`Private` `Readonly` #questions

`Private` #read

`Private` `Readonly` #startDate

`Private` `Optional` `Readonly` #title

`Private` #stateInformation

Returns {
id: string;
public: PronoteApiNewsPublicSelf;
title: string;
}