Class: ClientPayload

Defined in: WAProto/index.d.ts:7733

Represents a ClientPayload.

Implements

• IClientPayload

Constructors

new ClientPayload()

new ClientPayload(properties?): ClientPayload

Defined in: WAProto/index.d.ts:7739

Constructs a new ClientPayload.

Parameters

properties?

IClientPayload

Properties to set

Returns

ClientPayload

Properties

connectAttemptCount?

optional connectAttemptCount: null | number

Defined in: WAProto/index.d.ts:7775

ClientPayload connectAttemptCount.

Implementation of

IClientPayload.connectAttemptCount

---

connectReason?

optional connectReason: null | ConnectReason

Defined in: WAProto/index.d.ts:7766

ClientPayload connectReason.

Implementation of

IClientPayload.connectReason

---

connectType?

optional connectType: null | ConnectType

Defined in: WAProto/index.d.ts:7763

ClientPayload connectType.

Implementation of

IClientPayload.connectType

---

device?

optional device: null | number

Defined in: WAProto/index.d.ts:7778

ClientPayload device.

Implementation of

IClientPayload.device

---

devicePairingData?

optional devicePairingData: null | IDevicePairingRegistrationData

Defined in: WAProto/index.d.ts:7781

ClientPayload devicePairingData.

Implementation of

IClientPayload.devicePairingData

---

dnsSource?

optional dnsSource: null | IDNSSource

Defined in: WAProto/index.d.ts:7772

ClientPayload dnsSource.

Implementation of

IClientPayload.dnsSource

---

fbAppId?

optional fbAppId: null | number | Long

Defined in: WAProto/index.d.ts:7802

ClientPayload fbAppId.

Implementation of

IClientPayload.fbAppId

---

fbCat?

optional fbCat: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:7787

ClientPayload fbCat.

Implementation of

IClientPayload.fbCat

---

fbDeviceId?

optional fbDeviceId: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:7805

ClientPayload fbDeviceId.

Implementation of

IClientPayload.fbDeviceId

---

fbUserAgent?

optional fbUserAgent: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:7790

ClientPayload fbUserAgent.

Implementation of

IClientPayload.fbUserAgent

---

interopData?

optional interopData: null | IInteropData

Defined in: WAProto/index.d.ts:7820

ClientPayload interopData.

Implementation of

IClientPayload.interopData

---

iosAppExtension?

optional iosAppExtension: null | IOSAppExtension

Defined in: WAProto/index.d.ts:7799

ClientPayload iosAppExtension.

Implementation of

IClientPayload.iosAppExtension

---

lc?

optional lc: null | number

Defined in: WAProto/index.d.ts:7796

ClientPayload lc.

Implementation of

IClientPayload.lc

---

memClass?

optional memClass: null | number

Defined in: WAProto/index.d.ts:7817

ClientPayload memClass.

Implementation of

IClientPayload.memClass

---

oc?

optional oc: null | boolean

Defined in: WAProto/index.d.ts:7793

ClientPayload oc.

Implementation of

IClientPayload.oc

---

paddingBytes?

optional paddingBytes: null | Uint8Array<ArrayBufferLike>

Defined in: WAProto/index.d.ts:7811

ClientPayload paddingBytes.

Implementation of

IClientPayload.paddingBytes

---

passive?

optional passive: null | boolean

Defined in: WAProto/index.d.ts:7745

ClientPayload passive.

Implementation of

IClientPayload.passive

---

product?

optional product: null | Product

Defined in: WAProto/index.d.ts:7784

ClientPayload product.

Implementation of

IClientPayload.product

---

pull?

optional pull: null | boolean

Defined in: WAProto/index.d.ts:7808

ClientPayload pull.

Implementation of

IClientPayload.pull

---

pushName?

optional pushName: null | string

Defined in: WAProto/index.d.ts:7754

ClientPayload pushName.

Implementation of

IClientPayload.pushName

---

sessionId?

optional sessionId: null | number

Defined in: WAProto/index.d.ts:7757

ClientPayload sessionId.

Implementation of

IClientPayload.sessionId

---

shards

shards: number[]

Defined in: WAProto/index.d.ts:7769

ClientPayload shards.

Implementation of

IClientPayload.shards

---

shortConnect?

optional shortConnect: null | boolean

Defined in: WAProto/index.d.ts:7760

ClientPayload shortConnect.

Implementation of

IClientPayload.shortConnect

---

trafficAnonymization?

optional trafficAnonymization: null | TrafficAnonymization

Defined in: WAProto/index.d.ts:7823

ClientPayload trafficAnonymization.

Implementation of

IClientPayload.trafficAnonymization

---

userAgent?

optional userAgent: null | IUserAgent

Defined in: WAProto/index.d.ts:7748

ClientPayload userAgent.

Implementation of

IClientPayload.userAgent

---

username?

optional username: null | number | Long

Defined in: WAProto/index.d.ts:7742

ClientPayload username.

Implementation of

IClientPayload.username

---

webInfo?

optional webInfo: null | IWebInfo

Defined in: WAProto/index.d.ts:7751

ClientPayload webInfo.

Implementation of

IClientPayload.webInfo

---

yearClass?

optional yearClass: null | number

Defined in: WAProto/index.d.ts:7814

ClientPayload yearClass.

Implementation of

IClientPayload.yearClass

Methods

toJSON()

toJSON(): object

Defined in: WAProto/index.d.ts:7893

Converts this ClientPayload to JSON.

Returns

object

JSON object

---

create()

static create(properties?): ClientPayload

Defined in: WAProto/index.d.ts:7830

Creates a new ClientPayload instance using the specified properties.

Parameters

properties?

IClientPayload

Properties to set

Returns

ClientPayload

ClientPayload instance

---

decode()

static decode(reader, length?): ClientPayload

Defined in: WAProto/index.d.ts:7856

Decodes a ClientPayload message from the specified reader or buffer.

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

length?

number

Message length if known beforehand

Returns

ClientPayload

ClientPayload

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): ClientPayload

Defined in: WAProto/index.d.ts:7865

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

Parameters

reader

Reader or buffer to decode from

Uint8Array<ArrayBufferLike> | Reader

Returns

ClientPayload

ClientPayload

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Defined in: WAProto/index.d.ts:7838

Encodes the specified ClientPayload message. Does not implicitly verify messages.

Parameters

message

IClientPayload

ClientPayload message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Defined in: WAProto/index.d.ts:7846

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

Parameters

message

IClientPayload

ClientPayload message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): ClientPayload

Defined in: WAProto/index.d.ts:7879

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

Parameters

object

Plain object

Returns

ClientPayload

ClientPayload

---

getTypeUrl()

static getTypeUrl(typeUrlPrefix?): string

Defined in: WAProto/index.d.ts:7900

Gets the default type url for ClientPayload

Parameters

typeUrlPrefix?

string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject()

static toObject(message, options?): object

Defined in: WAProto/index.d.ts:7887

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

Parameters

message

ClientPayload

ClientPayload

options?

IConversionOptions

Conversion options

Returns

object

Plain object

---

verify()

static verify(message): null | string

Defined in: WAProto/index.d.ts:7872

Verifies a ClientPayload message.

Parameters

message

Plain object to verify

Returns

null | string

null if valid, otherwise the reason why it is not