Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataChannel

Hierarchy

  • Dynamic
    • DataChannel

Implements

  • IDataChannel<DataChannel>
  • IExternalDataChannel

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DataChannel(label: string, ordered?: boolean, subprotocol?: string): DataChannel

  • Parameters

    • label: string
    • Optional ordered: boolean
    • Optional subprotocol: string

    Returns DataChannel

Properties

Private _internal

_internal: IInternalDataChannel
internal

Private _onStateChangeValues

_onStateChangeValues: IAction1<DataChannel>[] = []
internal

Methods

_getInternal

  • _getInternal(): IInternalDataChannel
  • internal

    Returns IInternalDataChannel

addOnStateChange

  • addOnStateChange(value: IAction1<DataChannel>): void

  • Parameters

    • value: IAction1<DataChannel>

    Returns void

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.

getId

  • getId(): string

  • Returns string

getIsDirty

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

    Returns boolean

getIsSerialized

  • getIsSerialized(): boolean

getLabel

  • getLabel(): string

  • Returns string

getOnReceive

  • getOnReceive(): IAction1<DataChannelReceiveArgs>

  • Returns IAction1<DataChannelReceiveArgs>

getOrdered

  • getOrdered(): boolean

  • Returns boolean

getSerialized

  • getSerialized(): string

getState

  • getState(): DataChannelState

  • Returns DataChannelState

getSubprotocol

  • getSubprotocol(): string

  • Returns string

getTypeString

  • getTypeString(): string

removeOnStateChange

  • removeOnStateChange(value: IAction1<DataChannel>): void

  • Parameters

    • value: IAction1<DataChannel>

    Returns void

sendDataBytes

  • sendDataBytes(dataBytes: DataBuffer): void

  • Parameters

    • dataBytes: DataBuffer

    Returns void

sendDataString

  • sendDataString(dataString: string): void

  • Parameters

    • dataString: string

    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

setId

  • setId(value: string): void

  • Parameters

    • value: string

    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

setOnReceive

  • setOnReceive(value: IAction1<DataChannelReceiveArgs>): void

  • Parameters

    • value: IAction1<DataChannelReceiveArgs>

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    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.