Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IceServer

internal

Hierarchy

  • Dynamic
    • IceServer

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private _credential

_credential: string
internal

Private _url

_url: string
internal

Private _username

_username: string
internal

Methods

getCredential

  • getCredential(): string

  • Returns string

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

getSerialized

  • getSerialized(): string

getTypeString

  • getTypeString(): string

getUrl

  • getUrl(): string

  • Returns string

getUsername

  • getUsername(): string

  • Returns string

setCredential

  • setCredential(value: string): void

  • Parameters

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

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

setSerialized

  • setSerialized(value: string): void
  • internal

    Parameters

    • value: string

    Returns void

setUrl

  • setUrl(value: string): void

  • Parameters

    • value: string

    Returns void

setUsername

  • setUsername(value: string): void

  • Parameters

    • value: string

    Returns void

toJson

  • toJson(): string

  • Returns string

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.

Static fromJson

  • Parameters

    • iceServerJson: string

    Returns IceServer

Static fromJsonMultiple

  • fromJsonMultiple(iceServersJson: string): IceServer[]

  • Parameters

    • iceServersJson: string

    Returns IceServer[]

Static toJson

  • Parameters

    Returns string

Static toJsonMultiple

  • toJsonMultiple(iceServers: IceServer[]): string

  • Parameters

    Returns string