Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListMessage

Represents a ListMessage.

Hierarchy

  • ListMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

buttonText

buttonText: string

ListMessage buttonText.

Optional contextInfo

contextInfo: IContextInfo

ListMessage contextInfo.

description

description: string

ListMessage description.

footerText

footerText: string

ListMessage footerText.

listType

listType: ListMessageListType

ListMessage listType.

Optional productListInfo

productListInfo: IProductListInfo

ListMessage productListInfo.

sections

sections: ISection[]

ListMessage sections.

title

title: string

ListMessage title.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

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

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

    ListMessage

Static decodeDelimited

  • decodeDelimited(reader: Uint8Array | Reader): ListMessage

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

    ListMessage

Static encode

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

    Parameters

    • message: IListMessage

      ListMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • encodeDelimited(message: IListMessage, writer?: 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

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns ListMessage

    ListMessage

Static toObject

  • toObject(message: ListMessage, options?: IConversionOptions): {}

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

    Parameters

    • message: ListMessage

      ListMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

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