FMIceLinkXirSysV2Client Class Reference

Inherits from NSObject
Declared in FMIceLinkXirSysV2Client.h
FMIceLinkXirSysV2Client.m

Overview

A XirSys v2 client.

– application

Gets the "application" value. Defaults to "default".
- (NSString *)application

Discussion

Gets the "application" value. Defaults to "default".

Declared In

FMIceLinkXirSysV2Client.h

+ clientWithIdent:secret:domain:

Initializes a new instance of the FMIceLinkXirSysV2Client class.
+ (FMIceLinkXirSysV2Client *)clientWithIdent:(NSString *)ident secret:(NSString *)secret domain:(NSString *)domain

Parameters

ident

The “ident” value.
secret

The “secret” value.
domain

The “domain” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV2Client class.

Declared In

FMIceLinkXirSysV2Client.h

+ clientWithIdent:secret:domain:application:

Initializes a new instance of the FMIceLinkXirSysV2Client class.
+ (FMIceLinkXirSysV2Client *)clientWithIdent:(NSString *)ident secret:(NSString *)secret domain:(NSString *)domain application:(NSString *)application

Parameters

ident

The “ident” value.
secret

The “secret” value.
domain

The “domain” value.
application

The “application” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV2Client class.

Declared In

FMIceLinkXirSysV2Client.h

+ clientWithIdent:secret:domain:application:room:

Initializes a new instance of the FMIceLinkXirSysV2Client class.
+ (FMIceLinkXirSysV2Client *)clientWithIdent:(NSString *)ident secret:(NSString *)secret domain:(NSString *)domain application:(NSString *)application room:(NSString *)room

Parameters

ident

The “ident” value.
secret

The “secret” value.
domain

The “domain” value.
application

The “application” value.
room

The “room” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV2Client class.

Declared In

FMIceLinkXirSysV2Client.h

+ clientWithIdent:secret:domain:application:room:secure:

Initializes a new instance of the FMIceLinkXirSysV2Client class.
+ (FMIceLinkXirSysV2Client *)clientWithIdent:(NSString *)ident secret:(NSString *)secret domain:(NSString *)domain application:(NSString *)application room:(NSString *)room secure:(bool)secure

Parameters

ident

The “ident” value.
secret

The “secret” value.
domain

The “domain” value.
application

The “application” value.
room

The “room” value.
secure

The “secure” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV2Client class.

Declared In

FMIceLinkXirSysV2Client.h

+ defaultEndpoint

Gets the default HTTP endpoint. Defaults to "[https://service.xirsys.com/ice](https://service.xirsys.com/ice)".
+ (NSString *)defaultEndpoint

Discussion

Gets the default HTTP endpoint. Defaults to "[https://service.xirsys.com/ice](https://service.xirsys.com/ice)".

Declared In

FMIceLinkXirSysV2Client.h

– domain

Gets the "domain" value.
- (NSString *)domain

Discussion

Gets the "domain" value.

Declared In

FMIceLinkXirSysV2Client.h

– endpoint

Gets the HTTP endpoint.
- (NSString *)endpoint

Discussion

Gets the HTTP endpoint.

Declared In

FMIceLinkXirSysV2Client.h

– getIceServers

Gets an array of XirSys ICE servers.

@return

- (FMIceLinkFuture<NSMutableArray*> *)getIceServers

Discussion

Gets an array of XirSys ICE servers.

@return

Declared In

FMIceLinkXirSysV2Client.h

– ident

Gets the "ident" value.
- (NSString *)ident

Discussion

Gets the "ident" value.

Declared In

FMIceLinkXirSysV2Client.h

– initWithIdent:secret:domain:

Initializes a new instance of the FMIceLinkXirSysV2Client class.
- (instancetype)initWithIdent:(NSString *)ident secret:(NSString *)secret domain:(NSString *)domain

Parameters

ident

The “ident” value.
secret

The “secret” value.
domain

The “domain” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV2Client class.

Declared In

FMIceLinkXirSysV2Client.h

– initWithIdent:secret:domain:application:

Initializes a new instance of the FMIceLinkXirSysV2Client class.
- (instancetype)initWithIdent:(NSString *)ident secret:(NSString *)secret domain:(NSString *)domain application:(NSString *)application

Parameters

ident

The “ident” value.
secret

The “secret” value.
domain

The “domain” value.
application

The “application” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV2Client class.

Declared In

FMIceLinkXirSysV2Client.h

– initWithIdent:secret:domain:application:room:

Initializes a new instance of the FMIceLinkXirSysV2Client class.
- (instancetype)initWithIdent:(NSString *)ident secret:(NSString *)secret domain:(NSString *)domain application:(NSString *)application room:(NSString *)room

Parameters

ident

The “ident” value.
secret

The “secret” value.
domain

The “domain” value.
application

The “application” value.
room

The “room” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV2Client class.

Declared In

FMIceLinkXirSysV2Client.h

– initWithIdent:secret:domain:application:room:secure:

Initializes a new instance of the FMIceLinkXirSysV2Client class.
- (instancetype)initWithIdent:(NSString *)ident secret:(NSString *)secret domain:(NSString *)domain application:(NSString *)application room:(NSString *)room secure:(bool)secure

Parameters

ident

The “ident” value.
secret

The “secret” value.
domain

The “domain” value.
application

The “application” value.
room

The “room” value.
secure

The “secure” value.

Discussion

Initializes a new instance of the FMIceLinkXirSysV2Client class.

Declared In

FMIceLinkXirSysV2Client.h

– room

Gets the "room" value. Defaults to "default".
- (NSString *)room

Discussion

Gets the "room" value. Defaults to "default".

Declared In

FMIceLinkXirSysV2Client.h

– secret

Gets the "secret" value.
- (NSString *)secret

Discussion

Gets the "secret" value.

Declared In

FMIceLinkXirSysV2Client.h

– secure

Gets the "secure" value. Defaults to true.
- (bool)secure

Discussion

Gets the "secure" value. Defaults to true.

Declared In

FMIceLinkXirSysV2Client.h

– setApplication:

Sets the "application" value. Defaults to "default".
- (void)setApplication:(NSString *)value

Discussion

Sets the "application" value. Defaults to "default".

Declared In

FMIceLinkXirSysV2Client.h

+ setDefaultEndpoint:

Sets the default HTTP endpoint. Defaults to "[https://service.xirsys.com/ice](https://service.xirsys.com/ice)".
+ (void)setDefaultEndpoint:(NSString *)value

Discussion

Sets the default HTTP endpoint. Defaults to "[https://service.xirsys.com/ice](https://service.xirsys.com/ice)".

Declared In

FMIceLinkXirSysV2Client.h

– setDomain:

Sets the "domain" value.
- (void)setDomain:(NSString *)value

Discussion

Sets the "domain" value.

Declared In

FMIceLinkXirSysV2Client.h

– setEndpoint:

Sets the HTTP [endpoint](#//api/name/endpoint).
- (void)setEndpoint:(NSString *)value

Discussion

Sets the HTTP [endpoint](#//api/name/endpoint).

Declared In

FMIceLinkXirSysV2Client.h

– setIdent:

Sets the "ident" value.
- (void)setIdent:(NSString *)value

Discussion

Sets the "ident" value.

Declared In

FMIceLinkXirSysV2Client.h

– setRoom:

Sets the "room" value. Defaults to "default".
- (void)setRoom:(NSString *)value

Discussion

Sets the "room" value. Defaults to "default".

Declared In

FMIceLinkXirSysV2Client.h

– setSecret:

Sets the "secret" value.
- (void)setSecret:(NSString *)value

Discussion

Sets the "secret" value.

Declared In

FMIceLinkXirSysV2Client.h

– setSecure:

Sets the "secure" value. Defaults to true.
- (void)setSecure:(bool)value

Discussion

Sets the "secure" value. Defaults to true.

Declared In

FMIceLinkXirSysV2Client.h