Class Message

Represents a Message.

Hierarchy

  • Message

Implements

Constructors

constructor

Properties

audioMessage? botInvokeMessage? buttonsMessage? buttonsResponseMessage? call? cancelPaymentRequestMessage? chat? contactMessage? contactsArrayMessage? conversation declinePaymentRequestMessage? deviceSentMessage? documentMessage? documentWithCaptionMessage? editedMessage? encReactionMessage? ephemeralMessage? extendedTextMessage? fastRatchetKeySenderKeyDistributionMessage? groupInviteMessage? groupMentionedMessage? highlyStructuredMessage? imageMessage? interactiveMessage? interactiveResponseMessage? invoiceMessage? keepInChatMessage? listMessage? listResponseMessage? liveLocationMessage? locationMessage? messageContextInfo? orderMessage? paymentInviteMessage? pinInChatMessage? pollCreationMessage? pollCreationMessageV2? pollCreationMessageV3? pollUpdateMessage? productMessage? protocolMessage? ptvMessage? reactionMessage? requestPaymentMessage? requestPhoneNumberMessage? scheduledCallCreationMessage? scheduledCallEditMessage? sendPaymentMessage? senderKeyDistributionMessage? stickerMessage? stickerSyncRmrMessage? templateButtonReplyMessage? templateMessage? videoMessage? viewOnceMessage? viewOnceMessageV2? viewOnceMessageV2Extension?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject toObject verify

Constructors

constructor

Properties

Optional audioMessage

audioMessage?: null | IAudioMessage

Message audioMessage.

Optional botInvokeMessage

botInvokeMessage?: null | IFutureProofMessage

Message botInvokeMessage.

Optional buttonsMessage

buttonsMessage?: null | IButtonsMessage

Message buttonsMessage.

Optional buttonsResponseMessage

buttonsResponseMessage?: null | IButtonsResponseMessage

Message buttonsResponseMessage.

Optional call

call?: null | ICall

Message call.

Optional cancelPaymentRequestMessage

cancelPaymentRequestMessage?: null | ICancelPaymentRequestMessage

Message cancelPaymentRequestMessage.

Optional chat

chat?: null | IChat

Message chat.

Optional contactMessage

contactMessage?: null | IContactMessage

Message contactMessage.

Optional contactsArrayMessage

contactsArrayMessage?: null | IContactsArrayMessage

Message contactsArrayMessage.

conversation

conversation: string

Message conversation.

Optional declinePaymentRequestMessage

declinePaymentRequestMessage?: null | IDeclinePaymentRequestMessage

Message declinePaymentRequestMessage.

Optional deviceSentMessage

deviceSentMessage?: null | IDeviceSentMessage

Message deviceSentMessage.

Optional documentMessage

documentMessage?: null | IDocumentMessage

Message documentMessage.

Optional documentWithCaptionMessage

documentWithCaptionMessage?: null | IFutureProofMessage

Message documentWithCaptionMessage.

Optional editedMessage

editedMessage?: null | IFutureProofMessage

Message editedMessage.

Optional encReactionMessage

encReactionMessage?: null | IEncReactionMessage

Message encReactionMessage.

Optional ephemeralMessage

ephemeralMessage?: null | IFutureProofMessage

Message ephemeralMessage.

Optional extendedTextMessage

extendedTextMessage?: null | IExtendedTextMessage

Message extendedTextMessage.

Optional fastRatchetKeySenderKeyDistributionMessage

fastRatchetKeySenderKeyDistributionMessage?: null | proto.Message.ISenderKeyDistributionMessage

Message fastRatchetKeySenderKeyDistributionMessage.

Optional groupInviteMessage

groupInviteMessage?: null | IGroupInviteMessage

Message groupInviteMessage.

Optional groupMentionedMessage

groupMentionedMessage?: null | IFutureProofMessage

Message groupMentionedMessage.

Optional highlyStructuredMessage

highlyStructuredMessage?: null | IHighlyStructuredMessage

Message highlyStructuredMessage.

Optional imageMessage

imageMessage?: null | IImageMessage

Message imageMessage.

Optional interactiveMessage

interactiveMessage?: null | IInteractiveMessage

Message interactiveMessage.

Optional interactiveResponseMessage

interactiveResponseMessage?: null | IInteractiveResponseMessage

Message interactiveResponseMessage.

Optional invoiceMessage

invoiceMessage?: null | IInvoiceMessage

Message invoiceMessage.

Optional keepInChatMessage

keepInChatMessage?: null | IKeepInChatMessage

Message keepInChatMessage.

Optional listMessage

listMessage?: null | IListMessage

Message listMessage.

Optional listResponseMessage

listResponseMessage?: null | IListResponseMessage

Message listResponseMessage.

Optional liveLocationMessage

liveLocationMessage?: null | ILiveLocationMessage

Message liveLocationMessage.

Optional locationMessage

locationMessage?: null | ILocationMessage

Message locationMessage.

Optional messageContextInfo

messageContextInfo?: null | IMessageContextInfo

Message messageContextInfo.

Optional orderMessage

orderMessage?: null | IOrderMessage

Message orderMessage.

Optional paymentInviteMessage

paymentInviteMessage?: null | IPaymentInviteMessage

Message paymentInviteMessage.

Optional pinInChatMessage

pinInChatMessage?: null | IPinInChatMessage

Message pinInChatMessage.

Optional pollCreationMessage

pollCreationMessage?: null | IPollCreationMessage

Message pollCreationMessage.

Optional pollCreationMessageV2

pollCreationMessageV2?: null | IPollCreationMessage

Message pollCreationMessageV2.

Optional pollCreationMessageV3

pollCreationMessageV3?: null | IPollCreationMessage

Message pollCreationMessageV3.

Optional pollUpdateMessage

pollUpdateMessage?: null | IPollUpdateMessage

Message pollUpdateMessage.

Optional productMessage

productMessage?: null | IProductMessage

Message productMessage.

Optional protocolMessage

protocolMessage?: null | IProtocolMessage

Message protocolMessage.

Optional ptvMessage

ptvMessage?: null | IVideoMessage

Message ptvMessage.

Optional reactionMessage

reactionMessage?: null | IReactionMessage

Message reactionMessage.

Optional requestPaymentMessage

requestPaymentMessage?: null | IRequestPaymentMessage

Message requestPaymentMessage.

Optional requestPhoneNumberMessage

requestPhoneNumberMessage?: null | IRequestPhoneNumberMessage

Message requestPhoneNumberMessage.

Optional scheduledCallCreationMessage

scheduledCallCreationMessage?: null | IScheduledCallCreationMessage

Message scheduledCallCreationMessage.

Optional scheduledCallEditMessage

scheduledCallEditMessage?: null | IScheduledCallEditMessage

Message scheduledCallEditMessage.

Optional sendPaymentMessage

sendPaymentMessage?: null | ISendPaymentMessage

Message sendPaymentMessage.

Optional senderKeyDistributionMessage

senderKeyDistributionMessage?: null | proto.Message.ISenderKeyDistributionMessage

Message senderKeyDistributionMessage.

Optional stickerMessage

stickerMessage?: null | IStickerMessage

Message stickerMessage.

Optional stickerSyncRmrMessage

stickerSyncRmrMessage?: null | IStickerSyncRMRMessage

Message stickerSyncRmrMessage.

Optional templateButtonReplyMessage

templateButtonReplyMessage?: null | ITemplateButtonReplyMessage

Message templateButtonReplyMessage.

Optional templateMessage

templateMessage?: null | ITemplateMessage

Message templateMessage.

Optional videoMessage

videoMessage?: null | IVideoMessage

Message videoMessage.

Optional viewOnceMessage

viewOnceMessage?: null | IFutureProofMessage

Message viewOnceMessage.

Optional viewOnceMessageV2

viewOnceMessageV2?: null | IFutureProofMessage

Message viewOnceMessageV2.

Optional viewOnceMessageV2Extension

viewOnceMessageV2Extension?: null | IFutureProofMessage

Message viewOnceMessageV2Extension.

Methods

toJSON

  • Converts this Message to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

  • Creates a new Message instance using the specified properties.

    Parameters

    • Optional properties: IMessage

      Properties to set

    Returns Message

    Message instance

Static decode

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns Message

    Message

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns Message

    Message

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static encode

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

    Parameters

    • message: IMessage

      Message message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static encodeDelimited

  • 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

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns Message

    Message

Static toObject

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

    Parameters

    • message: Message

      Message

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • Verifies a Message message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc