@azure/web-pubsub 1.1.2-alpha.20230418.1 → 1.1.3-alpha.20230711.3

Sign up to get free protection for your applications and to get access to all the features.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@azure/web-pubsub",
3
- "version": "1.1.2-alpha.20230418.1",
3
+ "version": "1.1.3-alpha.20230711.3",
4
4
  "description": "Azure client library for Azure Web PubSub",
5
5
  "sdk-type": "client",
6
6
  "main": "dist/index.js",
@@ -125,6 +125,14 @@ export declare interface GroupSendToAllOptions extends OperationOptions {
125
125
  * Details about `filter` syntax please see [OData filter syntax for Azure Web PubSub](https://aka.ms/awps/filter-syntax).
126
126
  */
127
127
  filter?: string;
128
+ /**
129
+ * The time-to-live (TTL) value in seconds for messages sent to the service.
130
+ * 0 is the default value, which means the message never expires.
131
+ * 300 is the maximum value.
132
+ * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.
133
+ * This parameter can help when the client's bandwidth is limited.
134
+ */
135
+ messageTtlSeconds?: number;
128
136
  }
129
137
 
130
138
  /**
@@ -257,12 +265,28 @@ export declare interface HubSendToAllOptions extends OperationOptions {
257
265
  * Details about `filter` syntax please see [OData filter syntax for Azure Web PubSub](https://aka.ms/awps/filter-syntax).
258
266
  */
259
267
  filter?: string;
268
+ /**
269
+ * The time-to-live (TTL) value in seconds for messages sent to the service.
270
+ * 0 is the default value, which means the message never expires.
271
+ * 300 is the maximum value.
272
+ * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.
273
+ * This parameter can help when the client's bandwidth is limited.
274
+ */
275
+ messageTtlSeconds?: number;
260
276
  }
261
277
 
262
278
  /**
263
279
  * Options for sending a message to a specific connection.
264
280
  */
265
281
  export declare interface HubSendToConnectionOptions extends OperationOptions {
282
+ /**
283
+ * The time-to-live (TTL) value in seconds for messages sent to the service.
284
+ * 0 is the default value, which means the message never expires.
285
+ * 300 is the maximum value.
286
+ * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.
287
+ * This parameter can help when the client's bandwidth is limited.
288
+ */
289
+ messageTtlSeconds?: number;
266
290
  }
267
291
 
268
292
  /**
@@ -277,6 +301,14 @@ export declare interface HubSendToUserOptions extends OperationOptions {
277
301
  * Details about `filter` syntax please see [OData filter syntax for Azure Web PubSub](https://aka.ms/awps/filter-syntax).
278
302
  */
279
303
  filter?: string;
304
+ /**
305
+ * The time-to-live (TTL) value in seconds for messages sent to the service.
306
+ * 0 is the default value, which means the message never expires.
307
+ * 300 is the maximum value.
308
+ * If this parameter is non-zero, messages that are not consumed by the client within the specified TTL will be dropped by the service.
309
+ * This parameter can help when the client's bandwidth is limited.
310
+ */
311
+ messageTtlSeconds?: number;
280
312
  }
281
313
 
282
314
  /**
@@ -538,6 +570,20 @@ export declare class WebPubSubServiceClient {
538
570
  * @param options - Additional options
539
571
  */
540
572
  removeConnectionFromAllGroups(connectionId: string, options?: HubCloseConnectionOptions): Promise<void>;
573
+ /**
574
+ * Add filtered connections to multiple groups
575
+ * @param groups - A list of groups which target connections will be added into
576
+ * @param filter - An OData filter which target connections satisfy
577
+ * @param options - Additional options
578
+ */
579
+ addConnectionsToGroups(groups: string[], filter: string, options?: GroupAddConnectionOptions): Promise<void>;
580
+ /**
581
+ * Remove filtered connections from multiple groups
582
+ * @param groups - A list of groups which target connections will be removed from
583
+ * @param filter - An OData filter which target connections satisfy
584
+ * @param options - Additional options
585
+ */
586
+ removeConnectionsFromGroups(groups: string[], filter: string, options?: GroupRemoveConnectionOptions): Promise<void>;
541
587
  /**
542
588
  * Check if a particular group exists (i.e. has active connections).
543
589
  *