iOS VCS Realtime SDK Documentation

Class Realtime​SDK 

public class RealtimeSDK

The RealtimeSDK class defines the interface to the SDK and allows the application to join a room and provides callback events through the RealtimeSDKProtocol.

RealtimeSDK RealtimeSDK SessionDelegate SessionDelegate RealtimeSDK->SessionDelegate

Nested Types

RealtimeSDK.RoomOptions

Options to be used when joining a room

RealtimeSDK.Settings

Initializers

init(delegate:​) 

public init(delegate: RealtimeSDKProtocol)

Create the RealtimeSDK object

Properties

advanced 

public var advanced: Settings

Advanced settings: Call Quality logging, etc.,

version 

public static var version: String

Version number of the RealtimeSDK framework

Methods

join​Room(token:​options:​completion​Handler:​) 

public func joinRoom(token: String, options: RoomOptions?, completionHandler: (RealtimeSDKError?) -> Void)

Join a room using the specified room token and options

Parameters

token String

String containing authentication token associated with the room
options Room​Options?

Options used when joining the room
completion​Handler (Realtime​SDKError?) -> Void

The completion handler specifies if an error was encountered when joining the room

subscribe​Log​Events(delegate:​severity:​) 

public func subscribeLogEvents(delegate: RealtimeSDKLogProtocol, severity: LogSeverity)

Subscribe to log events generated by the SDK

Parameters

delegate Realtime​SDKLog​Protocol

Object implementing RealtimeSDKLogProtocol

unsubscribe​Log​Events() 

public func unsubscribeLogEvents()

Unsubscribe to log events generated by the SDK

set​Test​Flag(key:​value:​) 

public func setTestFlag(key: String, value: Any)

Private API to set test flags.

get​Test​Flag(key:​) 

public func getTestFlag(key: String) -> Any?

Private API to get test flags.