VIClient
Interface that may be used to connect and login to Voximplant Cloud, make and receive audio/video calls.
Methods
callConference:settings:
- (nullable VICall *
)callConference:(NSString *
)conference
settings:()settings Create a call to a dedicated conference without proxy session. The call must be then started using [VICall start]. For details see the video conferencing guide.
Parameters
conference:
NSString *
The number to call. For SIP compatibility reasons it should be a non-empty string even if the number itself is not used by a Voximplant cloud scenario.
settings:
Call settings with additional call parameters, such as preferred video codec, custom data, extra headers etc.
Returns
type:
nullable VICall *
call:settings:
- (nullable VICall *
)call:(NSString *
)number
settings:()settings Create a new call instance. The call must be then started using [VICall start].
Parameters
number:
NSString *
SIP URI, username or phone number to make call to. Actual routing is then performed by VoxEngine scenario.
settings:
Call settings with additional call parameters, such as preferred video codec, custom data, extra headers etc.
Returns
type:
nullable VICall *
clientVersion
+ (NSString *
)clientVersionGet client version.
Returns
type:
NSString *
connectTo:
- (BOOL
)connectTo:()node Connect to the Voximplant Cloud. Connectivity check is disabled.
Parameters
node:
Node the Voximplant account belongs to. Find more information about VIConnectionNode in the getting started guide.
Returns
type:
BOOL
connectTo:connectivityCheck:gateways:
- (BOOL
)connectTo:()node
connectivityCheck:(BOOL
)connectivityCheck
gateways:(nullable NSArray *
)gateways Connect to the Voximplant Cloud.
Parameters
node:
Node the Voximplant account belongs to. Find more information about VIConnectionNode in the getting started guide.
connectivityCheck:
BOOL
Checks whether UDP traffic will flow correctly between device and Voximplant Cloud. This check reduces connection speed.
gateways:
nullable NSArray *
Array of server names of particular media gateways for connection.
Returns
type:
BOOL
disconnect
- (void
)disconnectDisconnect from the Voximplant Cloud.
Returns
type:
void
handlePushNotification:
- (nullable NSUUID *
)handlePushNotification:(nullable NSDictionary *
)notification Handle an incoming push notification.
Parameters
notification:
nullable NSDictionary *
The incoming notification which comes from [PKPushRegistryDelegate pushRegistry:didReceiveIncomingPushWithPayload:forType:withCompletionHandler:].
Returns
type:
nullable NSUUID *
initWithDelegateQueue:
- (instancetype
)initWithDelegateQueue:(dispatch_queue_t
)queue Initialize client instance.
Parameters
queue:
dispatch_queue_t
All delegates methods will be called on this queue. Queue should be serial, but not concurrent (main queue is applicable).
Returns
type:
instancetype
initWithDelegateQueue:bundleId:
- (instancetype
)initWithDelegateQueue:(dispatch_queue_t
)queue
bundleId:(nullable NSString *
)bundleId Initialize a client instance.
You need to use this only if you are going to send push notifications across several iOS apps using a single Voximplant application.
Parameters
queue:
dispatch_queue_t
All delegates methods will be called on this queue. Queue should be serial, but not concurrent (main queue is applicable).
bundleId:
nullable NSString *
Application bundle id
Returns
type:
instancetype
loginWithUser:oneTimeKey:success:failure:
- (void
)loginWithUser:(NSString *
)user
oneTimeKey:(NSString *
)oneTimeKey
success:(nullable VILoginSuccess
)success
failure:(nullable VILoginFailure
)failure Login to the Voximplant Cloud using one time key.
Parameters
user:
NSString *
Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com.
oneTimeKey:
NSString *
Hash that was generated using following formula:
MD5(oneTimeKey+"|"+MD5(user+":voximplant.com:"+password))Please note that here user is just a user name, without app name, account name or anything else after "@".
So if you pass myuser@myapp.myacc.voximplant.com as a username, you should only use myuser while computing this hash.
success:
nullable VILoginSuccess
Completion handler triggered if operation is completed successfully.
failure:
nullable VILoginFailure
Completion handler failure triggered if operation is failed.
Returns
type:
void
loginWithUser:password:success:failure:
- (void
)loginWithUser:(NSString *
)user
password:(NSString *
)password
success:(nullable VILoginSuccess
)success
failure:(nullable VILoginFailure
)failure Login to the Voximplant Cloud using password.
Parameters
user:
NSString *
Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com.
password:
NSString *
User password.
success:
nullable VILoginSuccess
Completion handler triggered if operation is completed successfully.
failure:
nullable VILoginFailure
Completion handler failure triggered if operation is failed.
Returns
type:
void
loginWithUser:token:success:failure:
- (void
)loginWithUser:(NSString *
)user
token:(NSString *
)token
success:(nullable VILoginSuccess
)success
failure:(nullable VILoginFailure
)failure Login to the Voximplant Cloud using access token.
Parameters
user:
NSString *
Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com.
token:
NSString *
Access token obtained from authParams.
success:
nullable VILoginSuccess
Completion handler triggered if operation is completed successfully.
failure:
nullable VILoginFailure
Completion handler failure triggered if operation is failed.
Returns
type:
void
refreshTokenWithUser:token:result:
- (void
)refreshTokenWithUser:(NSString *
)user
token:(NSString *
)token
result:(nullable VIRefreshTokenResult
)result Perform refresh of login tokens required for login using access token.
Parameters
user:
NSString *
Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com.
token:
NSString *
Refresh token obtained from authParams.
result:
nullable VIRefreshTokenResult
Completion handler that is triggered when the operation is completed.
Returns
type:
void
registerIMPushNotificationsToken:completion:
- (void
)registerIMPushNotificationsToken:(NSData *
)imToken
completion:(nullable VICompletionBlock
)completion Register an Apple Push Notifications token.
After calling this function application will receive push notifications from Voximplant Server. If the provided token is not nil, but the client is not logged in, the token will be registered just after login.
Parameters
imToken:
NSData *
The APNS token for IM push notifications.
completion:
nullable VICompletionBlock
Completion block to handle the result of the operation.
Returns
type:
void
registerPushNotificationsToken:imToken:
Use [VIClient registerVoIPPushNotificationsToken:completion:] and [VIClient registerIMPushNotificationsToken:completion:] instead.
- (BOOL
)registerPushNotificationsToken:(nullable NSData *
)voipToken
imToken:(nullable NSData *
)imToken Register an Apple Push Notifications token.
After calling this function application will receive push notifications from Voximplant Server. If the provided tokens are not nil, but the client is not logged in, the tokens will be registered just after login, despite the API returns NO.
Parameters
voipToken:
nullable NSData *
The APNS token for VoIP push notifications which comes from [PKPushRegistryDelegate pushRegistry:didUpdatePushCredentials:forType:].
imToken:
nullable NSData *
The APNS token for IM push notifications.
Returns
type:
BOOL
registerVoIPPushNotificationsToken:completion:
- (void
)registerVoIPPushNotificationsToken:(NSData *
)voipToken
completion:(nullable VICompletionBlock
)completion Register an Apple Push Notifications token.
After calling this function application will receive push notifications from Voximplant Server. If the provided token is not nil, but the client is not logged in, the token will be registered just after login.
Parameters
voipToken:
NSData *
The APNS token for VoIP push notifications which comes from [PKPushRegistryDelegate pushRegistry:didUpdatePushCredentials:forType:].
completion:
nullable VICompletionBlock
Completion block to handle the result of the operation.
Returns
type:
void
requestOneTimeKeyWithUser:result:
- (void
)requestOneTimeKeyWithUser:(NSString *
)user
result:()result Generates one time login key to be used for automated login process.
For additional information please see:
Parameters
user:
NSString *
Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com.
result:
Completion handler that is triggered when the operation is completed.
Returns
type:
void
setLogDelegate:
+ (void
)setLogDelegate:(id<VILogDelegate>
)logDelegate Set log delegate to handle Voximplant iOS SDK log messages.
Parameters
logDelegate:
id<VILogDelegate>
Log delegate instance
Returns
type:
void
setLogLevel:
+ (void
)setLogLevel:()logLevel Set a verbosity level for log messages. This method must be called before creating SDK object instance.
Parameters
logLevel:
Log verbosity level.
Returns
type:
void
unregisterIMPushNotificationsToken:completion:
- (void
)unregisterIMPushNotificationsToken:(NSData *
)imToken
completion:(nullable VICompletionBlock
)completion Unregister an Apple Push Notifications token.
After calling this function application stops receive push notifications from Voximplant Server. If the provided token is not nil, but the client is not logged in, the token will be unregistered just after login.
Parameters
imToken:
NSData *
The APNS token for IM push notification.
completion:
nullable VICompletionBlock
Completion block to handle the result of the operation.
Returns
type:
void
unregisterPushNotificationsToken:imToken:
Use [VIClient unregisterVoIPPushNotificationsToken:completion:] and [VIClient unregisterIMPushNotificationsToken:completion:] instead.
- (BOOL
)unregisterPushNotificationsToken:(nullable NSData *
)voipToken
imToken:(nullable NSData *
)imToken Unregister an Apple Push Notifications token.
After calling this function application stops receive push notifications from Voximplant Server. If the provided tokens are not nil, but the client is not logged in, the tokens will be unregistered just after login, despite the API returns NO.
Parameters
voipToken:
nullable NSData *
The APNS token for VoIP push notifications which comes from [PKPushRegistryDelegate pushRegistry:didUpdatePushCredentials:forType:].
imToken:
nullable NSData *
The APNS token for IM push notification.
Returns
type:
BOOL
unregisterVoIPPushNotificationsToken:completion:
- (void
)unregisterVoIPPushNotificationsToken:(NSData *
)voipToken
completion:(nullable VICompletionBlock
)completion Unregister an Apple Push Notifications token.
After calling this function application stops receive push notifications from Voximplant Server. If the provided token is not nil, but the client is not logged in, the token will be unregistered just after login.
Parameters
voipToken:
NSData *
The APNS token for VoIP push notifications which comes from [PKPushRegistryDelegate pushRegistry:didUpdatePushCredentials:forType:].
completion:
nullable VICompletionBlock
Completion block to handle the result of the operation.
Returns
type:
void
webrtcVersion
+ (NSString *
)webrtcVersionGet underlying WebRTC version.
Returns
type:
NSString *
Props
callManagerDelegate
@property (weak, nullable, nonatomic) callManagerDelegateCall manager delegate that handles incoming calls.
Returns
type:
calls
@property (strong, readonly, nonatomic) NSDictionary<NSString *, VICall *> *
callsDictionary of actual calls with their ids.
Returns
type:
NSDictionary<NSString *, VICall *> *
clientState
@property (readonly, nonatomic) clientStateCurrent client state.
Returns
type:
enableForceRelayTraffic
@property (assign, nonatomic) BOOL
enableForceRelayTrafficForce traffic to go through TURN servers
Setting this property enables or disables traffic to go through TURN servers for all calls since next call.
Default is NO.
Returns
type:
BOOL
enableVideoAdaptation
@property (assign, nonatomic) BOOL
enableVideoAdaptationA Boolean value that determines whether a video adaptation for CPU usage and current bandwidth is enabled.
Setting this property enables or disables video adaptation for all calls since next call.
Default is YES.
Returns
type:
BOOL
messenger
@property (strong, readonly, nonatomic) messengerGet the instance of messaging subsystem.
Messenger instance.
Returns
type:
sessionDelegate
@property (weak, nullable, nonatomic) sessionDelegateSession delegate that handles events for the connection with the Voximplant Cloud.
Returns
type: