ApiRTC iOS SDK Documentation

Structure Register​Information

public struct RegisterInformation  

Initializers

init(cloud​Url:​cloud​Fetch​Retries:​id:​cloud​Fetch​Retry​Delay:​mcu:​css:​password:​groups:​subscribe​To:​user​Data:​turn​Server​Address:​)

public init(
        cloudUrl: String? = nil,
        cloudFetchRetries: Int? = nil,
        id: String? = nil,
        cloudFetchRetryDelay: TimeInterval? = nil,
        mcu: String? = nil,
        css: String? = nil,
        password: String? = nil,
        groups: [String]? = nil,
        subscribeTo: [String]? = nil,
        userData: [String: Any?]? = nil,
        turnServerAddress: String? = nil
        )  

init(password:​)

public init(password: String)  

Properties

cloud​Url

public private(set) var cloudUrl: String? 

Registration Apizee cloud url

cloud​Fetch​Retries

public private(set) var cloudFetchRetries: Int? 

Number of fetch retries when sending request to Apizee cloud (default value is 100)

cloud​Fetch​Retry​Delay

public private(set) var cloudFetchRetryDelay: TimeInterval? 

Delay in s between fetch retries when sending request to Apizee cloud. This delay is increased on each retry: retryDelay = retryDelay x retryNumber (default value is 0.2 s)

id

public private(set) var id: String? 

Set a predefined id for the session instead of the cloud id or a random id

mcu

public private(set) var mcu: String? 

Preferred MCU server

ccs

public private(set) var ccs: String? 

Preferred CCS server

password

public private(set) var password: String? 

UserAgent password for UserAgentURI.apizee(_:)

groups

public private(set) var groups: [String]? 

Presence groups the user agent will join on registration

subscribe​To

public private(set) var subscribeTo: [String]? 

Presence groups the user agent will subscribe to on registration

user​Data

public private(set) var userData: [String: Any?]? 

turn​Server​Address

public private(set) var turnServerAddress: String? 

Turn server address to be used for all calls (Default value is : mp1.apizee.com)