Interface CallController
-
- All Implemented Interfaces:
public interface CallControllerCallController provides the entry point to the calling functionality of the Sinch SDK.
-
-
Method Summary
Modifier and Type Method Description abstract UnitaddCallControllerListener(CallControllerListener callControllerListener)The CallControllerListener object that will be notified of new incoming calls. abstract UnitremoveCallControllerListener(CallControllerListener callControllerListener)Removes listener for incoming call events. abstract CallcallUser(String userId, MediaConstraints mediaConstraints)Makes a call to the user with the given id. abstract CallcallUser(String userId, MediaConstraints mediaConstraints, Map<String, String> callHeaders)Makes a call to the user with the given id. abstract CallcallPhoneNumber(String phoneNumber, String cli)Calls a phone number and terminates the call to the PSTN-network (Publicly Switched Telephone Network). abstract CallcallPhoneNumber(String phoneNumber, String cli, Map<String, String> callHeaders)Calls a phone number and terminates the call to the PSTN-network (Publicly Switched Telephone Network). abstract CallcallSip(String sipUri)Makes a SIP call to the user with the given sip uri. abstract CallcallSip(String sipUri, Map<String, String> callHeaders)Makes a SIP call to the user with the given sip uri. abstract CallcallSip(String sipUri, String cli)Makes a SIP call to the user with the given sip uri. abstract CallcallSip(String sipUri, String cli, Map<String, String> callHeaders)Makes a SIP call to the user with the given sip uri. abstract CallcallConference(String conferenceId)Calls the conference with the given id. abstract CallcallConference(String conferenceId, String cli)Calls the conference with the given id. abstract CallcallConference(String conferenceId, Map<String, String> callHeaders)Calls the conference with the given id. abstract CallcallConference(String conferenceId, String cli, Map<String, String> callHeaders)Calls the conference with the given id. abstract UnitsetRespectNativeCalls(Boolean respectNativeCalls)Set whether or not the client should respect native calls. abstract UnitsetRespectNativeCalls(Boolean onIncomingSinchCall, Boolean duringSinchCall)Set whether or not the client should respect native (GSM) calls. abstract UnitsetRespectVoIPCalls(Boolean onIncomingSinchCall, Boolean duringSinchCall)Set whether or not the client should respect other VoIP calls (eg. abstract CallgetCall(String callId)Returns the Call object with the given callId. abstract UnitsetWebRtcCallConfiguration(WebRtcCallConfiguration webRtcCallConfiguration)Sets the WebRTC configuration for every call created by this CallController. -
-
Method Detail
-
addCallControllerListener
abstract Unit addCallControllerListener(CallControllerListener callControllerListener)
The CallControllerListener object that will be notified of new incoming calls.
- Parameters:
callControllerListener- A CallControllerListener to be added.
-
removeCallControllerListener
abstract Unit removeCallControllerListener(CallControllerListener callControllerListener)
Removes listener for incoming call events. If listener was not added before method is no-op.
- Parameters:
callControllerListener- A CallControllerListener to be removed.
-
callUser
abstract Call callUser(String userId, MediaConstraints mediaConstraints)
Makes a call to the user with the given id.
- Parameters:
userId- The app specific id of the user to call.mediaConstraints- Media constraints for given user call.
-
callUser
abstract Call callUser(String userId, MediaConstraints mediaConstraints, Map<String, String> callHeaders)
Makes a call to the user with the given id.
- Parameters:
userId- The app specific id of the user to call.mediaConstraints- Media constraints for given user call.callHeaders- Headers to pass with the call.
-
callPhoneNumber
abstract Call callPhoneNumber(String phoneNumber, String cli)
Calls a phone number and terminates the call to the PSTN-network (Publicly Switched Telephone Network).
- Parameters:
phoneNumber- The phone number to call.cli- Identifier of the caller.
-
callPhoneNumber
abstract Call callPhoneNumber(String phoneNumber, String cli, Map<String, String> callHeaders)
Calls a phone number and terminates the call to the PSTN-network (Publicly Switched Telephone Network).
- Parameters:
phoneNumber- The phone number to call.cli- Identifier of the caller.callHeaders- Headers to pass with the call.
-
callSip
abstract Call callSip(String sipUri)
Makes a SIP call to the user with the given sip uri. The identity should be in the form "user@server".
- Parameters:
sipUri- SIP URI to dial in to.
-
callSip
abstract Call callSip(String sipUri, Map<String, String> callHeaders)
Makes a SIP call to the user with the given sip uri. The identity should be in the form "user@server".
- Parameters:
sipUri- SIP URI to dial in to.callHeaders- Headers to pass with the call.
-
callSip
abstract Call callSip(String sipUri, String cli)
Makes a SIP call to the user with the given sip uri. The identity should be in the form "user@server".
- Parameters:
sipUri- SIP URI to dial in to.cli- Identifier of the caller.
-
callSip
abstract Call callSip(String sipUri, String cli, Map<String, String> callHeaders)
Makes a SIP call to the user with the given sip uri. The identity should be in the form "user@server".
- Parameters:
sipUri- SIP URI to dial in to.cli- Identifier of the caller.callHeaders- Headers to pass with the call.
-
callConference
abstract Call callConference(String conferenceId)
Calls the conference with the given id.
- Parameters:
conferenceId- Conference ID to dial in to.
-
callConference
abstract Call callConference(String conferenceId, String cli)
Calls the conference with the given id.
- Parameters:
conferenceId- Conference ID to dial in to.cli- Identifier of the caller.
-
callConference
abstract Call callConference(String conferenceId, Map<String, String> callHeaders)
Calls the conference with the given id.
- Parameters:
conferenceId- Conference ID to dial in to.callHeaders- Headers to pass with the call.
-
callConference
abstract Call callConference(String conferenceId, String cli, Map<String, String> callHeaders)
Calls the conference with the given id.
- Parameters:
conferenceId- Conference ID to dial in to.cli- Identifier of the caller.callHeaders- Headers to pass with the call.
-
setRespectNativeCalls
@Deprecated(message = "Use setRespectNativeCalls(onIncomingSinchCall: Boolean, duringSinchCall: Boolean) instead", replaceWith = @ReplaceWith(imports = {}, expression = "setRespectNativeCalls(onIncomingSinchCall: Boolean, duringSinchCall: Boolean)")) abstract Unit setRespectNativeCalls(Boolean respectNativeCalls)
Set whether or not the client should respect native calls. If this is set to true, answering native calls will hangup any ongoing Sinch calls. Also, if in a native calls, incoming Sinch calls will be denied automatically. If set to true, the app requires permissions android.permission.READ_PHONE_STATE.
-
setRespectNativeCalls
abstract Unit setRespectNativeCalls(Boolean onIncomingSinchCall, Boolean duringSinchCall)
Set whether or not the client should respect native (GSM) calls.
- Parameters:
onIncomingSinchCall- Whether or not the client should respect native calls on incoming Sinch call.duringSinchCall- Whether or not the client should respect native (GSM) calls during ongoing Sinch call.
-
setRespectVoIPCalls
abstract Unit setRespectVoIPCalls(Boolean onIncomingSinchCall, Boolean duringSinchCall)
Set whether or not the client should respect other VoIP calls (eg. WhatsAPP, Messenger).
- Parameters:
onIncomingSinchCall- Whether or not the client should respect other VoIP calls on incoming Sinch call.duringSinchCall- Whether or not the client should respect other VoIP calls during ongoing Sinch call.
-
getCall
abstract Call getCall(String callId)
Returns the Call object with the given callId.
- Parameters:
callId- The call identifier string.
-
setWebRtcCallConfiguration
abstract Unit setWebRtcCallConfiguration(WebRtcCallConfiguration webRtcCallConfiguration)
Sets the WebRTC configuration for every call created by this CallController. For this method to have effect, it must be called before initiating any outgoing call or relying the push payload.
- Parameters:
webRtcCallConfiguration- configuration to be used.
-
-
-
-