Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PluginDataStream

Hierarchy

  • PluginStream
    • PluginDataStream

Implements

  • IStream
  • IInternalStream
  • IDataStream<PluginDataChannel>
  • IInternalDataStream

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PluginDataStream(external: IExternalDataStream, channels: PluginDataChannel[]): PluginDataStream

  • Parameters

    • external: IExternalDataStream
    • channels: PluginDataChannel[]

    Returns PluginDataStream

Properties

Private _axo

_axo: DataStreamActiveXObject
internal

Private _channels

_channels: PluginDataChannel[]
internal

Private _external

_external: IExternalDataStream
internal

Private _onDirectionChangeValues

_onDirectionChangeValues: IAction0[] = []
internal

Methods

Protected _getAxo

  • _getAxo(): DataStreamActiveXObject
  • internal

    Returns DataStreamActiveXObject

_getExternal

  • _getExternal(): IExternalDataStream
  • internal

    Returns IExternalDataStream

addOnDirectionChange

  • addOnDirectionChange(callback: Object): void

  • Parameters

    • callback: Object

    Returns void

changeDirection

  • changeDirection(newDirection: StreamDirection): Error

  • Parameters

    • newDirection: StreamDirection

    Returns Error

getChannels

  • getChannels(): PluginDataChannel[]

  • Returns PluginDataChannel[]

getDirection

  • getDirection(): StreamDirection

  • Returns StreamDirection

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.

getHandle

  • getHandle(): number

  • Returns number

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

getLocalDirection

  • getLocalDirection(): StreamDirection

  • Returns StreamDirection

getLocalReceive

  • getLocalReceive(): boolean

  • Returns boolean

getLocalSend

  • getLocalSend(): boolean

  • Returns boolean

getRemoteDirection

  • getRemoteDirection(): StreamDirection

  • Returns StreamDirection

getRemoteReceive

  • getRemoteReceive(): boolean

  • Returns boolean

getRemoteSend

  • getRemoteSend(): boolean

  • Returns boolean

getSerialized

  • getSerialized(): string

getTag

  • getTag(): string

  • Returns string

getType

  • getType(): StreamType

  • Returns StreamType

getTypeString

  • getTypeString(): string

  • Returns string

removeOnDirectionChange

  • removeOnDirectionChange(callback: Object): void

  • Parameters

    • callback: Object

    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

setLocalDirection

  • setLocalDirection(value: StreamDirection): void

  • Parameters

    • value: StreamDirection

    Returns void

setLocalReceive

  • setLocalReceive(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setLocalSend

  • setLocalSend(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setTag

  • setTag(value: string): void

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