Skip to content

Commit b04bd78

Browse files
AriZavala2AriZavala2
committed
Update PR
1 parent e20ca57 commit b04bd78

File tree

8 files changed

+22
-53
lines changed

8 files changed

+22
-53
lines changed

‎sdk/communication/Azure.Communication.NetworkTraversal/README.md‎

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -68,25 +68,6 @@ We guarantee that all client instance methods are thread-safe and independent of
6868
## Getting a Relay Configuration for a user
6969

7070
```C# Snippet:GetRelayConfigurationAsync
71-
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions(user));
72-
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
73-
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
74-
Console.WriteLine($"Expires On: {turnTokenExpiresOn}");
75-
foreach (CommunicationIceServer iceServer in iceServers)
76-
{
77-
foreach (string url in iceServer.Urls)
78-
{
79-
Console.WriteLine($"ICE Server Url: {url}");
80-
}
81-
Console.WriteLine($"ICE Server Username: {iceServer.Username}");
82-
Console.WriteLine($"ICE Server Credential: {iceServer.Credential}");
83-
Console.WriteLine($"Route type: {iceServer.RouteType}");
84-
}
85-
```
86-
87-
## Getting a Relay Configuration for a user without identity async
88-
89-
```C# Snippet:GetRelayConfigurationAsyncWithoutIdentity
9071
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync();
9172
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
9273
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
@@ -99,6 +80,7 @@ foreach (CommunicationIceServer iceServer in iceServers)
9980
}
10081
Console.WriteLine($"ICE Server Username: {iceServer.Username}");
10182
Console.WriteLine($"ICE Server Credential: {iceServer.Credential}");
83+
Console.WriteLine($"ICE Server RouteType: {iceServer.RouteType}");
10284
}
10385
```
10486

‎sdk/communication/Azure.Communication.NetworkTraversal/api/Azure.Communication.NetworkTraversal.netstandard2.0.cs‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ namespace Azure.Communication.NetworkTraversal.Models
6363
public partial class GetRelayConfigurationOptions
6464
{
6565
public GetRelayConfigurationOptions() { }
66-
public GetRelayConfigurationOptions(Azure.Communication.CommunicationUserIdentifier communicationUser = null, Azure.Communication.NetworkTraversal.RouteType? routeType = default(Azure.Communication.NetworkTraversal.RouteType?)) { }
6766
public Azure.Communication.CommunicationUserIdentifier CommunicationUser { get { throw null; } set { } }
6867
public Azure.Communication.NetworkTraversal.RouteType? RouteType { get { throw null; } set { } }
6968
}

‎sdk/communication/Azure.Communication.NetworkTraversal/samples/Sample1_CommunicationRelayClient.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ A configuration is returned for the user. Each configuration consists of a URL f
4040
Every relay configuration has an expiry date and time stamped on it, indicating when the set of TURN credentials will no longer be accepted. Once the credentials have expired, you can renew the token by calling the same method.
4141

4242
```C# Snippet:GetRelayConfiguration
43-
Response<CommunicationRelayConfiguration> relayConfiguration = client.GetRelayConfiguration(new GetRelayConfigurationOptions(user));
43+
Response<CommunicationRelayConfiguration> relayConfiguration = client.GetRelayConfiguration();
4444
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
4545
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
4646
Console.WriteLine($"Expires On: {turnTokenExpiresOn}");
@@ -52,6 +52,7 @@ foreach (CommunicationIceServer iceServer in iceServers)
5252
}
5353
Console.WriteLine($"ICE Server Username: {iceServer.Username}");
5454
Console.WriteLine($"ICE Server Credential: {iceServer.Credential}");
55+
Console.WriteLine($"ICE Server RouteType: {iceServer.RouteType}");
5556
}
5657
```
5758

‎sdk/communication/Azure.Communication.NetworkTraversal/samples/Sample1_CommunicationRelayClientAsync.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ A configuration is returned for the user. Each configuration consists of a URL f
4040
Every relay configuration has an expiry date and time stamped on it, indicating when the set of TURN credentials will no longer be accepted. Once the credentials have expired, you can renew the token by calling the same method.
4141

4242
```C# Snippet:GetRelayConfigurationAsync
43-
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions(user));
43+
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync();
4444
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
4545
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
4646
Console.WriteLine($"Expires On: {turnTokenExpiresOn}");
@@ -52,7 +52,7 @@ foreach (CommunicationIceServer iceServer in iceServers)
5252
}
5353
Console.WriteLine($"ICE Server Username: {iceServer.Username}");
5454
Console.WriteLine($"ICE Server Credential: {iceServer.Credential}");
55-
Console.WriteLine($"Route type: {iceServer.RouteType}");
55+
Console.WriteLine($"ICE Server RouteType: {iceServer.RouteType}");
5656
}
5757
```
5858

‎sdk/communication/Azure.Communication.NetworkTraversal/src/CommunicationRelayClient.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public CommunicationRelayClient(string connectionString, CommunicationRelayClien
4040

4141
/// <summary> Initializes a new instance of <see cref="CommunicationRelayClient"/>.</summary>
4242
/// <param name="endpoint"> The URI of the Azure Communication Services resource. </param>
43-
/// <param name="keyCredential">T he <see cref="AzureKeyCredential"/> used to authenticate requests. </param>
43+
/// <param name="keyCredential"> The <see cref="AzureKeyCredential"/> used to authenticate requests. </param>
4444
/// <param name="options"> Client option exposing <see cref="ClientOptions.Diagnostics"/>, <see cref="ClientOptions.Retry"/>, <see cref="ClientOptions.Transport"/>, etc.</param>
4545
public CommunicationRelayClient(Uri endpoint, AzureKeyCredential keyCredential, CommunicationRelayClientOptions options = default)
4646
: this(
@@ -51,7 +51,7 @@ public CommunicationRelayClient(Uri endpoint, AzureKeyCredential keyCredential,
5151

5252
/// <summary> Initializes a new instance of <see cref="CommunicationRelayClient"/>.</summary>
5353
/// <param name="endpoint"> The URI of the Azure Communication Services resource. </param>
54-
/// <param name="tokenCredential">T he <see cref="TokenCredential"/> used to authenticate requests, such as DefaultAzureCredential. </param>
54+
/// <param name="tokenCredential"> The <see cref="TokenCredential"/> used to authenticate requests, such as DefaultAzureCredential. </param>
5555
/// <param name="options">Client option exposing <see cref="ClientOptions.Diagnostics"/>, <see cref="ClientOptions.Retry"/>, <see cref="ClientOptions.Transport"/>, etc.</param>
5656
public CommunicationRelayClient(Uri endpoint, TokenCredential tokenCredential, CommunicationRelayClientOptions options = default)
5757
: this(

‎sdk/communication/Azure.Communication.NetworkTraversal/src/Models/GetRelayConfigurationOptions.cs‎

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,13 @@
33

44
namespace Azure.Communication.NetworkTraversal.Models
55
{
6-
/// <summary> GetRelayConfigurationOptions. </summary>
6+
/// <summary> Additional options for getting a relay configuration. </summary>
77
public class GetRelayConfigurationOptions
88
{
99
/// <summary> The <see cref="CommunicationUserIdentifier"/> for whom to issue a token. </summary>
1010
public CommunicationUserIdentifier CommunicationUser { get; set; }
1111

1212
/// <summary> The specified <see cref="RouteType"/> for the relay request. </summary>
1313
public RouteType? RouteType { get; set; }
14-
15-
/// <summary> Initializes a new instance of GetRelayConfigurationOptions. </summary>
16-
public GetRelayConfigurationOptions()
17-
{
18-
}
19-
20-
/// <summary> Initializes a new instance of GetRelayConfigurationOptions. </summary>
21-
/// <param name="communicationUser"> The <see cref="CommunicationUserIdentifier"/> for whom to issue a token. </param>
22-
/// <param name="routeType"> The specified <see cref="RouteType"/> for the relay request. </param>
23-
public GetRelayConfigurationOptions(CommunicationUserIdentifier communicationUser = null, RouteType? routeType = null) {
24-
this.CommunicationUser = communicationUser;
25-
this.RouteType = routeType;
26-
}
2714
}
2815
}

‎sdk/communication/Azure.Communication.NetworkTraversal/tests/CommunicationRelayClient/CommunicationRelayClientLiveTests.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public async Task GettingTurnCredentialsGeneratesTurnCredentials(AuthMethod auth
4444
CommunicationIdentityClient communicationIdentityClient = CreateInstrumentedCommunicationIdentityClient();
4545

4646
Response<CommunicationUserIdentifier> userResponse = await communicationIdentityClient.CreateUserAsync();
47-
Response<CommunicationRelayConfiguration> turnCredentialsResponse = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions(userResponse.Value));
47+
Response<CommunicationRelayConfiguration> turnCredentialsResponse = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions { CommunicationUser = userResponse.Value } );
4848

4949
Assert.IsNotNull(turnCredentialsResponse.Value);
5050
Assert.IsNotNull(turnCredentialsResponse.Value.ExpiresOn);
@@ -88,7 +88,7 @@ public async Task GettingTurnCredentialsWithRequestedRouteType(AuthMethod authMe
8888
CommunicationIdentityClient communicationIdentityClient = CreateInstrumentedCommunicationIdentityClient();
8989

9090
Response<CommunicationUserIdentifier> userResponse = await communicationIdentityClient.CreateUserAsync();
91-
Response<CommunicationRelayConfiguration> turnCredentialsResponse = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions(userResponse.Value, routeType));
91+
Response<CommunicationRelayConfiguration> turnCredentialsResponse = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions { CommunicationUser = userResponse.Value, RouteType = routeType }) ;
9292

9393
Assert.IsNotNull(turnCredentialsResponse.Value);
9494
Assert.IsNotNull(turnCredentialsResponse.Value.ExpiresOn);

‎sdk/communication/Azure.Communication.NetworkTraversal/tests/samples/Sample1_CommunicationRelayClient.cs‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,7 @@ public async Task GetRelayConfigurationAsync()
4141
#endregion Snippet:CreateCommunicationRelayClientAsync
4242
client = CreateClientWithConnectionString();
4343

44-
#region Snippet:GetRelayConfigurationAsync
45-
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions(user));
44+
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions { CommunicationUser = user });
4645
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
4746
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
4847
Console.WriteLine($"Expires On: {turnTokenExpiresOn}");
@@ -56,7 +55,6 @@ public async Task GetRelayConfigurationAsync()
5655
Console.WriteLine($"ICE Server Credential: {iceServer.Credential}");
5756
Console.WriteLine($"Route type: {iceServer.RouteType}");
5857
}
59-
#endregion Snippet:GetRelayConfigurationAsync
6058
}
6159

6260
[Test]
@@ -74,7 +72,7 @@ public async Task GetRelayConfigurationAsyncWithNearestRouteType()
7472
var client = new CommunicationRelayClient(connectionString);
7573
client = CreateClientWithConnectionString();
7674
#region Snippet:GetRelayConfigurationAsyncWithNearestRouteType
77-
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions(user, RouteType.Nearest));
75+
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions { CommunicationUser = user, RouteType = RouteType.Nearest });
7876
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
7977
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
8078
Console.WriteLine($"Expires On: {turnTokenExpiresOn}");
@@ -102,7 +100,7 @@ public async Task GetRelayConfigurationAsyncWithoutIdentity()
102100
var client = new CommunicationRelayClient(connectionString);
103101
client = CreateClientWithConnectionString();
104102

105-
#region Snippet:GetRelayConfigurationAsyncWithoutIdentity
103+
#region Snippet:GetRelayConfigurationAsync
106104
Response<CommunicationRelayConfiguration> relayConfiguration = await client.GetRelayConfigurationAsync();
107105
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
108106
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
@@ -115,8 +113,9 @@ public async Task GetRelayConfigurationAsyncWithoutIdentity()
115113
}
116114
Console.WriteLine($"ICE Server Username: {iceServer.Username}");
117115
Console.WriteLine($"ICE Server Credential: {iceServer.Credential}");
116+
Console.WriteLine($"ICE Server RouteType: {iceServer.RouteType}");
118117
}
119-
#endregion Snippet:GetRelayConfigurationAsyncWithoutIdentity
118+
#endregion Snippet:GetRelayConfigurationAsync
120119
}
121120

122121
[Test]
@@ -136,8 +135,7 @@ public void GetRelayConfiguration()
136135
#endregion Snippet:CreateCommunicationRelayClient
137136
client = CreateClientWithConnectionString();
138137

139-
#region Snippet:GetRelayConfiguration
140-
Response<CommunicationRelayConfiguration> relayConfiguration = client.GetRelayConfiguration(new GetRelayConfigurationOptions(user));
138+
Response<CommunicationRelayConfiguration> relayConfiguration = client.GetRelayConfiguration(new GetRelayConfigurationOptions { CommunicationUser = user });
141139
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
142140
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
143141
Console.WriteLine($"Expires On: {turnTokenExpiresOn}");
@@ -150,7 +148,6 @@ public void GetRelayConfiguration()
150148
Console.WriteLine($"ICE Server Username: {iceServer.Username}");
151149
Console.WriteLine($"ICE Server Credential: {iceServer.Credential}");
152150
}
153-
#endregion Snippet:GetRelayConfiguration
154151
}
155152

156153
[Test]
@@ -168,7 +165,7 @@ public void GetRelayConfigurationWithNearestRouteType()
168165
var client = new CommunicationRelayClient(connectionString);
169166
client = CreateClientWithConnectionString();
170167

171-
Response<CommunicationRelayConfiguration> relayConfiguration = client.GetRelayConfiguration(new GetRelayConfigurationOptions(user, RouteType.Nearest));
168+
Response<CommunicationRelayConfiguration> relayConfiguration = client.GetRelayConfiguration(new GetRelayConfigurationOptions {CommunicationUser = user, RouteType = RouteType.Nearest });
172169
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
173170
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
174171
Console.WriteLine($"Expires On: {turnTokenExpiresOn}");
@@ -195,6 +192,7 @@ public void GetRelayConfigurationWithoutIdentity()
195192
var client = new CommunicationRelayClient(connectionString);
196193
client = CreateClientWithConnectionString();
197194

195+
#region Snippet:GetRelayConfiguration
198196
Response<CommunicationRelayConfiguration> relayConfiguration = client.GetRelayConfiguration();
199197
DateTimeOffset turnTokenExpiresOn = relayConfiguration.Value.ExpiresOn;
200198
IReadOnlyList<CommunicationIceServer> iceServers = relayConfiguration.Value.IceServers;
@@ -207,7 +205,9 @@ public void GetRelayConfigurationWithoutIdentity()
207205
}
208206
Console.WriteLine($"ICE Server Username: {iceServer.Username}");
209207
Console.WriteLine($"ICE Server Credential: {iceServer.Credential}");
208+
Console.WriteLine($"ICE Server RouteType: {iceServer.RouteType}");
210209
}
210+
#endregion Snippet:GetRelayConfiguration
211211
}
212212

213213
[Test]
@@ -227,7 +227,7 @@ public async Task CreateCommunicationRelayWithToken()
227227
client = CreateClientWithTokenCredential();
228228
try
229229
{
230-
Response<CommunicationRelayConfiguration> relayConfigurationResponse = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions(user));
230+
Response<CommunicationRelayConfiguration> relayConfigurationResponse = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions{ CommunicationUser = user });
231231
}
232232
catch (Exception ex)
233233
{
@@ -253,7 +253,7 @@ public async Task CreateCommunicationRelayWithAccessKey()
253253
client = CreateClientWithAzureKeyCredential();
254254
try
255255
{
256-
Response<CommunicationRelayConfiguration> relayConfigurationResponse = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions(user));
256+
Response<CommunicationRelayConfiguration> relayConfigurationResponse = await client.GetRelayConfigurationAsync(new GetRelayConfigurationOptions{ CommunicationUser = user });
257257
}
258258
catch (Exception ex)
259259
{

0 commit comments

Comments
 (0)