Class OrderMessage

Represents an OrderMessage.

Hierarchy

  • OrderMessage

Implements

Constructors

Properties

contextInfo?: null | IContextInfo

OrderMessage contextInfo.

itemCount: number

OrderMessage itemCount.

message: string

OrderMessage message.

messageVersion: number

OrderMessage messageVersion.

orderId: string

OrderMessage orderId.

orderRequestMessageId?: null | proto.IMessageKey

OrderMessage orderRequestMessageId.

orderTitle: string

OrderMessage orderTitle.

sellerJid: string

OrderMessage sellerJid.

status: OrderStatus

OrderMessage status.

surface: CATALOG

OrderMessage surface.

thumbnail: Uint8Array

OrderMessage thumbnail.

token: string

OrderMessage token.

totalAmount1000: number | Long

OrderMessage totalAmount1000.

totalCurrencyCode: string

OrderMessage totalCurrencyCode.

Methods

  • Converts this OrderMessage to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

    OrderMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns OrderMessage

    OrderMessage

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

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

    Parameters

    • message: IOrderMessage

      OrderMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

    • message: IOrderMessage

      OrderMessage message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns OrderMessage

    OrderMessage

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

    Parameters

    • message: OrderMessage

      OrderMessage

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

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