Class ClientPayload

constructor

• new ClientPayload(properties?): ClientPayload

• Constructs a new ClientPayload.

  Parameters

  • Optional properties: IClientPayload

    Properties to set

  Returns ClientPayload

connectAttemptCount

connectReason

connectType

device

Optional devicePairingData

Optional dnsSource

fbAppId

fbCat

fbDeviceId

fbUserAgent

Optional interopData

iosAppExtension

lc

memClass

oc

paddingBytes

passive

product

pull

pushName

sessionId

shards

shortConnect

Optional userAgent

username

Optional webInfo

yearClass

toJSON

• toJSON(): {
      [k: string]: any;
  }

• Converts this ClientPayload to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): ClientPayload

• Creates a new ClientPayload instance using the specified properties.

  Parameters

  • Optional properties: IClientPayload

    Properties to set

  Returns ClientPayload

  ClientPayload instance

Static decode

• decode(reader, length?): ClientPayload

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

  ClientPayload

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static decodeDelimited

• decodeDelimited(reader): ClientPayload

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

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  Returns ClientPayload

  ClientPayload

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static encode

• encode(message, writer?): Writer

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

  Parameters

  • message: IClientPayload

    ClientPayload message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static encodeDelimited

• encodeDelimited(message, writer?): Writer

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

  Parameters

  • message: IClientPayload

    ClientPayload message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static fromObject

• fromObject(object): ClientPayload

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

  Parameters

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

    Plain object

    • [k: string]: any

  Returns ClientPayload

  ClientPayload

Static toObject

• toObject(message, options?): {
      [k: string]: any;
  }

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

  Parameters

  • message: ClientPayload

    ClientPayload

  • Optional options: IConversionOptions

    Conversion options

  Returns {
      [k: string]: any;
  }

  Plain object

  • [k: string]: any

Static verify

• verify(message): null | string

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