Skip to content

Commit b775a1e

Browse files
[Web PubSub] Update API for WPS Extensions library (#25255)
* Update API for WPS Extensions library * Update snippets * Rename formal param from operation to action * Update snippets * uniform Action everywhere. * nullable and minor updates. Co-authored-by: Jialin Xin <jixin@microsoft.com>
1 parent f877ed2 commit b775a1e

27 files changed

+509
-490
lines changed

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ public static class WebPubSubOutputBindingFunction
8484
[FunctionName("WebPubSubOutputBindingFunction")]
8585
public static async Task RunAsync(
8686
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
87-
[WebPubSub(Hub = "hub", Connection = "<connection-string>")] IAsyncCollector<WebPubSubOperation> operation)
87+
[WebPubSub(Hub = "hub", Connection = "<connection-string>")] IAsyncCollector<WebPubSubAction> action)
8888
{
89-
await operation.AddAsync(WebPubSubOperation.SendToAll("Hello Web PubSub!", WebPubSubDataType.Text));
89+
await action.AddAsync(WebPubSubAction.CreateSendToAllAction("Hello Web PubSub!", WebPubSubDataType.Text));
9090
}
9191
}
9292
```

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/api/Microsoft.Azure.WebJobs.Extensions.WebPubSub.netstandard2.0.cs

Lines changed: 56 additions & 54 deletions
Large diffs are not rendered by default.

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/samples/WebPubSubOutputBindingFunction.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ public static class WebPubSubOutputBindingFunction
1616
[FunctionName("WebPubSubOutputBindingFunction")]
1717
public static async Task RunAsync(
1818
[HttpTrigger(AuthorizationLevel.Anonymous, "get", "post")] HttpRequest req,
19-
[WebPubSub(Hub = "hub", Connection = "<connection-string>")] IAsyncCollector<WebPubSubOperation> operation)
19+
[WebPubSub(Hub = "hub", Connection = "<connection-string>")] IAsyncCollector<WebPubSubAction> action)
2020
{
21-
await operation.AddAsync(WebPubSubOperation.SendToAll("Hello Web PubSub!", WebPubSubDataType.Text));
21+
await action.AddAsync(WebPubSubAction.CreateSendToAllAction("Hello Web PubSub!", WebPubSubDataType.Text));
2222
}
2323
}
2424
#endregion

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/AddConnectionToGroup.cs renamed to sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/AddConnectionToGroupAction.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace Microsoft.Azure.WebJobs.Extensions.WebPubSub
1010
/// Operation to add connectionId to a group.
1111
/// </summary>
1212
[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
13-
public class AddConnectionToGroup : WebPubSubOperation
13+
public class AddConnectionToGroupAction : WebPubSubAction
1414
{
1515
/// <summary>
1616
/// Target connectionId.

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/AddUserToGroup.cs renamed to sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/AddUserToGroupAction.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace Microsoft.Azure.WebJobs.Extensions.WebPubSub
1010
/// Operation to add a user to group.
1111
/// </summary>
1212
[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
13-
public class AddUserToGroup : WebPubSubOperation
13+
public class AddUserToGroupAction : WebPubSubAction
1414
{
1515
/// <summary>
1616
/// Target userId.

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/CloseAllConnections.cs renamed to sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/CloseAllConnectionsAction.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ namespace Microsoft.Azure.WebJobs.Extensions.WebPubSub
1111
/// Operation to close all connections.
1212
/// </summary>
1313
[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
14-
public class CloseAllConnections : WebPubSubOperation
14+
public class CloseAllConnectionsAction : WebPubSubAction
1515
{
1616
/// <summary>
1717
/// ConnectionIds to exclude.
1818
/// </summary>
19-
public IList<string> Excluded { get; set; }
19+
public IList<string> Excluded { get; set; } = new List<string>();
2020

2121
/// <summary>
2222
/// Reason to close the connections.

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/CloseClientConnection.cs renamed to sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/CloseClientConnectionAction.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace Microsoft.Azure.WebJobs.Extensions.WebPubSub
1010
/// Operation to close a connection.
1111
/// </summary>
1212
[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
13-
public class CloseClientConnection : WebPubSubOperation
13+
public class CloseClientConnectionAction : WebPubSubAction
1414
{
1515
/// <summary>
1616
/// Target connectionId.

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/CloseGroupConnections.cs renamed to sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/CloseGroupConnectionsAction.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace Microsoft.Azure.WebJobs.Extensions.WebPubSub
1111
/// Operation to close connections in a group.
1212
/// </summary>
1313
[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
14-
public class CloseGroupConnections : WebPubSubOperation
14+
public class CloseGroupConnectionsAction : WebPubSubAction
1515
{
1616
/// <summary>
1717
/// Target group name.
@@ -21,7 +21,7 @@ public class CloseGroupConnections : WebPubSubOperation
2121
/// <summary>
2222
/// ConnectionIds to exclude.
2323
/// </summary>
24-
public IList<string> Excluded { get; set; }
24+
public IList<string> Excluded { get; set; } = new List<string>();
2525

2626
/// <summary>
2727
/// Reason to close the connections.

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/GrantPermission.cs renamed to sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/GrantPermissionAction.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace Microsoft.Azure.WebJobs.Extensions.WebPubSub
1111
/// Operation to grant permission.
1212
/// </summary>
1313
[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
14-
public class GrantPermission : WebPubSubOperation
14+
public class GrantPermissionAction : WebPubSubAction
1515
{
1616
/// <summary>
1717
/// Target connectionId.

sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/RemoveConnectionFromGroup.cs renamed to sdk/webpubsub/Microsoft.Azure.WebJobs.Extensions.WebPubSub/src/Bindings/Output/RemoveConnectionFromGroupAction.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ namespace Microsoft.Azure.WebJobs.Extensions.WebPubSub
1010
/// Operation to remove a connection from group.
1111
/// </summary>
1212
[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
13-
public class RemoveConnectionFromGroup : WebPubSubOperation
13+
public class RemoveConnectionFromGroupAction : WebPubSubAction
1414
{
1515
/// <summary>
1616
/// Target connectionId.

0 commit comments

Comments
 (0)