71 строка
6.9 KiB
YAML
71 строка
6.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.networktraversal.CommunicationRelayClient"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClient"
|
|
name: "CommunicationRelayClient"
|
|
nameWithType: "CommunicationRelayClient"
|
|
summary: "Synchronous client interface for Communication Service Network<wbr>Traversal operations"
|
|
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 **CommunicationRelayClient**"
|
|
methods:
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClient.getRelayConfiguration()"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClient.getRelayConfiguration()"
|
|
name: "getRelayConfiguration()"
|
|
nameWithType: "CommunicationRelayClient.getRelayConfiguration()"
|
|
summary: "Gets a Relay Configuration."
|
|
syntax: "public CommunicationRelayConfiguration getRelayConfiguration()"
|
|
desc: "Gets a Relay Configuration."
|
|
returns:
|
|
description: "The obtained Communication Relay Configuration"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.models.CommunicationRelayConfiguration?alt=com.azure.communication.networktraversal.models.CommunicationRelayConfiguration&text=CommunicationRelayConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClient.getRelayConfiguration(com.azure.communication.networktraversal.models.GetRelayConfigurationOptions)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClient.getRelayConfiguration(GetRelayConfigurationOptions options)"
|
|
name: "getRelayConfiguration(GetRelayConfigurationOptions options)"
|
|
nameWithType: "CommunicationRelayClient.getRelayConfiguration(GetRelayConfigurationOptions options)"
|
|
summary: "Gets a Relay Configuration for a Communication<wbr>User<wbr>Identifier."
|
|
parameters:
|
|
- description: "of the GetRelayConfigurationOptions request"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.models.GetRelayConfigurationOptions?alt=com.azure.communication.networktraversal.models.GetRelayConfigurationOptions&text=GetRelayConfigurationOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CommunicationRelayConfiguration getRelayConfiguration(GetRelayConfigurationOptions options)"
|
|
desc: "Gets a Relay Configuration for a CommunicationUserIdentifier."
|
|
returns:
|
|
description: "The obtained Communication Relay Configuration"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.models.CommunicationRelayConfiguration?alt=com.azure.communication.networktraversal.models.CommunicationRelayConfiguration&text=CommunicationRelayConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.communication.networktraversal.CommunicationRelayClient.getRelayConfigurationWithResponse(com.azure.communication.networktraversal.models.GetRelayConfigurationOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.communication.networktraversal.CommunicationRelayClient.getRelayConfigurationWithResponse(GetRelayConfigurationOptions options, Context context)"
|
|
name: "getRelayConfigurationWithResponse(GetRelayConfigurationOptions options, Context context)"
|
|
nameWithType: "CommunicationRelayClient.getRelayConfigurationWithResponse(GetRelayConfigurationOptions options, Context context)"
|
|
summary: "Gets a Relay Configuration with response."
|
|
parameters:
|
|
- description: "of the GetRelayConfigurationOptions request"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.communication.networktraversal.models.GetRelayConfigurationOptions?alt=com.azure.communication.networktraversal.models.GetRelayConfigurationOptions&text=GetRelayConfigurationOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "A <xref uid=\"com.azure.core.util.Context\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Context\"></xref> representing the request context."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<CommunicationRelayConfiguration> getRelayConfigurationWithResponse(GetRelayConfigurationOptions options, Context context)"
|
|
desc: "Gets a Relay Configuration with response."
|
|
returns:
|
|
description: "The obtained Communication Relay Configuration"
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.networktraversal.models.CommunicationRelayConfiguration?alt=com.azure.communication.networktraversal.models.CommunicationRelayConfiguration&text=CommunicationRelayConfiguration\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Synchronous client interface for Communication Service NetworkTraversal operations\n\n**Instantiating a synchronous CommunicationRelayClient**\n\n```java\n// You can find your endpoint and access key from your resource in the Azure Portal\n String endpoint = \"https://<RESOURCE_NAME>.communication.azure.com\";\n AzureKeyCredential keyCredential = new AzureKeyCredential(\"<access-key>\");\n\n CommunicationRelayClient communicationRelayClient = new CommunicationRelayClientBuilder()\n .endpoint(endpoint)\n .credential(keyCredential)\n .buildClient();\n```\n\nView <xref uid=\"com.azure.communication.networktraversal.CommunicationRelayClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"this\"></xref> for additional ways to construct the client."
|
|
metadata: {}
|
|
package: "com.azure.communication.networktraversal"
|
|
artifact: com.azure:azure-communication-networktraversal:1.1.0
|