-
Notifications
You must be signed in to change notification settings - Fork 255
/
CommunicationRelayClient.xml
187 lines (187 loc) · 17.8 KB
/
CommunicationRelayClient.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<Type Name="CommunicationRelayClient" FullName="Azure.Communication.NetworkTraversal.CommunicationRelayClient">
<TypeSignature Language="C#" Value="public class CommunicationRelayClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit CommunicationRelayClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Communication.NetworkTraversal.CommunicationRelayClient" />
<TypeSignature Language="VB.NET" Value="Public Class CommunicationRelayClient" />
<TypeSignature Language="F#" Value="type CommunicationRelayClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.Communication.NetworkTraversal</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The Azure Communication Services Networking client.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CommunicationRelayClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.NetworkTraversal.CommunicationRelayClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.NetworkTraversal</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of <see cref="T:Azure.Communication.NetworkTraversal.CommunicationRelayClient" /> for mocking.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CommunicationRelayClient (string connectionString);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.NetworkTraversal.CommunicationRelayClient.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String)" />
<MemberSignature Language="F#" Value="new Azure.Communication.NetworkTraversal.CommunicationRelayClient : string -> Azure.Communication.NetworkTraversal.CommunicationRelayClient" Usage="new Azure.Communication.NetworkTraversal.CommunicationRelayClient connectionString" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.NetworkTraversal</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
</Parameters>
<Docs>
<param name="connectionString"> Connection string acquired from the Azure Communication Services resource. </param>
<summary> Initializes a new instance of <see cref="T:Azure.Communication.NetworkTraversal.CommunicationRelayClient" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CommunicationRelayClient (string connectionString, Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string connectionString, class Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.NetworkTraversal.CommunicationRelayClient.#ctor(System.String,Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (connectionString As String, options As CommunicationRelayClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Communication.NetworkTraversal.CommunicationRelayClient : string * Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions -> Azure.Communication.NetworkTraversal.CommunicationRelayClient" Usage="new Azure.Communication.NetworkTraversal.CommunicationRelayClient (connectionString, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.NetworkTraversal</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="connectionString" Type="System.String" />
<Parameter Name="options" Type="Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions" />
</Parameters>
<Docs>
<param name="connectionString"> Connection string acquired from the Azure Communication Services resource. </param>
<param name="options"> Client option exposing <see cref="P:Azure.Core.ClientOptions.Diagnostics" />, <see cref="P:Azure.Core.ClientOptions.Retry" />, <see cref="P:Azure.Core.ClientOptions.Transport" />, etc.</param>
<summary> Initializes a new instance of <see cref="T:Azure.Communication.NetworkTraversal.CommunicationRelayClient" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CommunicationRelayClient (Uri endpoint, Azure.AzureKeyCredential keyCredential, Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential keyCredential, class Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.NetworkTraversal.CommunicationRelayClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, keyCredential As AzureKeyCredential, Optional options As CommunicationRelayClientOptions = Nothing)" />
<MemberSignature Language="F#" Value="new Azure.Communication.NetworkTraversal.CommunicationRelayClient : Uri * Azure.AzureKeyCredential * Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions -> Azure.Communication.NetworkTraversal.CommunicationRelayClient" Usage="new Azure.Communication.NetworkTraversal.CommunicationRelayClient (endpoint, keyCredential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.NetworkTraversal</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="keyCredential" Type="Azure.AzureKeyCredential" />
<Parameter Name="options" Type="Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> The URI of the Azure Communication Services resource. </param>
<param name="keyCredential"> The <see cref="T:Azure.AzureKeyCredential" /> used to authenticate requests. </param>
<param name="options"> Client option exposing <see cref="P:Azure.Core.ClientOptions.Diagnostics" />, <see cref="P:Azure.Core.ClientOptions.Retry" />, <see cref="P:Azure.Core.ClientOptions.Transport" />, etc.</param>
<summary> Initializes a new instance of <see cref="T:Azure.Communication.NetworkTraversal.CommunicationRelayClient" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CommunicationRelayClient (Uri endpoint, Azure.Core.TokenCredential tokenCredential, Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions options = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential tokenCredential, class Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.NetworkTraversal.CommunicationRelayClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, tokenCredential As TokenCredential, Optional options As CommunicationRelayClientOptions = Nothing)" />
<MemberSignature Language="F#" Value="new Azure.Communication.NetworkTraversal.CommunicationRelayClient : Uri * Azure.Core.TokenCredential * Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions -> Azure.Communication.NetworkTraversal.CommunicationRelayClient" Usage="new Azure.Communication.NetworkTraversal.CommunicationRelayClient (endpoint, tokenCredential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.NetworkTraversal</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="tokenCredential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.Communication.NetworkTraversal.CommunicationRelayClientOptions" />
</Parameters>
<Docs>
<param name="endpoint"> The URI of the Azure Communication Services resource. </param>
<param name="tokenCredential"> The <see cref="T:Azure.Core.TokenCredential" /> used to authenticate requests, such as DefaultAzureCredential. </param>
<param name="options">Client option exposing <see cref="P:Azure.Core.ClientOptions.Diagnostics" />, <see cref="P:Azure.Core.ClientOptions.Retry" />, <see cref="P:Azure.Core.ClientOptions.Transport" />, etc.</param>
<summary> Initializes a new instance of <see cref="T:Azure.Communication.NetworkTraversal.CommunicationRelayClient" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetRelayConfiguration">
<MemberSignature Language="C#" Value="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);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration> GetRelayConfiguration(class Azure.Communication.CommunicationUserIdentifier communicationUser, valuetype System.Nullable`1<valuetype Azure.Communication.NetworkTraversal.RouteType> routeType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.NetworkTraversal.CommunicationRelayClient.GetRelayConfiguration(Azure.Communication.CommunicationUserIdentifier,System.Nullable{Azure.Communication.NetworkTraversal.RouteType},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="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)" />
<MemberSignature Language="F#" Value="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>" Usage="communicationRelayClient.GetRelayConfiguration (communicationUser, routeType, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.NetworkTraversal</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="communicationUser" Type="Azure.Communication.CommunicationUserIdentifier" />
<Parameter Name="routeType" Type="System.Nullable<Azure.Communication.NetworkTraversal.RouteType>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="communicationUser">The <see cref="T:Azure.Communication.CommunicationUserIdentifier" /> for whom to issue a token.</param>
<param name="routeType"> The specified <see cref="T:Azure.Communication.NetworkTraversal.RouteType" /> for the relay request </param>
<param name="cancellationToken">The cancellation token to use.</param>
<summary>Gets a Relay Configuration for a <see cref="T:Azure.Communication.CommunicationUserIdentifier" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:Azure.RequestFailedException">The server returned an error.</exception>
</Docs>
</Member>
<Member MemberName="GetRelayConfigurationAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration>> GetRelayConfigurationAsync (Azure.Communication.CommunicationUserIdentifier communicationUser = default, Azure.Communication.NetworkTraversal.RouteType? routeType = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration>> GetRelayConfigurationAsync(class Azure.Communication.CommunicationUserIdentifier communicationUser, valuetype System.Nullable`1<valuetype Azure.Communication.NetworkTraversal.RouteType> routeType, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Communication.NetworkTraversal.CommunicationRelayClient.GetRelayConfigurationAsync(Azure.Communication.CommunicationUserIdentifier,System.Nullable{Azure.Communication.NetworkTraversal.RouteType},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetRelayConfigurationAsync (Optional communicationUser As CommunicationUserIdentifier = Nothing, Optional routeType As Nullable(Of RouteType) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of CommunicationRelayConfiguration))" />
<MemberSignature Language="F#" Value="abstract member GetRelayConfigurationAsync : Azure.Communication.CommunicationUserIdentifier * Nullable<Azure.Communication.NetworkTraversal.RouteType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration>>
override this.GetRelayConfigurationAsync : Azure.Communication.CommunicationUserIdentifier * Nullable<Azure.Communication.NetworkTraversal.RouteType> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration>>" Usage="communicationRelayClient.GetRelayConfigurationAsync (communicationUser, routeType, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Communication.NetworkTraversal</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Communication.NetworkTraversal.CommunicationRelayConfiguration>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="communicationUser" Type="Azure.Communication.CommunicationUserIdentifier" />
<Parameter Name="routeType" Type="System.Nullable<Azure.Communication.NetworkTraversal.RouteType>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="communicationUser">The <see cref="T:Azure.Communication.CommunicationUserIdentifier" /> for whom to issue a token.</param>
<param name="routeType"> The specified <see cref="T:Azure.Communication.NetworkTraversal.RouteType" /> for the relay request </param>
<param name="cancellationToken">The cancellation token to use.</param>
<summary>Asynchronously gets a Relay Configuration for a <see cref="T:Azure.Communication.CommunicationUserIdentifier" />.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>