Class MessagesOverview

Constructors

constructor

Properties

#client #clientQueue #clientSession #defaultReplyMessageID #discussion #fetchLimit #messages #savedDrafts #sendButtonGenre?

Accessors

canIncludeStudentsAndParents defaultReplyMessageID messages savedDrafts

Methods

#parseCurrentDraft #parseMessages #readSendButton deleteDraft draftMessage patchDraft refetch sendDraft sendMessage

Constructors

constructor

  • new MessagesOverview(client, clientQueue, clientSession, discussion, data, fetchLimit?): MessagesOverview

  • Parameters

    • client: Pronote
    • clientQueue: default
    • clientSession: Session
    • discussion: StudentDiscussion
    • data: {
          donnees: {
              brouillon?: PronoteValue<24, {
                  N: string;
                  contenu: PronoteValue<21, string>;
                  estHTML: boolean;
              }>;
              listeBoutons: PronoteValue<24, {
                  G: PronoteApiMessagesButtonType;
                  L: string;
              }[]>;
              listeMessages: PronoteValue<24, (PronoteApiMessage | PronoteApiSentMessage)[]>;
              messagePourReponse: PronoteValue<24, {
                  G: number;
                  N: string;
                  nbDestinataires: number;
              }>;
              nbMarquerLu?: number;
              nbPossessionsMessage: number;
          };
          nom: Messages;
      }
      • donnees: {
            brouillon?: PronoteValue<24, {
                N: string;
                contenu: PronoteValue<21, string>;
                estHTML: boolean;
            }>;
            listeBoutons: PronoteValue<24, {
                G: PronoteApiMessagesButtonType;
                L: string;
            }[]>;
            listeMessages: PronoteValue<24, (PronoteApiMessage | PronoteApiSentMessage)[]>;
            messagePourReponse: PronoteValue<24, {
                G: number;
                N: string;
                nbDestinataires: number;
            }>;
            nbMarquerLu?: number;
            nbPossessionsMessage: number;
        }
        • Optional brouillon?: PronoteValue<24, {
              N: string;
              contenu: PronoteValue<21, string>;
              estHTML: boolean;
          }>
        • listeBoutons: PronoteValue<24, {
              G: PronoteApiMessagesButtonType;
              L: string;
          }[]>
        • listeMessages: PronoteValue<24, (PronoteApiMessage | PronoteApiSentMessage)[]>
        • messagePourReponse: PronoteValue<24, {
              G: number;
              N: string;
              nbDestinataires: number;
          }>
        • Optional nbMarquerLu?: number

          Is defined only when marquerCommeLu is set to true in the payload.

        • nbPossessionsMessage: number
      • nom: Messages
    • fetchLimit: number = 0

    Returns MessagesOverview

Properties

Private Readonly #client

#client: Pronote

Private Readonly #clientQueue

#clientQueue: default

Private Readonly #clientSession

#clientSession: Session

Private #defaultReplyMessageID

#defaultReplyMessageID: string

Private Readonly #discussion

#discussion: StudentDiscussion

Private #fetchLimit

#fetchLimit: number

Private #messages

#messages: SentMessage[] = []

Private #savedDrafts

#savedDrafts: DraftMessage[] = []

Private Optional #sendButtonGenre

#sendButtonGenre?: PronoteApiMessagesButtonType

Accessors

canIncludeStudentsAndParents

  • get canIncludeStudentsAndParents(): boolean

  • Whether the button "include students and parents" appears on the UI or not.

    Returns boolean

defaultReplyMessageID

messages

savedDrafts

Methods

Private #parseCurrentDraft

  • #parseCurrentDraft(draft): void

  • Parameters

    • draft: undefined | PronoteValue<24, {
          N: string;
          contenu: PronoteValue<21, string>;
          estHTML: boolean;
      }>

    Returns void

Private #parseMessages

  • #parseMessages(listeMessages): void

  • Parameters

    • listeMessages: (PronoteApiMessage | PronoteApiSentMessage)[]

    Returns void

Private #readSendButton

  • #readSendButton(listeBoutons): undefined | PronoteApiMessagesButtonType

  • Parameters

    • listeBoutons: {
          G: PronoteApiMessagesButtonType;
          L: string;
      }[]

    Returns undefined | PronoteApiMessagesButtonType

deleteDraft

draftMessage

  • draftMessage(content, replyTo?): Promise<void>

  • Parameters

    • content: string
    • replyTo: string = ...

    Returns Promise<void>

patchDraft

refetch

  • refetch(limit?): Promise<void>

  • Parameters

    • limit: number = ...

    Returns Promise<void>

sendDraft

  • sendDraft(draft, includeParentsAndStudents?): Promise<void>

  • Parameters

    • draft: DraftMessage
    • includeParentsAndStudents: boolean = false

    Returns Promise<void>

sendMessage

  • sendMessage(content, includeParentsAndStudents?, replyTo?): Promise<void>

  • Will send a message to the discussion and refetch the messages internally so properties are automatically updated.

    Parameters

    • content: string
    • includeParentsAndStudents: boolean = false
    • replyTo: string = ...

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructor#client#clientQueue#clientSession#defaultReplyMessageID#discussion#fetchLimit#messages#savedDrafts#sendButtonGenrecanIncludeStudentsAndParentsdefaultReplyMessageIDmessagessavedDrafts#parseCurrentDraft#parseMessages#readSendButtondeleteDraftdraftMessagepatchDraftrefetchsendDraftsendMessage