Class ClientPayload

Represents a ClientPayload.

Hierarchy

  • ClientPayload

Implements

Constructors

Properties

connectAttemptCount: number

ClientPayload connectAttemptCount.

connectReason: ConnectReason

ClientPayload connectReason.

connectType: ConnectType

ClientPayload connectType.

device: number

ClientPayload device.

devicePairingData?: null | IDevicePairingRegistrationData

ClientPayload devicePairingData.

dnsSource?: null | IDNSSource

ClientPayload dnsSource.

fbAppId: number | Long

ClientPayload fbAppId.

fbCat: Uint8Array

ClientPayload fbCat.

fbDeviceId: Uint8Array

ClientPayload fbDeviceId.

fbUserAgent: Uint8Array

ClientPayload fbUserAgent.

interopData?: null | IInteropData

ClientPayload interopData.

iosAppExtension: IOSAppExtension

ClientPayload iosAppExtension.

lc: number

ClientPayload lc.

memClass: number

ClientPayload memClass.

oc: boolean

ClientPayload oc.

paddingBytes: Uint8Array

ClientPayload paddingBytes.

passive: boolean

ClientPayload passive.

ClientPayload product.

pull: boolean

ClientPayload pull.

pushName: string

ClientPayload pushName.

sessionId: number

ClientPayload sessionId.

shards: number[]

ClientPayload shards.

shortConnect: boolean

ClientPayload shortConnect.

userAgent?: null | IUserAgent

ClientPayload userAgent.

username: number | Long

ClientPayload username.

webInfo?: null | IWebInfo

ClientPayload webInfo.

yearClass: number

ClientPayload yearClass.

Methods

  • Converts this ClientPayload to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

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

  • 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

  • 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

  • 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

  • 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

  • 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
  • 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

Generated using TypeDoc