Class MessageModule

constructor

• new MessageModule(): MessageModule

• Returns MessageModule

name

buildMessageFromSerializedData

• buildMessageFromSerializedData(serialized):
      | UserMessage
      | FileMessage
      | MultipleFilesMessage
      | AdminMessage
      | NotificationMessage

• Parameters

  • serialized: object

  Returns
      | UserMessage
      | FileMessage
      | MultipleFilesMessage
      | AdminMessage
      | NotificationMessage

  Description

  Creates a BaseMessage instance from serialized object. message.serialize() returns the serialized object.

buildSenderFromSerializedData

• buildSenderFromSerializedData(serialized): Sender

• Parameters

  • serialized: object

  Returns Sender

  Description

  Creates a Sender instance from serialized object.

getMessage

• getMessage(params): Promise<null | BaseMessage | NotificationMessage>

• Parameters

  • params: MessageRetrievalParams

  Returns Promise<null | BaseMessage | NotificationMessage>

  Description

  Gets a message with a given params.

getMessageTemplate

• getMessageTemplate(key): Promise<MessageTemplate>

• Parameters

  • key: string

  Returns Promise<MessageTemplate>

getMessageTemplatesByToken

• getMessageTemplatesByToken(token, params?): Promise<MessageTemplateListResult>

• Parameters

  • token: null | string
  • params: MessageTemplateListParams = {}

  Returns Promise<MessageTemplateListResult>

getScheduledMessage

• getScheduledMessage(params): Promise<null | BaseMessage>

• Parameters

  • params: ScheduledMessageRetrievalParams

  Returns Promise<null | BaseMessage>

  Description

  Gets a schedules message with a given params.