Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InteractiveMessage

Represents an InteractiveMessage.

Hierarchy

  • InteractiveMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional body

body: IBody

InteractiveMessage body.

Optional collectionMessage

collectionMessage: ICollectionMessage

InteractiveMessage collectionMessage.

Optional contextInfo

contextInfo: IContextInfo

InteractiveMessage contextInfo.

Optional footer

footer: IFooter

InteractiveMessage footer.

Optional header

header: IHeader

InteractiveMessage header.

Optional interactiveMessage

interactiveMessage: "shopStorefrontMessage" | "collectionMessage" | "nativeFlowMessage"

InteractiveMessage interactiveMessage.

Optional nativeFlowMessage

nativeFlowMessage: INativeFlowMessage

InteractiveMessage nativeFlowMessage.

Optional shopStorefrontMessage

shopStorefrontMessage: IShopMessage

InteractiveMessage shopStorefrontMessage.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

  • Decodes an InteractiveMessage 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 InteractiveMessage

    InteractiveMessage

Static decodeDelimited

  • Decodes an InteractiveMessage 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 InteractiveMessage

    InteractiveMessage

Static encode

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

    Parameters

    • message: IInteractiveMessage

      InteractiveMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: IInteractiveMessage

      InteractiveMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns InteractiveMessage

    InteractiveMessage

Static toObject

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

    Parameters

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

  • Verifies an InteractiveMessage 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