114 строки
8.8 KiB
YAML
114 строки
8.8 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.chat.models.CreateChatThreadOptions"
|
|
fullName: "com.azure.communication.chat.models.CreateChatThreadOptions"
|
|
name: "CreateChatThreadOptions"
|
|
nameWithType: "CreateChatThreadOptions"
|
|
summary: "The Create<wbr>Chat<wbr>Thread<wbr>Options model."
|
|
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 **CreateChatThreadOptions**"
|
|
constructors:
|
|
- uid: "com.azure.communication.chat.models.CreateChatThreadOptions.CreateChatThreadOptions(java.lang.String)"
|
|
fullName: "com.azure.communication.chat.models.CreateChatThreadOptions.CreateChatThreadOptions(String topic)"
|
|
name: "CreateChatThreadOptions(String topic)"
|
|
nameWithType: "CreateChatThreadOptions.CreateChatThreadOptions(String topic)"
|
|
summary: "Creates a new instance of Create<wbr>Chat<wbr>Thread<wbr>Options"
|
|
parameters:
|
|
- description: "the topic value to set."
|
|
name: "topic"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CreateChatThreadOptions(String topic)"
|
|
desc: "Creates a new instance of CreateChatThreadOptions"
|
|
methods:
|
|
- uid: "com.azure.communication.chat.models.CreateChatThreadOptions.addParticipant(com.azure.communication.chat.models.ChatParticipant)"
|
|
fullName: "com.azure.communication.chat.models.CreateChatThreadOptions.addParticipant(ChatParticipant participant)"
|
|
name: "addParticipant(ChatParticipant participant)"
|
|
nameWithType: "CreateChatThreadOptions.addParticipant(ChatParticipant participant)"
|
|
summary: "Adds another participant to the list of participants to create the chat thread with"
|
|
parameters:
|
|
- description: "The participant to add"
|
|
name: "participant"
|
|
type: "<xref href=\"com.azure.communication.chat.models.ChatParticipant?alt=com.azure.communication.chat.models.ChatParticipant&text=ChatParticipant\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CreateChatThreadOptions addParticipant(ChatParticipant participant)"
|
|
desc: "Adds another participant to the list of participants to create the chat thread with"
|
|
returns:
|
|
description: "the CreateChatThreadOptions object itself"
|
|
type: "<xref href=\"com.azure.communication.chat.models.CreateChatThreadOptions?alt=com.azure.communication.chat.models.CreateChatThreadOptions&text=CreateChatThreadOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.models.CreateChatThreadOptions.getIdempotencyToken()"
|
|
fullName: "com.azure.communication.chat.models.CreateChatThreadOptions.getIdempotencyToken()"
|
|
name: "getIdempotencyToken()"
|
|
nameWithType: "CreateChatThreadOptions.getIdempotencyToken()"
|
|
summary: "Get the idempotency<wbr>Token property"
|
|
syntax: "public String getIdempotencyToken()"
|
|
desc: "Get the idempotencyToken property"
|
|
returns:
|
|
description: "the idempotencyToken."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.communication.chat.models.CreateChatThreadOptions.getParticipants()"
|
|
fullName: "com.azure.communication.chat.models.CreateChatThreadOptions.getParticipants()"
|
|
name: "getParticipants()"
|
|
nameWithType: "CreateChatThreadOptions.getParticipants()"
|
|
summary: "Get the participants property: Participants to be added to the chat thread."
|
|
syntax: "public List<ChatParticipant> getParticipants()"
|
|
desc: "Get the participants property: Participants to be added to the chat thread."
|
|
returns:
|
|
description: "the participants value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.chat.models.ChatParticipant?alt=com.azure.communication.chat.models.ChatParticipant&text=ChatParticipant\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.chat.models.CreateChatThreadOptions.getTopic()"
|
|
fullName: "com.azure.communication.chat.models.CreateChatThreadOptions.getTopic()"
|
|
name: "getTopic()"
|
|
nameWithType: "CreateChatThreadOptions.getTopic()"
|
|
summary: "Get the topic property: The chat thread topic."
|
|
syntax: "public String getTopic()"
|
|
desc: "Get the topic property: The chat thread topic."
|
|
returns:
|
|
description: "the topic value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.communication.chat.models.CreateChatThreadOptions.setIdempotencyToken(java.lang.String)"
|
|
fullName: "com.azure.communication.chat.models.CreateChatThreadOptions.setIdempotencyToken(String idempotencyToken)"
|
|
name: "setIdempotencyToken(String idempotencyToken)"
|
|
nameWithType: "CreateChatThreadOptions.setIdempotencyToken(String idempotencyToken)"
|
|
summary: "Set the idempotency<wbr>Token property: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same idempotency<wbr>Token and get back an appropriate response without the server executing the request multiple times."
|
|
parameters:
|
|
- description: "the idempotencyToken."
|
|
name: "idempotencyToken"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CreateChatThreadOptions setIdempotencyToken(String idempotencyToken)"
|
|
desc: "Set the idempotencyToken property: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same idempotencyToken and get back an appropriate response without the server executing the request multiple times. The value of the idempotencyToken is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs."
|
|
returns:
|
|
description: "the CreateChatThreadOptions object itself."
|
|
type: "<xref href=\"com.azure.communication.chat.models.CreateChatThreadOptions?alt=com.azure.communication.chat.models.CreateChatThreadOptions&text=CreateChatThreadOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.chat.models.CreateChatThreadOptions.setParticipants(java.util.List<com.azure.communication.chat.models.ChatParticipant>)"
|
|
fullName: "com.azure.communication.chat.models.CreateChatThreadOptions.setParticipants(List<ChatParticipant> participants)"
|
|
name: "setParticipants(List<ChatParticipant> participants)"
|
|
nameWithType: "CreateChatThreadOptions.setParticipants(List<ChatParticipant> participants)"
|
|
summary: "Set the participants property: Participants to be added to the chat thread."
|
|
parameters:
|
|
- description: "the participants value to set."
|
|
name: "participants"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.communication.chat.models.ChatParticipant?alt=com.azure.communication.chat.models.ChatParticipant&text=ChatParticipant\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public CreateChatThreadOptions setParticipants(List<ChatParticipant> participants)"
|
|
desc: "Set the participants property: Participants to be added to the chat thread."
|
|
returns:
|
|
description: "the CreateChatThreadOptions object itself."
|
|
type: "<xref href=\"com.azure.communication.chat.models.CreateChatThreadOptions?alt=com.azure.communication.chat.models.CreateChatThreadOptions&text=CreateChatThreadOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The CreateChatThreadOptions model."
|
|
metadata: {}
|
|
package: "com.azure.communication.chat.models"
|
|
artifact: com.azure:azure-communication-chat:1.5.4
|