Class ClientPayload

Represents a ClientPayload.

Hierarchy

  • ClientPayload

Implements

Constructors

constructor

Properties

connectAttemptCount? connectReason? connectType? device? devicePairingData? dnsSource? fbAppId? fbCat? fbDeviceId? fbUserAgent? interopData? iosAppExtension? lc? memClass? oc? paddingBytes? passive? product? pull? pushName? sessionId? shards shortConnect? trafficAnonymization? userAgent? username? webInfo? yearClass?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

Optional connectAttemptCount

connectAttemptCount?: null | number

ClientPayload connectAttemptCount.

Optional connectReason

connectReason?: null | ConnectReason

ClientPayload connectReason.

Optional connectType

connectType?: null | ConnectType

ClientPayload connectType.

Optional device

device?: null | number

ClientPayload device.

Optional devicePairingData

devicePairingData?: null | IDevicePairingRegistrationData

ClientPayload devicePairingData.

Optional dnsSource

dnsSource?: null | IDNSSource

ClientPayload dnsSource.

Optional fbAppId

fbAppId?: null | number | Long

ClientPayload fbAppId.

Optional fbCat

fbCat?: null | Uint8Array

ClientPayload fbCat.

Optional fbDeviceId

fbDeviceId?: null | Uint8Array

ClientPayload fbDeviceId.

Optional fbUserAgent

fbUserAgent?: null | Uint8Array

ClientPayload fbUserAgent.

Optional interopData

interopData?: null | IInteropData

ClientPayload interopData.

Optional iosAppExtension

iosAppExtension?: null | IOSAppExtension

ClientPayload iosAppExtension.

Optional lc

lc?: null | number

ClientPayload lc.

Optional memClass

memClass?: null | number

ClientPayload memClass.

Optional oc

oc?: null | boolean

ClientPayload oc.

Optional paddingBytes

paddingBytes?: null | Uint8Array

ClientPayload paddingBytes.

Optional passive

passive?: null | boolean

ClientPayload passive.

Optional product

product?: null | proto.ClientPayload.Product

ClientPayload product.

Optional pull

pull?: null | boolean

ClientPayload pull.

Optional pushName

pushName?: null | string

ClientPayload pushName.

Optional sessionId

sessionId?: null | number

ClientPayload sessionId.

shards

shards: number[]

ClientPayload shards.

Optional shortConnect

shortConnect?: null | boolean

ClientPayload shortConnect.

Optional trafficAnonymization

trafficAnonymization?: null | TrafficAnonymization

ClientPayload trafficAnonymization.

Optional userAgent

userAgent?: null | IUserAgent

ClientPayload userAgent.

Optional username

username?: null | number | Long

ClientPayload username.

Optional webInfo

webInfo?: null | IWebInfo

ClientPayload webInfo.

Optional yearClass

yearClass?: null | number

ClientPayload yearClass.

Methods

toJSON

  • Converts this ClientPayload to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

Static decode

  • 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

  • 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

  • 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

  • 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

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

  • Gets the default type url for ClientPayload

    Parameters

    • Optional typeUrlPrefix: string

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

    Returns string

    The default type url

Static toObject

  • 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

  • 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc