Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ProductMessage

Represents a ProductMessage.

Hierarchy

  • ProductMessage

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

body

body: string

ProductMessage body.

businessOwnerJid

businessOwnerJid: string

ProductMessage businessOwnerJid.

Optional catalog

catalog: ICatalogSnapshot

ProductMessage catalog.

Optional contextInfo

contextInfo: IContextInfo

ProductMessage contextInfo.

footer

footer: string

ProductMessage footer.

Optional product

product: IProductSnapshot

ProductMessage product.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

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

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

    ProductMessage

Static decodeDelimited

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

    ProductMessage

Static encode

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

    Parameters

    • message: IProductMessage

      ProductMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: IProductMessage

      ProductMessage message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns ProductMessage

    ProductMessage

Static toObject

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

    Parameters

    • message: ProductMessage

      ProductMessage

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

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