Class CollectionMessage

Represents a CollectionMessage.

Hierarchy

CollectionMessage

Implements

ICollectionMessage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CollectionMessage(properties?: ICollectionMessage): CollectionMessage

- Defined in WAProto/index.d.ts:15485
Constructs a new CollectionMessage.

Parameters
- Optional properties: ICollectionMessage
Returns CollectionMessage

Properties

bizJid

bizJid: string

CollectionMessage bizJid.

id

id: string

CollectionMessage id.

messageVersion

messageVersion: number

CollectionMessage messageVersion.

Methods

toJSON

toJSON(): {}

- Defined in WAProto/index.d.ts:15570
Converts this CollectionMessage to JSON.

Returns {}

JSON object
- [k: string]: any

Static create

create(properties?: ICollectionMessage): CollectionMessage

- Defined in WAProto/index.d.ts:15507
Creates a new CollectionMessage instance using the specified properties.

Parameters
- Optional properties: ICollectionMessage
Returns CollectionMessage

CollectionMessage instance

Static decode

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

- Defined in WAProto/index.d.ts:15533
Decodes a CollectionMessage 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 CollectionMessage

CollectionMessage

Static decodeDelimited

decodeDelimited(reader: Uint8Array | Reader): CollectionMessage

- Defined in WAProto/index.d.ts:15542
Decodes a CollectionMessage 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 CollectionMessage

CollectionMessage

Static encode

encode(message: ICollectionMessage, writer?: Writer): Writer

- Defined in WAProto/index.d.ts:15515
Encodes the specified CollectionMessage message. Does not implicitly verify messages.

Parameters
- message: ICollectionMessage
  
  CollectionMessage message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static encodeDelimited

encodeDelimited(message: ICollectionMessage, writer?: Writer): Writer

- Defined in WAProto/index.d.ts:15523
Encodes the specified CollectionMessage message, length delimited. Does not implicitly verify messages.

Parameters
- message: ICollectionMessage
  
  CollectionMessage message or plain object to encode
- Optional writer: Writer
Returns Writer

Writer

Static fromObject

fromObject(object: {}): CollectionMessage

- Defined in WAProto/index.d.ts:15556
Creates a CollectionMessage message from a plain object. Also converts values to their respective internal types.

Parameters
- object: {}
  
  Plain object
  - [k: string]: any
Returns CollectionMessage

CollectionMessage

Static toObject

toObject(message: CollectionMessage, options?: IConversionOptions): {}

- Defined in WAProto/index.d.ts:15564
Creates a plain object from a CollectionMessage message. Also converts values to other types if specified.

Parameters
- message: CollectionMessage
  
  CollectionMessage
- Optional options: IConversionOptions
Returns {}

Plain object
- [k: string]: any

Static verify

verify(message: {}): string

- Defined in WAProto/index.d.ts:15549
Verifies a CollectionMessage 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