azure-docs-sdk-java/docs-ref-autogen/com.azure.communication.cal...

161 строка
12 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions"
name: "CreateGroupCallOptions"
nameWithType: "CreateGroupCallOptions"
summary: "The options for creating a group call."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **CreateGroupCallOptions**"
constructors:
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.CreateGroupCallOptions(java.util.List<com.azure.communication.common.CommunicationIdentifier>,java.lang.String)"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.CreateGroupCallOptions(List<CommunicationIdentifier> targetParticipants, String callbackUrl)"
name: "CreateGroupCallOptions(List<CommunicationIdentifier> targetParticipants, String callbackUrl)"
nameWithType: "CreateGroupCallOptions.CreateGroupCallOptions(List<CommunicationIdentifier> targetParticipants, String callbackUrl)"
summary: "Constructor"
parameters:
- description: "The targets of the call."
name: "targetParticipants"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />&gt;"
- description: "The call back URI."
name: "callbackUrl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CreateGroupCallOptions(List<CommunicationIdentifier> targetParticipants, String callbackUrl)"
desc: "Constructor"
methods:
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getCallIntelligenceOptions()"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getCallIntelligenceOptions()"
name: "getCallIntelligenceOptions()"
nameWithType: "CreateGroupCallOptions.getCallIntelligenceOptions()"
summary: "Get the Call<wbr>Intelligence<wbr>Options property: AI options for the call such as cognitive<wbr>Services<wbr>Endpoint"
syntax: "public CallIntelligenceOptions getCallIntelligenceOptions()"
desc: "Get the CallIntelligenceOptions property: AI options for the call such as cognitiveServicesEndpoint"
returns:
description: "the callIntelligenceOptions value."
type: "<xref href=\"com.azure.communication.callautomation.models.CallIntelligenceOptions?alt=com.azure.communication.callautomation.models.CallIntelligenceOptions&text=CallIntelligenceOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getCallbackUrl()"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getCallbackUrl()"
name: "getCallbackUrl()"
nameWithType: "CreateGroupCallOptions.getCallbackUrl()"
summary: "Get the call back uri."
syntax: "public String getCallbackUrl()"
desc: "Get the call back uri."
returns:
description: "the call back uri."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getOperationContext()"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getOperationContext()"
name: "getOperationContext()"
nameWithType: "CreateGroupCallOptions.getOperationContext()"
summary: "Get the operation<wbr>Context: A customer set value used to track the answering of a call."
syntax: "public String getOperationContext()"
desc: "Get the operationContext: A customer set value used to track the answering of a call."
returns:
description: "the operationContext value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getSourceCallIdNumber()"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getSourceCallIdNumber()"
name: "getSourceCallIdNumber()"
nameWithType: "CreateGroupCallOptions.getSourceCallIdNumber()"
summary: "get Phone<wbr>Number<wbr>Identifier for PSTN caller"
syntax: "public PhoneNumberIdentifier getSourceCallIdNumber()"
desc: "get PhoneNumberIdentifier for PSTN caller"
returns:
description: "PhoneNumberIdentifier for PSTN caller"
type: "<xref href=\"com.azure.communication.common.PhoneNumberIdentifier?alt=com.azure.communication.common.PhoneNumberIdentifier&text=PhoneNumberIdentifier\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getSourceDisplayName()"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getSourceDisplayName()"
name: "getSourceDisplayName()"
nameWithType: "CreateGroupCallOptions.getSourceDisplayName()"
summary: "get caller's display name"
syntax: "public String getSourceDisplayName()"
desc: "get caller's display name"
returns:
description: "display name for caller"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getTargetParticipants()"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.getTargetParticipants()"
name: "getTargetParticipants()"
nameWithType: "CreateGroupCallOptions.getTargetParticipants()"
summary: "Get the targets."
syntax: "public List<CommunicationIdentifier> getTargetParticipants()"
desc: "Get the targets."
returns:
description: "the targets list."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a>&lt;<xref href=\"com.azure.communication.common.CommunicationIdentifier?alt=com.azure.communication.common.CommunicationIdentifier&text=CommunicationIdentifier\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.setCallIntelligenceOptions(com.azure.communication.callautomation.models.CallIntelligenceOptions)"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.setCallIntelligenceOptions(CallIntelligenceOptions callIntelligenceOptions)"
name: "setCallIntelligenceOptions(CallIntelligenceOptions callIntelligenceOptions)"
nameWithType: "CreateGroupCallOptions.setCallIntelligenceOptions(CallIntelligenceOptions callIntelligenceOptions)"
summary: "Set the Call<wbr>Intelligence<wbr>Options property: AI options for the call such as cognitive<wbr>Services<wbr>Endpoint"
parameters:
- description: "the cognitiveServicesEndpoint value to set."
name: "callIntelligenceOptions"
type: "<xref href=\"com.azure.communication.callautomation.models.CallIntelligenceOptions?alt=com.azure.communication.callautomation.models.CallIntelligenceOptions&text=CallIntelligenceOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CreateGroupCallOptions setCallIntelligenceOptions(CallIntelligenceOptions callIntelligenceOptions)"
desc: "Set the CallIntelligenceOptions property: AI options for the call such as cognitiveServicesEndpoint"
returns:
description: "the CreateGroupCallOptions object itself."
type: "<xref href=\"com.azure.communication.callautomation.models.CreateGroupCallOptions?alt=com.azure.communication.callautomation.models.CreateGroupCallOptions&text=CreateGroupCallOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.setOperationContext(java.lang.String)"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.setOperationContext(String operationContext)"
name: "setOperationContext(String operationContext)"
nameWithType: "CreateGroupCallOptions.setOperationContext(String operationContext)"
summary: "Set the operation<wbr>Context: A customer set value used to track the answering of a call."
parameters:
- description: "A customer set value used to track the answering of a call."
name: "operationContext"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CreateGroupCallOptions setOperationContext(String operationContext)"
desc: "Set the operationContext: A customer set value used to track the answering of a call."
returns:
description: "the CreateCallOptions object itself."
type: "<xref href=\"com.azure.communication.callautomation.models.CreateGroupCallOptions?alt=com.azure.communication.callautomation.models.CreateGroupCallOptions&text=CreateGroupCallOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.setSourceCallIdNumber(com.azure.communication.common.PhoneNumberIdentifier)"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.setSourceCallIdNumber(PhoneNumberIdentifier sourceCallIdNumber)"
name: "setSourceCallIdNumber(PhoneNumberIdentifier sourceCallIdNumber)"
nameWithType: "CreateGroupCallOptions.setSourceCallIdNumber(PhoneNumberIdentifier sourceCallIdNumber)"
summary: "set Phone<wbr>Number<wbr>Identifier for PSTN caller"
parameters:
- description: "PhoneNumberIdentifier for PSTN caller"
name: "sourceCallIdNumber"
type: "<xref href=\"com.azure.communication.common.PhoneNumberIdentifier?alt=com.azure.communication.common.PhoneNumberIdentifier&text=PhoneNumberIdentifier\" data-throw-if-not-resolved=\"False\" />"
syntax: "public CreateGroupCallOptions setSourceCallIdNumber(PhoneNumberIdentifier sourceCallIdNumber)"
desc: "set PhoneNumberIdentifier for PSTN caller"
returns:
description: "the CreateGroupCallOptions object itself"
type: "<xref href=\"com.azure.communication.callautomation.models.CreateGroupCallOptions?alt=com.azure.communication.callautomation.models.CreateGroupCallOptions&text=CreateGroupCallOptions\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.callautomation.models.CreateGroupCallOptions.setSourceDisplayName(java.lang.String)"
fullName: "com.azure.communication.callautomation.models.CreateGroupCallOptions.setSourceDisplayName(String sourceDisplayName)"
name: "setSourceDisplayName(String sourceDisplayName)"
nameWithType: "CreateGroupCallOptions.setSourceDisplayName(String sourceDisplayName)"
summary: "set display name for caller"
parameters:
- description: "display name for caller"
name: "sourceDisplayName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public CreateGroupCallOptions setSourceDisplayName(String sourceDisplayName)"
desc: "set display name for caller"
returns:
description: "the CreateGroupCallOptions object itself"
type: "<xref href=\"com.azure.communication.callautomation.models.CreateGroupCallOptions?alt=com.azure.communication.callautomation.models.CreateGroupCallOptions&text=CreateGroupCallOptions\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The options for creating a group call."
metadata: {}
package: "com.azure.communication.callautomation.models"
artifact: com.azure:azure-communication-callautomation:1.2.6