Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebSocketReceiveArgs

Arguments for fm.icelink.webSocketOpenArgs.onReceive.

Hierarchy

  • Dynamic
    • WebSocketReceiveArgs

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _binaryMessage

_binaryMessage: Uint8Array
internal

Private _openArgs

_openArgs: WebSocketOpenArgs
internal

Private _textMessage

_textMessage: string
internal

Methods

getBinaryMessage

  • getBinaryMessage(): Uint8Array
  • Gets the message received from the server as binary data.

    Returns Uint8Array

getDynamicProperties

  • getDynamicProperties(): Hash<string, Object>
  • Gets the dynamic properties on this instance.

    Returns Hash<string, Object>

getDynamicValue

  • getDynamicValue(key: string): Object
  • Gets a property value from the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns Object

    The stored value, if found; otherwise null.

getIsDirty

  • getIsDirty(): boolean
  • Gets a value indicating whether this instance is dirty.
    internal

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getIsText

  • getIsText(): boolean
  • Gets whether or not the received message is text.

    Returns boolean

getOpenArgs

  • getOpenArgs(): WebSocketOpenArgs
  • Gets the original arguments passed to the open method.

    Returns WebSocketOpenArgs

getSerialized

  • getSerialized(): string

getTextMessage

  • getTextMessage(): string
  • Gets the message received from the server as text data.

    Returns string

getTypeString

  • getTypeString(): string

setBinaryMessage

  • setBinaryMessage(value: Uint8Array): void
  • Sets the message received from the server as binary data.

    Parameters

    • value: Uint8Array

    Returns void

setDynamicProperties

  • setDynamicProperties(value: Hash<string, Object>): void
  • internal

    Parameters

    • value: Hash<string, Object>

    Returns void

setDynamicValue

  • setDynamicValue(key: string, value: Object): void
  • Sets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    • value: Object

      The property value. This can be any object that needs to be stored for future use.

    Returns void

setIsDirty

  • setIsDirty(value: boolean): void
  • Sets a value indicating whether this instance is dirty.
    internal

    Parameters

    • value: boolean

    Returns void

setIsSerialized

  • setIsSerialized(value: boolean): void
  • internal

    Parameters

    • value: boolean

    Returns void

setOpenArgs

  • setOpenArgs(value: WebSocketOpenArgs): void
  • Sets the original arguments passed to the open method.

    Parameters

    • value: WebSocketOpenArgs

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setTextMessage

  • setTextMessage(value: string): void
  • Sets the message received from the server as text data.

    Parameters

    • value: string

    Returns void

unsetDynamicValue

  • unsetDynamicValue(key: string): boolean
  • Unsets a property value in the local cache.

    Parameters

    • key: string

      The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns boolean

    true if the value was removed; otherwise, false.