Class Client

A XirSys v2 client.

Hierarchy

Client

Index

Constructors

constructor

new Client(ident: string, secret: string, domain: string, application: string, room: string): Client
new Client(ident: string, secret: string, domain: string, application: string): Client
new Client(ident: string, secret: string, domain: string): Client
new Client(ident: string, secret: string, domain: string, application: string, room: string, secure: boolean): Client

- Defined in fm.icelink.xirsys/v2/Client.ts:43
Initializes a new instance of the fm.icelink.xirsys.v2.client class.

Parameters
- ident: string
  
  The "ident" value.
- secret: string
  
  The "secret" value.
- domain: string
  
  The "domain" value.
- application: string
  
  The "application" value.
- room: string
  
  The "room" value.
Returns Client
- Defined in fm.icelink.xirsys/v2/Client.ts:58
Initializes a new instance of the fm.icelink.xirsys.v2.client class.

Parameters
- ident: string
  
  The "ident" value.
- secret: string
  
  The "secret" value.
- domain: string
  
  The "domain" value.
- application: string
  
  The "application" value.
Returns Client
- Defined in fm.icelink.xirsys/v2/Client.ts:71
Initializes a new instance of the fm.icelink.xirsys.v2.client class.

Parameters
- ident: string
  
  The "ident" value.
- secret: string
  
  The "secret" value.
- domain: string
  
  The "domain" value.
Returns Client
- Defined in fm.icelink.xirsys/v2/Client.ts:83
Initializes a new instance of the fm.icelink.xirsys.v2.client class.

Parameters
- ident: string
  
  The "ident" value.
- secret: string
  
  The "secret" value.
- domain: string
  
  The "domain" value.
- application: string
  
  The "application" value.
- room: string
  
  The "room" value.
- secure: boolean
  
  The "secure" value.
Returns Client

Properties

Private _application

_application: string

internal

Private _domain

_domain: string

internal

Private _endpoint

_endpoint: string

internal

Private _ident

_ident: string

internal

Private _room

_room: string

internal

Private _secret

_secret: string

internal

Private _secure

_secure: boolean

internal

Static Private __fmicelinkxirsysv2ClientInitialized

__fmicelinkxirsysv2ClientInitialized: boolean = false

internal

Static Private fm_icelink_xirsys_v2_Client___defaultEndpoint

fm_icelink_xirsys_v2_Client___defaultEndpoint: string

internal

Methods

Private doGetIceServers

doGetIceServers(promise: Promise<IceServer[]>): void

- Defined in fm.icelink.xirsys/v2/Client.ts:289
internal

Parameters
- promise: Promise<IceServer[]>
Returns void

getApplication

getApplication(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:329
Gets the "application" value. Defaults to "default".

Returns string

getDomain

getDomain(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:345
Gets the "domain" value.

Returns string

getEndpoint

getEndpoint(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:361
Gets the HTTP endpoint.

Returns string

getIceServers

getIceServers(): Future<IceServer[]>

- Defined in fm.icelink.xirsys/v2/Client.ts:376
Gets an array of XirSys ICE servers.

Returns Future<IceServer[]>

getIdent

getIdent(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:394
Gets the "ident" value.

Returns string

getRoom

getRoom(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:411
Gets the "room" value. Defaults to "default".

Returns string

getSecret

getSecret(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:427
Gets the "secret" value.

Returns string

getSecure

getSecure(): boolean

- Defined in fm.icelink.xirsys/v2/Client.ts:444
Gets the "secure" value. Defaults to true.

Returns boolean

getTypeString

getTypeString(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:9
Returns string

setApplication

setApplication(value: string): void

- Defined in fm.icelink.xirsys/v2/Client.ts:462
Sets the "application" value. Defaults to "default".

Parameters
- value: string
Returns void

setDomain

setDomain(value: string): void

- Defined in fm.icelink.xirsys/v2/Client.ts:479
Sets the "domain" value.

Parameters
- value: string
Returns void

setEndpoint

setEndpoint(value: string): void

- Defined in fm.icelink.xirsys/v2/Client.ts:496
Sets the HTTP endpoint.

Parameters
- value: string
Returns void

setIdent

setIdent(value: string): void

- Defined in fm.icelink.xirsys/v2/Client.ts:513
Sets the "ident" value.

Parameters
- value: string
Returns void

setRoom

setRoom(value: string): void

- Defined in fm.icelink.xirsys/v2/Client.ts:531
Sets the "room" value. Defaults to "default".

Parameters
- value: string
Returns void

setSecret

setSecret(value: string): void

- Defined in fm.icelink.xirsys/v2/Client.ts:548
Sets the "secret" value.

Parameters
- value: string
Returns void

setSecure

setSecure(value: boolean): void

- Defined in fm.icelink.xirsys/v2/Client.ts:566
Sets the "secure" value. Defaults to true.

Parameters
- value: boolean
Returns void

Private toFormData

toFormData(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:577
internal

Returns string

Static fmicelinkxirsysv2ClientInitialize

fmicelinkxirsysv2ClientInitialize(): void

- Defined in fm.icelink.xirsys/v2/Client.ts:587
internal

Returns void

Static getDefaultEndpoint

getDefaultEndpoint(): string

- Defined in fm.icelink.xirsys/v2/Client.ts:260
Gets the default HTTP endpoint. Defaults to "https://service.xirsys.com/ice".

Returns string

Static setDefaultEndpoint

setDefaultEndpoint(value: string): void

- Defined in fm.icelink.xirsys/v2/Client.ts:278
Sets the default HTTP endpoint. Defaults to "https://service.xirsys.com/ice".

Parameters
- value: string
Returns void