CommunicationRelayClient.GetRelayConfiguration Method

Definition

Namespace:

Azure.Communication.NetworkTraversal

Assembly:

Azure.Communication.NetworkTraversal.dll

Package:

Azure.Communication.NetworkTraversal v1.0.0

Source:

CommunicationRelayClient.cs

Gets a Relay Configuration for a CommunicationUserIdentifier.

public virtual Azure.Response<Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration> GetRelayConfiguration (Azure.Communication.CommunicationUserIdentifier communicationUser = default, Azure.Communication.NetworkTraversal.RouteType? routeType = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetRelayConfiguration : Azure.Communication.CommunicationUserIdentifier * Nullable<Azure.Communication.NetworkTraversal.RouteType> * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration>
override this.GetRelayConfiguration : Azure.Communication.CommunicationUserIdentifier * Nullable<Azure.Communication.NetworkTraversal.RouteType> * System.Threading.CancellationToken -> Azure.Response<Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration>

Public Overridable Function GetRelayConfiguration (Optional communicationUser As CommunicationUserIdentifier = Nothing, Optional routeType As Nullable(Of RouteType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CommunicationRelayConfiguration)

Parameters

communicationUser

CommunicationUserIdentifier

The CommunicationUserIdentifier for whom to issue a token.

routeType

Nullable<RouteType>

The specified RouteType for the relay request

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<CommunicationRelayConfiguration>

Exceptions

RequestFailedException

The server returned an error.