CallInvite Class

Package:

com.azure.communication.callautomation.models

Maven Artifact:

com.azure:azure-communication-callautomation:1.6.1

• java.lang.Object
• • com.azure.communication.callautomation.models.CallInvite

public final class CallInvite

Call invite details.

Constructor Summary

Constructor	Description
CallInvite(CommunicationUserIdentifier targetIdentity)	Create a CallInvite object with CommunicationUserIdentifier
CallInvite(MicrosoftTeamsAppIdentifier targetIdentity)	Create a CallInvite object with MicrosoftTeamsAppIdentifier
CallInvite(MicrosoftTeamsUserIdentifier targetIdentity)	Create a CallInvite object with MicrosoftTeamsUserIdentifier
CallInvite(PhoneNumberIdentifier targetIdentity, PhoneNumberIdentifier callerIdNumber)	Create a CallInvite object with PhoneNumberIdentifier When the source of the call is a Teams App source, callerIdNumber is not supported and should be null.
CallInvite(TeamsExtensionUserIdentifier targetIdentity)	Create a CallInvite object with TeamsExtensionUserIdentifier

Method Summary

Modifier and Type	Method and Description
CustomCallingContext	getCustomCallingContext() get custom calling context
PhoneNumberIdentifier	getSourceCallerIdNumber() get PhoneNumberIdentifier for PSTN caller
String	getSourceDisplayName() get caller's display name
CommunicationIdentifier	getTargetParticipant() Get target's CommunicationIdentifier
CallInvite	setSourceCallerIdNumber(PhoneNumberIdentifier sourceCallerIdNumber) set PhoneNumberIdentifier for PSTN caller
CallInvite	setSourceDisplayName(String sourceDisplayName) set display name for caller

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CallInvite

public CallInvite(CommunicationUserIdentifier targetIdentity)

Create a CallInvite object with CommunicationUserIdentifier

Parameters:

targetIdentity - Target's CommunicationUserIdentifier

CallInvite

public CallInvite(MicrosoftTeamsAppIdentifier targetIdentity)

Create a CallInvite object with MicrosoftTeamsAppIdentifier

Parameters:

targetIdentity - Target's MicrosoftTeamsAppIdentifier

CallInvite

public CallInvite(MicrosoftTeamsUserIdentifier targetIdentity)

Create a CallInvite object with MicrosoftTeamsUserIdentifier

Parameters:

targetIdentity - Target's MicrosoftTeamsUserIdentifier

CallInvite

public CallInvite(PhoneNumberIdentifier targetIdentity, PhoneNumberIdentifier callerIdNumber)

Create a CallInvite object with PhoneNumberIdentifier When the source of the call is a Teams App source, callerIdNumber is not supported and should be null.

Parameters:

targetIdentity - Target's PhoneNumberIdentifier

callerIdNumber - Caller's phone number identifier

CallInvite

public CallInvite(TeamsExtensionUserIdentifier targetIdentity)

Create a CallInvite object with TeamsExtensionUserIdentifier

Parameters:

targetIdentity - Target's TeamsExtensionUserIdentifier

Method Details

getCustomCallingContext

public CustomCallingContext getCustomCallingContext()

get custom calling context

Returns:

custom calling context

getSourceCallerIdNumber

public PhoneNumberIdentifier getSourceCallerIdNumber()

get PhoneNumberIdentifier for PSTN caller

Returns:

PhoneNumberIdentifier for PSTN caller

getSourceDisplayName

public String getSourceDisplayName()

get caller's display name

Returns:

display name for caller

getTargetParticipant

public CommunicationIdentifier getTargetParticipant()

Get target's CommunicationIdentifier

Returns:

target's CommunicationIdentifier

setSourceCallerIdNumber

public CallInvite setSourceCallerIdNumber(PhoneNumberIdentifier sourceCallerIdNumber)

set PhoneNumberIdentifier for PSTN caller

Parameters:

sourceCallerIdNumber - PhoneNumberIdentifier for PSTN caller

Returns:

the CallInvite object itself

setSourceDisplayName

public CallInvite setSourceDisplayName(String sourceDisplayName)

set display name for caller

Parameters:

sourceDisplayName - display name for caller

Returns:

the CallInvite object itself