Class ButtonsMessage

Represents a ButtonsMessage.

Hierarchy

  • ButtonsMessage

Implements

Constructors

Properties

buttons: IButton[]

ButtonsMessage buttons.

contentText: string

ButtonsMessage contentText.

contextInfo?: null | IContextInfo

ButtonsMessage contextInfo.

documentMessage?: null | IDocumentMessage

ButtonsMessage documentMessage.

footerText: string

ButtonsMessage footerText.

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

ButtonsMessage header.

headerType: HeaderType

ButtonsMessage headerType.

imageMessage?: null | IImageMessage

ButtonsMessage imageMessage.

locationMessage?: null | ILocationMessage

ButtonsMessage locationMessage.

text?: null | string

ButtonsMessage text.

videoMessage?: null | IVideoMessage

ButtonsMessage videoMessage.

Methods

  • Converts this ButtonsMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Decodes a ButtonsMessage 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 ButtonsMessage

    ButtonsMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns ButtonsMessage

    ButtonsMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IButtonsMessage

      ButtonsMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • 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

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns ButtonsMessage

    ButtonsMessage

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

    Parameters

    • message: ButtonsMessage

      ButtonsMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a ButtonsMessage 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

Generated using TypeDoc