@azure/web-pubsub 1.1.0-alpha.20221107.1 → 1.1.0

package/README.md

@@ -109,6 +109,9 @@ let token = await serviceClient.getClientAccessToken();
 // Or get the access token and assign the client a userId
 token = await serviceClient.getClientAccessToken({ userId: "user1" });
 
+// Or get the access token that the client will join group GroupA when it connects using the access token
+token = await serviceClient.getClientAccessToken({ userId: "user1", groups: [ "GroupA" ] });
+
 // return the token to the WebSocket client
 ```
 
@@ -130,6 +133,34 @@ const payload = new Uint8Array(10);
 await serviceClient.sendToAll(payload.buffer);
 ```
 
+### Send messages to all connections in a hub with OData filter syntax
+
+Details about `filter` syntax please see [OData filter syntax for Azure Web PubSub](https://aka.ms/awps/filter-syntax).
+
+```js
+const { WebPubSubServiceClient, odata } = require("@azure/web-pubsub");
+
+const serviceClient = new WebPubSubServiceClient("<ConnectionString>", "<hubName>");
+
+// Send a JSON message to anonymous connections
+await serviceClient.sendToAll(
+  { message: "Hello world!" },
+  { filter: "userId eq null" }
+  );
+
+// Send a text message to connections in groupA but not in groupB
+const groupA = 'groupA';
+const groupB = 'groupB';
+await serviceClient.sendToAll(
+  "Hello world!",
+  { 
+    contentType: "text/plain",
+    // use plain text "'groupA' in groups and not('groupB' in groups)"
+    // or use the odata helper method
+    filter: odata`${groupA} in groups and not(${groupB} in groups)` 
+  });
+```
+
 ### Send messages to all connections in a group
 
 ```js