Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Message

Represents a Message.

Hierarchy

  • Message

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional audioMessage

audioMessage: IAudioMessage

Message audioMessage.

Optional buttonsMessage

buttonsMessage: IButtonsMessage

Message buttonsMessage.

Optional buttonsResponseMessage

buttonsResponseMessage: IButtonsResponseMessage

Message buttonsResponseMessage.

Optional call

call: ICall

Message call.

Optional cancelPaymentRequestMessage

cancelPaymentRequestMessage: ICancelPaymentRequestMessage

Message cancelPaymentRequestMessage.

Optional chat

chat: IChat

Message chat.

Optional contactMessage

contactMessage: IContactMessage

Message contactMessage.

Optional contactsArrayMessage

contactsArrayMessage: IContactsArrayMessage

Message contactsArrayMessage.

conversation

conversation: string

Message conversation.

Optional declinePaymentRequestMessage

declinePaymentRequestMessage: IDeclinePaymentRequestMessage

Message declinePaymentRequestMessage.

Optional deviceSentMessage

deviceSentMessage: IDeviceSentMessage

Message deviceSentMessage.

Optional documentMessage

documentMessage: IDocumentMessage

Message documentMessage.

Optional ephemeralMessage

ephemeralMessage: IFutureProofMessage

Message ephemeralMessage.

Optional extendedTextMessage

extendedTextMessage: IExtendedTextMessage

Message extendedTextMessage.

Optional fastRatchetKeySenderKeyDistributionMessage

fastRatchetKeySenderKeyDistributionMessage: ISenderKeyDistributionMessage

Message fastRatchetKeySenderKeyDistributionMessage.

Optional groupInviteMessage

groupInviteMessage: IGroupInviteMessage

Message groupInviteMessage.

Optional highlyStructuredMessage

highlyStructuredMessage: IHighlyStructuredMessage

Message highlyStructuredMessage.

Optional imageMessage

imageMessage: IImageMessage

Message imageMessage.

Optional interactiveMessage

interactiveMessage: IInteractiveMessage

Message interactiveMessage.

Optional invoiceMessage

invoiceMessage: IInvoiceMessage

Message invoiceMessage.

Optional listMessage

listMessage: IListMessage

Message listMessage.

Optional listResponseMessage

listResponseMessage: IListResponseMessage

Message listResponseMessage.

Optional liveLocationMessage

liveLocationMessage: ILiveLocationMessage

Message liveLocationMessage.

Optional locationMessage

locationMessage: ILocationMessage

Message locationMessage.

Optional messageContextInfo

messageContextInfo: IMessageContextInfo

Message messageContextInfo.

Optional orderMessage

orderMessage: IOrderMessage

Message orderMessage.

Optional paymentInviteMessage

paymentInviteMessage: IPaymentInviteMessage

Message paymentInviteMessage.

Optional productMessage

productMessage: IProductMessage

Message productMessage.

Optional protocolMessage

protocolMessage: IProtocolMessage

Message protocolMessage.

Optional reactionMessage

reactionMessage: IReactionMessage

Message reactionMessage.

Optional requestPaymentMessage

requestPaymentMessage: IRequestPaymentMessage

Message requestPaymentMessage.

Optional sendPaymentMessage

sendPaymentMessage: ISendPaymentMessage

Message sendPaymentMessage.

Optional senderKeyDistributionMessage

senderKeyDistributionMessage: ISenderKeyDistributionMessage

Message senderKeyDistributionMessage.

Optional stickerMessage

stickerMessage: IStickerMessage

Message stickerMessage.

Optional stickerSyncRmrMessage

stickerSyncRmrMessage: IStickerSyncRMRMessage

Message stickerSyncRmrMessage.

Optional templateButtonReplyMessage

templateButtonReplyMessage: ITemplateButtonReplyMessage

Message templateButtonReplyMessage.

Optional templateMessage

templateMessage: ITemplateMessage

Message templateMessage.

Optional videoMessage

videoMessage: IVideoMessage

Message videoMessage.

Optional viewOnceMessage

viewOnceMessage: IFutureProofMessage

Message viewOnceMessage.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • decode(reader: Uint8Array | Reader, length?: number): Message

  • Decodes a Message message from the specified reader or buffer.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

    Returns Message

    Message

Static decodeDelimited

  • decodeDelimited(reader: Uint8Array | Reader): Message

  • Decodes a Message message from the specified reader or buffer, length delimited.

    throws

    {Error} If the payload is not a reader or valid buffer

    throws

    {$protobuf.util.ProtocolError} If required fields are missing

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns Message

    Message

Static encode

  • encode(message: IMessage, writer?: Writer): Writer

  • Encodes the specified Message message. Does not implicitly verify messages.

    Parameters

    • message: IMessage

      Message message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IMessage, writer?: Writer): Writer

  • Encodes the specified Message message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IMessage

      Message message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

  • Creates a Message message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns Message

    Message

Static toObject

  • toObject(message: Message, options?: IConversionOptions): {}

  • Creates a plain object from a Message message. Also converts values to other types if specified.

    Parameters

    • message: Message

      Message

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a Message message.

    Parameters

    • message: {}

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc