Represents a ListMessage.

Hierarchy

  • ListMessage

Implements

Constructors

Properties

buttonText: string

ListMessage buttonText.

contextInfo?: null | IContextInfo

ListMessage contextInfo.

description: string

ListMessage description.

footerText: string

ListMessage footerText.

ListMessage listType.

productListInfo?: null | IProductListInfo

ListMessage productListInfo.

sections: ISection[]

ListMessage sections.

title: string

ListMessage title.

Methods

  • Converts this ListMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    ListMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns ListMessage

    ListMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IListMessage

      ListMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: IListMessage

      ListMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns ListMessage

    ListMessage

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

    Parameters

    • message: ListMessage

      ListMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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