Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ButtonsMessage

Represents a ButtonsMessage.

Hierarchy

  • ButtonsMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

buttons

buttons: IButton[]

ButtonsMessage buttons.

contentText

contentText: string

ButtonsMessage contentText.

Optional contextInfo

contextInfo: IContextInfo

ButtonsMessage contextInfo.

Optional documentMessage

documentMessage: IDocumentMessage

ButtonsMessage documentMessage.

footerText

footerText: string

ButtonsMessage footerText.

Optional header

header: "documentMessage" | "imageMessage" | "videoMessage" | "locationMessage" | "text"

ButtonsMessage header.

headerType

headerType: ButtonsMessageHeaderType

ButtonsMessage headerType.

Optional imageMessage

imageMessage: IImageMessage

ButtonsMessage imageMessage.

Optional locationMessage

locationMessage: ILocationMessage

ButtonsMessage locationMessage.

Optional text

text: string

ButtonsMessage text.

Optional videoMessage

videoMessage: IVideoMessage

ButtonsMessage videoMessage.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

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

  • Decodes a ButtonsMessage 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 ButtonsMessage

    ButtonsMessage

Static decodeDelimited

  • Decodes a ButtonsMessage 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 ButtonsMessage

    ButtonsMessage

Static encode

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

    Parameters

    • message: IButtonsMessage

      ButtonsMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: IButtonsMessage

      ButtonsMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns ButtonsMessage

    ButtonsMessage

Static toObject

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

    Parameters

    • message: ButtonsMessage

      ButtonsMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies a ButtonsMessage 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