Class StudentNewsInformation

Hierarchy

StudentNewsItem
- StudentNewsInformation

Index

Constructors

Constructors

constructor

new StudentNewsInformation(client, data, categories): StudentNewsInformation
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 StudentNewsInformation
Overrides StudentNewsItem.constructor
- Defined in parser/news.ts:402

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` #public

#public: PronoteApiNewsPublicSelf

`Private` `Readonly` #question

#question: 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

acknowledged

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

Returns boolean
Remark
This is not the same as reading the news, see read property.
- Defined in parser/news.ts:435

acknowledgedDate

get acknowledgedDate(): undefined | Date
Date when the news have been acknowledged. Only available if acknowledged is true.

Returns undefined | Date
- Defined in parser/news.ts:443

attachments

get attachments(): StudentAttachment[]
Returns StudentAttachment[]
- Defined in parser/news.ts:427

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

content

get content(): string
HTML string containing the news.

Returns string
- Defined in parser/news.ts:452

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

needToAcknowledge

get needToAcknowledge(): boolean
Returns boolean
- Defined in parser/news.ts:447

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

question

get question(): StudentNewsItemQuestion
Low level data about the "question" contained inside this information.

You can use this to serialize the question and finally send it back to the server using pronote.patchNewsState(data, [question], extra).

Internally, acknowledged, content, attachments, ... are based on this, we're just renaming the properties and adding some sugar on top of it.

Returns StudentNewsItemQuestion
Remark
Most of the time, you won't need this, but it's here if you need it.
- Defined in parser/news.ts:467

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

acknowledge

acknowledge(alsoMarkAsRead?): Promise<void>
Will acknowledge the news if needed, so if the news doesn't need to be acknowledged (!needToAcknowledge) or is already acknowledged, we will just do the read step.

When acknowledging, the news will be directly marked as read. If you want to change this behavior, you can change the alsoMarkAsRead parameter.
Parameters
- alsoMarkAsRead: boolean = true
Returns Promise<void>
Remark
You can't un-acknowledge a news.
- Defined in parser/news.ts:418

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 StudentNewsInformation

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 StudentNewsInformation

Properties

Private Readonly #author

Private Readonly #category

Private Readonly #client

Private Readonly #creationDate

Private Readonly #endDate

Private Readonly #id

Private Readonly #public

Private Readonly #question

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

acknowledged

Returns boolean

Remark

acknowledgedDate

Returns undefined | Date

attachments

Returns StudentAttachment[]

author

Returns string

Example

category

Returns StudentNewsCategory

content

Returns string

creationDate

Returns Date

endDate

Returns Date

id

Returns string

needToAcknowledge

Returns boolean

public

Returns PronoteApiNewsPublicSelf

question

Returns StudentNewsItemQuestion

Remark

read

Returns boolean

`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` #public

`Private` `Readonly` #question

`Private` #read

`Private` `Readonly` #startDate

`Private` `Optional` `Readonly` #title

`Private` #stateInformation

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