VIClient

- (nullable VICall *)call:(NSString *)number
                 settings:(VICallSettings *)settings

Parameters

• number:

  NSString *

  SIP URI, username or phone number to make call to. Actual routing is then performed by VoxEngine scenario.

• settings:

  VICallSettings *

  Call settings with additional call parameters, such as preferred video codec, custom data, extra headers etc.

Returns

• Return:

  nullable VICall *

  Call instance

- (nullable VICall *)callConference:(NSString *)conference
                           settings:(VICallSettings *)settings

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:

  VICallSettings *

  Call settings with additional call parameters, such as preferred video codec, custom data, extra headers etc.

Returns

• Return:

  nullable VICall *

  Call instance

- (nullable VICall *)callToUser:(NSString *)user
                  withSendVideo:(BOOL)sendVideo
                   receiveVideo:(BOOL)receiveVideo
                     customData:(nullable NSString *)customData

Parameters

• user:

  NSString *

  SIP URI, username or phone number to make call to. Actual routing is then performed by VoxEngine scenario.

• sendVideo:

  BOOL

  Specify if video send is enabled for a call.

• receiveVideo:

  BOOL

  Specify if video receive is enabled for a call.

• customData:

  nullable NSString *

  Custom string associated with the call session. It can be passed to the cloud to be obtained from the CallAlerting event or Call History using HTTP API. Maximum size is 200 bytes. Use the [VICall sendMessage:] method to pass a string over the limit; in order to pass a large data use media_session_access_url on your backend.

Returns

• Return:

  nullable VICall *

  Call instance

+ (NSString *)clientVersion

Returns

• Return:

  NSString *

  Voximplant Client version.

- (BOOL)connect

Returns

• Return:

  BOOL

  YES if the attempt to connect can be performed, NO otherwise. Return value "NO" means that the connection to Voximplant Cloud is currently establishing or already established. In this case please check the current client state via [VIClient clientState] property and proceed according to the current state.

- (BOOL)connectWithConnectivityCheck:(BOOL)connectivityCheck
                            gateways:(nullable NSArray *)gateways

Parameters

• 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

• Return:

  BOOL

  YES if the attempt to connect can be performed, NO otherwise. Return value NO means that the connection to Voximplant Cloud is currently establishing or already established. In this case please check the current client state via [VIClient clientState] property and proceed according to the current state.

- (void)disconnect

- (void)handlePushNotification:(NSDictionary *)notification

Parameters

• notification:

  NSDictionary *

  The incoming notification which comes from [PKPushRegistryDelegate pushRegistry:didReceiveIncomingPushWithPayload:forType:withCompletionHandler:].

- (instancetype)initWithDelegateQueue:(dispatch_queue_t)queue

Parameters

• queue:

  dispatch_queue_t

  All delegates methods will be called in this queue. Queue should be serial, but not concurrent (main queue is applicable).

Returns

• Return:

  instancetype

  Client instance.

- (instancetype)initWithDelegateQueue:(dispatch_queue_t)queue
                             bundleId:(nullable NSString *)bundleId

Parameters

• queue:

  dispatch_queue_t

  All delegates methods will be called in this queue. Queue should be serial, but not concurrent (main queue is applicable).

• bundleId:

  nullable NSString *

  Application bundle id

Returns

• Return:

  instancetype

  Client instance.

- (void)loginWithUser:(NSString *)user
           oneTimeKey:(NSString *)oneTimeKey
              success:(nullable VILoginSuccess)success
              failure:(nullable VILoginFailure)failure

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.

  typedef void (^VILoginSuccess)(NSString *displayName, NSDictionary *authParams);

  • displayName: Display name of logged in user.
  • authParams: Auth parameters that can be used to login using access token.

• failure:

  nullable VILoginFailure

  Completion handler failure triggered if operation is failed.

  typedef void (^VILoginFailure)(NSError *error);

  • error: Error description.

- (void)loginWithUser:(NSString *)user
             password:(NSString *)password
              success:(nullable VILoginSuccess)success
              failure:(nullable VILoginFailure)failure

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.

  typedef void (^VILoginSuccess)(NSString *displayName, NSDictionary *authParams);

  • displayName: Display name of logged in user.
  • authParams: Auth parameters that can be used to login using access token.

• failure:

  nullable VILoginFailure

  Completion handler failure triggered if operation is failed.

  typedef void (^VILoginFailure)(NSError *error);

  • error: Error description.

- (void)loginWithUser:(NSString *)user
                token:(NSString *)token
              success:(nullable VILoginSuccess)success
              failure:(nullable VILoginFailure)failure

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.

  typedef void (^VILoginSuccess)(NSString *displayName, NSDictionary *authParams);

  • displayName: Display name of logged in user.
  • authParams: Auth parameters that can be used to login using access token.

• failure:

  nullable VILoginFailure

  Completion handler failure triggered if operation is failed.

  typedef void (^VILoginFailure)(NSError *error);

  • error: Error description.

- (void)refreshTokenWithUser:(NSString *)user
                       token:(NSString *)token
                      result:(nullable VIRefreshTokenResult)result

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.

  typedef void (^VIRefreshTokenResult)(NSDictionary *authParams, NSError *error);

  • authParams: Auth parameters that can be used to login using access token.
  • error: Error if operation failed, nil otherwise.

- (void)registerPushNotificationsToken:(nullable NSData *)voipToken
                               imToken:(nullable NSData *)imToken

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.

- (void)requestOneTimeKeyWithUser:(NSString *)user
                           result:(VIOneTimeKeyResult)result

Parameters

• user:

  NSString *

  Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com.

• result:

  VIOneTimeKeyResult

  Completion handler that is triggered when the operation is completed.

  typedef void (^VIOneTimeKeyResult)(NSString *oneTimeKey, NSError *error);

  • oneTimeKey: Resulting One Time Key.
  • error: Error if operation failed, nil otherwise.

+ (void)saveLogToFileEnable

+ (void)setLogLevel:(VILogLevel)logLevel

Parameters

• logLevel:

  VILogLevel

  Log verbosity level.

- (void)unregisterPushNotificationsToken:(nullable NSData *)voipToken
                                 imToken:(nullable NSData *)imToken

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.

+ (NSString *)webrtcVersion

Returns

• Return:

  NSString *

  WebRTC version.