Class InteractiveMessage

Represents an InteractiveMessage.

Hierarchy

  • InteractiveMessage

Implements

Constructors

Properties

InteractiveMessage body.

carouselMessage?: null | ICarouselMessage

InteractiveMessage carouselMessage.

collectionMessage?: null | ICollectionMessage

InteractiveMessage collectionMessage.

contextInfo?: null | IContextInfo

InteractiveMessage contextInfo.

footer?: null | IFooter

InteractiveMessage footer.

header?: null | IHeader

InteractiveMessage header.

interactiveMessage?: "shopStorefrontMessage" | "collectionMessage" | "nativeFlowMessage" | "carouselMessage"

InteractiveMessage interactiveMessage.

nativeFlowMessage?: null | INativeFlowMessage

InteractiveMessage nativeFlowMessage.

shopStorefrontMessage?: null | IShopMessage

InteractiveMessage shopStorefrontMessage.

Methods

  • Converts this InteractiveMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    InteractiveMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes an InteractiveMessage message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns InteractiveMessage

    InteractiveMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IInteractiveMessage

      InteractiveMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • 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

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns InteractiveMessage

    InteractiveMessage

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

    Parameters

    • message: InteractiveMessage

      InteractiveMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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