Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientPayload

Represents a ClientPayload.

Hierarchy

  • ClientPayload

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

connectAttemptCount

connectAttemptCount: number

ClientPayload connectAttemptCount.

connectReason

connectReason: ClientPayloadConnectReason

ClientPayload connectReason.

connectType

connectType: ClientPayloadConnectType

ClientPayload connectType.

device

device: number

ClientPayload device.

Optional dnsSource

dnsSource?: IDNSSource

ClientPayload dnsSource.

fbAppId

fbAppId: number | Long

ClientPayload fbAppId.

fbCat

fbCat: Uint8Array

ClientPayload fbCat.

fbDeviceId

fbDeviceId: Uint8Array

ClientPayload fbDeviceId.

fbUserAgent

fbUserAgent: Uint8Array

ClientPayload fbUserAgent.

iosAppExtension

iosAppExtension: ClientPayloadIOSAppExtension

ClientPayload iosAppExtension.

lc

lc: number

ClientPayload lc.

oc

oc: boolean

ClientPayload oc.

passive

passive: boolean

ClientPayload passive.

product

product: ClientPayloadProduct

ClientPayload product.

pushName

pushName: string

ClientPayload pushName.

Optional regData

regData?: ICompanionRegData

ClientPayload regData.

sessionId

sessionId: number

ClientPayload sessionId.

shards

shards: number[]

ClientPayload shards.

shortConnect

shortConnect: boolean

ClientPayload shortConnect.

Optional userAgent

userAgent?: IUserAgent

ClientPayload userAgent.

username

username: number | Long

ClientPayload username.

Optional webInfo

webInfo?: IWebInfo

ClientPayload webInfo.

Methods

toJSON

  • toJSON(): {}

Static create

Static decode

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

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

    ClientPayload

Static decodeDelimited

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

    ClientPayload

Static encode

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

    Parameters

    • message: IClientPayload

      ClientPayload message or plain object to encode

    • Optional writer: Writer

    Returns Writer

    Writer

Static encodeDelimited

  • 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

    Returns Writer

    Writer

Static fromObject

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

    Parameters

    • object: {}

      Plain object

      • [k: string]: any

    Returns ClientPayload

    ClientPayload

Static toObject

  • toObject(message: ClientPayload, options?: IConversionOptions): {}

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

    Parameters

    • message: ClientPayload

      ClientPayload

    • Optional options: IConversionOptions

    Returns {}

    Plain object

    • [k: string]: any

Static verify

  • verify(message: {}): string

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