com.sinch.android.rtc

Interface SinchClientBuilder

public interface SinchClientBuilder

The SinchClientBuilder class builds a new SinchClient instance. To construct a SinchClient, the required configuration parameters are: - Application Key - Environment host - UserID It is optional to specify: - CLI (Calling-Line Identifier / Caller-ID) that will be used for calls terminated to PSTN (Publicly Switched Telephone Network). - hmsDeviceToken & hmsApplicationId if Huawei Push is to be used.

Method Summary

Modifier and Type	Method and Description
SinchClientBuilder	applicationKey(java.lang.String applicationKey) Sets the application key associated with the SinchClient.
SinchClient	build() Creates the resulting SinchClient.
SinchClientBuilder	callerIdentifier(java.lang.String callerIdentifier) Sets the caller identifier used when calling with PSTN.
SinchClientBuilder	context(android.content.Context context) Sets the context associated with the SinchClient.
SinchClientBuilder	enableMediaHandover(boolean enableMediaHandover) Enables and disables media handover functionality.
SinchClientBuilder	enableVideoCalls(boolean enableVideoCalls) Disables initialization of video calls if they are not needed.
SinchClientBuilder	environmentHost(java.lang.String environmentHost) Sets the environment host associated with the SinchClient.
SinchClientBuilder	hmsApplicationId(java.lang.String applicationId) Sets the HMS Application Id if the Huawei Push is to be used.
SinchClientBuilder	hmsDeviceToken(java.lang.String deviceToken) Sets the HMS Device Token if the Huawei Push is to be used.
SinchClientBuilder	userId(java.lang.String userId) Sets the user id associated with the SinchClient.

Method Detail

context

SinchClientBuilder context(android.content.Context context)

Sets the context associated with the SinchClient.

Parameters:

context - Must not be null.

Returns:

The SinchClientBuilder instance

userId

SinchClientBuilder userId(java.lang.String userId)

Sets the user id associated with the SinchClient.

Parameters:

userId - Must not be null.

Returns:

The SinchClientBuilder instance.

applicationKey

SinchClientBuilder applicationKey(java.lang.String applicationKey)

Sets the application key associated with the SinchClient.

Parameters:

applicationKey - Must not be null.

Returns:

The SinchClientBuilder instance.

environmentHost

SinchClientBuilder environmentHost(java.lang.String environmentHost)

Sets the environment host associated with the SinchClient.

Parameters:

environmentHost - Must not be null.

Returns:

The SinchClientBuilder instance.

callerIdentifier

SinchClientBuilder callerIdentifier(java.lang.String callerIdentifier)

Sets the caller identifier used when calling with PSTN.

Parameters:

callerIdentifier - Optional. Must not be null.

Returns:

The SinchClientBuilder instance.

enableVideoCalls

SinchClientBuilder enableVideoCalls(boolean enableVideoCalls)

Disables initialization of video calls if they are not needed. In case of Audio calls only, setting this value to 'false' allows apk work w/o requesting CAMERA permissions.

Parameters:

enableVideoCalls - Optional. Default value is 'true'

Returns:

The SinchClientBuilder instance.

enableMediaHandover

SinchClientBuilder enableMediaHandover(boolean enableMediaHandover)

Enables and disables media handover functionality. When media handover is enabled, call started on WiFi network will continue after WiFi is lost if cellular connectivity is available. Set to false to prevent it to happen, say, if WiFi-only calls are desired. NB: when disabled, it still allows call to be started on cellular, so it is the client's responsibility to control the start of the call.

Parameters:

enableMediaHandover - equal to false disables media handover from WiFi to cellular when WiFi is lost.

Returns:

The SinchClientBuilder instance.

hmsDeviceToken

SinchClientBuilder hmsDeviceToken(java.lang.String deviceToken)

Sets the HMS Device Token if the Huawei Push is to be used.

Parameters:

deviceToken - Must not be null.

Returns:

The SinchClientBuilder instance.

hmsApplicationId

SinchClientBuilder hmsApplicationId(java.lang.String applicationId)

Sets the HMS Application Id if the Huawei Push is to be used.

Parameters:

applicationId - Must not be null.

Returns:

The SinchClientBuilder instance.

build

SinchClient build()

Creates the resulting SinchClient.

Returns:

A new SinchClient instance.