IClient

ICall call(String number, CallSettings callSettings)

Parameters

• number:

  String

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

• callSettings:

  CallSettings

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

Returns

• Return:

  ICall

  ICall instance or null if the client is not logged in

ICall callConference(String number, CallSettings callSettings)

Parameters

• number:

  String

  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.

• callSettings:

  CallSettings

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

Returns

• Return:

  ICall

  ICall instance or null if the client is not logged in

void connect()

Throws

• тип:

  IllegalStateException If the connection is currently establishing or already established. Use IClient.getClientState() to check current state (since 2.3.2).

void connect(boolean connectivityCheck, List<String> gateways)

Parameters

• connectivityCheck:

  boolean

  Checks whether UDP traffic will flow correctly between device and Voximplant cloud. This check reduces connection speed.

• gateways:

  List<String>

  List of server names of particular media gateways for connection

Throws

• тип:

  IllegalStateException If the connection is currently establishing or already established. Use IClient.getClientState() to check current state (since 2.3.2).

void disconnect()

ClientState getClientState()

Returns

• Return:

  ClientState

  Current client state

List<String> getSupportedVideoCodecs()

Returns

• Return:

  List<String>

  List of video codec names, for example VP8, H264, VP9

void handlePushNotification(Map<String,String> notification)

Parameters

• notification:

  Map<String,String>

  Incoming push notification that comes from FirebaseMessagingService.onMessageReceived(RemoteMessage remoteMessage)

void login(String user, String password)

Parameters

• user:

  String

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

• password:

  String

  User password

void loginWithAccessToken(String user, String accessToken)

Parameters

• user:

  String

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

• accessToken:

  String

  Access token that was obtained in onLoginSuccessful callback

void loginWithOneTimeKey(String user, String hash)

Parameters

• user:

  String

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

• hash:

  String

  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.

void refreshToken(String user, String refreshToken)

Parameters

• user:

  String

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

• refreshToken:

  String

  Refresh token that was obtained in onLoginSuccessful callback

void registerForPushNotifications(String pushRegistrationToken)

Parameters

• pushRegistrationToken:

  String

  FCM registration token that can be retrieved by calling FirebaseInstanceID.getToken()

void requestOneTimeKey(String user)

Parameters

• user:

  String

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

void setClientIncomingCallListener(IClientIncomingCallListener incomingCallListener)

Parameters

• incomingCallListener:

  IClientIncomingCallListener

  IClientIncomingCallListener listener or null. If null, previously set listener will be removed.

void setClientLoginListener(IClientLoginListener loginListener)

Parameters

• loginListener:

  IClientLoginListener

  IClientLoginListener listener or null. If null, previously set listener will be removed.

void setClientSessionListener(IClientSessionListener sessionListener)

Parameters

• sessionListener:

  IClientSessionListener

  IClientSessionListener listener or null. If null, previously set listener will be removed.

void unregisterFromPushNotifications(String pushRegistrationToken)

Parameters

• pushRegistrationToken:

  String

  FCM registration token that was used to register for push notifications