606 строки
58 KiB
YAML
606 строки
58 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient"
|
|
name: "WebPubSubServiceAsyncClient"
|
|
nameWithType: "WebPubSubServiceAsyncClient"
|
|
summary: "Initializes a new instance of the asynchronous Azure<wbr>Web<wbr>Pub<wbr>Sub<wbr>Service<wbr>RestAPI type."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **WebPubSubServiceAsyncClient**"
|
|
methods:
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.addConnectionToGroupWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.addConnectionToGroupWithResponse(String group, String connectionId, RequestOptions requestOptions)"
|
|
name: "addConnectionToGroupWithResponse(String group, String connectionId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.addConnectionToGroupWithResponse(String group, String connectionId, RequestOptions requestOptions)"
|
|
summary: "Add a connection to the target group."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Target connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> addConnectionToGroupWithResponse(String group, String connectionId, RequestOptions requestOptions)"
|
|
desc: "Add a connection to the target group."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.addConnectionsToGroups(java.util.List<java.lang.String>,java.lang.String)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.addConnectionsToGroups(List<String> groups, String filter)"
|
|
name: "addConnectionsToGroups(List<String> groups, String filter)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.addConnectionsToGroups(List<String> groups, String filter)"
|
|
summary: "Add filtered connections to multiple groups."
|
|
parameters:
|
|
- description: "Target group names. Rejected by server on status code 400 if this parameter is null."
|
|
name: "groups"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- description: "The filter to apply to the connections."
|
|
name: "filter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public Mono<Void> addConnectionsToGroups(List<String> groups, String filter)"
|
|
desc: "Add filtered connections to multiple groups.\n\n**Request Body Schema**\n\n```java\n{\n groups: Iterable (Optional)\n filter: String (Optional)\n }\n```"
|
|
returns:
|
|
description: "the completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.addUserToGroupWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.addUserToGroupWithResponse(String group, String userId, RequestOptions requestOptions)"
|
|
name: "addUserToGroupWithResponse(String group, String userId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.addUserToGroupWithResponse(String group, String userId, RequestOptions requestOptions)"
|
|
summary: "Add a user to the target group."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Target user ID."
|
|
name: "userId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> addUserToGroupWithResponse(String group, String userId, RequestOptions requestOptions)"
|
|
desc: "Add a user to the target group."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.checkPermissionWithResponse(com.azure.messaging.webpubsub.models.WebPubSubPermission,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.checkPermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
name: "checkPermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.checkPermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
summary: "Check if a connection has permission to the specified action."
|
|
parameters:
|
|
- description: "The permission: current supported actions are joinLeaveGroup and sendToGroup."
|
|
name: "permission"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubPermission?alt=com.azure.messaging.webpubsub.models.WebPubSubPermission&text=WebPubSubPermission\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Target connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Boolean>> checkPermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
desc: "Check if a connection has permission to the specified action."
|
|
returns:
|
|
description: "whether resource exists."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.closeAllConnectionsWithResponse(com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.closeAllConnectionsWithResponse(RequestOptions requestOptions)"
|
|
name: "closeAllConnectionsWithResponse(RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.closeAllConnectionsWithResponse(RequestOptions requestOptions)"
|
|
summary: "Close the connections in the hub."
|
|
parameters:
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> closeAllConnectionsWithResponse(RequestOptions requestOptions)"
|
|
desc: "Close the connections in the hub.\n\n**Query Parameters**\n\n | ---------- | ------ | -------- | -------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | excluded | String | No | Exclude these connectionIds when closing the connections in the hub. |\n | reason | String | No | The reason closing the client connection. |\n | apiVersion | String | Yes | Api Version |"
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.closeConnectionWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.closeConnectionWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
name: "closeConnectionWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.closeConnectionWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
summary: "Close the client connection."
|
|
parameters:
|
|
- description: "Target connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> closeConnectionWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
desc: "Close the client connection."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.closeGroupConnectionsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.closeGroupConnectionsWithResponse(String group, RequestOptions requestOptions)"
|
|
name: "closeGroupConnectionsWithResponse(String group, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.closeGroupConnectionsWithResponse(String group, RequestOptions requestOptions)"
|
|
summary: "Close connections in the specific group."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> closeGroupConnectionsWithResponse(String group, RequestOptions requestOptions)"
|
|
desc: "Close connections in the specific group.\n\n**Query Parameters**\n\n | ---------- | ------ | -------- | ---------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | excluded | String | No | Exclude these connectionIds when closing the connections in the group. |\n | reason | String | No | The reason closing the client connection. |\n | apiVersion | String | Yes | Api Version |"
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.closeUserConnectionsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.closeUserConnectionsWithResponse(String userId, RequestOptions requestOptions)"
|
|
name: "closeUserConnectionsWithResponse(String userId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.closeUserConnectionsWithResponse(String userId, RequestOptions requestOptions)"
|
|
summary: "Close connections for the specific user."
|
|
parameters:
|
|
- description: "The user ID."
|
|
name: "userId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> closeUserConnectionsWithResponse(String userId, RequestOptions requestOptions)"
|
|
desc: "Close connections for the specific user.\n\n**Query Parameters**\n\n | ---------- | ------ | -------- | ---------------------------------------------------------------------- |\n | Name | Type | Required | Description |\n | excluded | String | No | Exclude these connectionIds when closing the connections for the user. |\n | reason | String | No | The reason closing the client connection. |\n | apiVersion | String | Yes | Api Version |"
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.connectionExistsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.connectionExistsWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
name: "connectionExistsWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.connectionExistsWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
summary: "Check if the connection with the given connection<wbr>Id exists."
|
|
parameters:
|
|
- description: "The connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Boolean>> connectionExistsWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
desc: "Check if the connection with the given connectionId exists."
|
|
returns:
|
|
description: "whether resource exists."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.getClientAccessToken(com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.getClientAccessToken(GetClientAccessTokenOptions options)"
|
|
name: "getClientAccessToken(GetClientAccessTokenOptions options)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.getClientAccessToken(GetClientAccessTokenOptions options)"
|
|
summary: "Creates a client access token."
|
|
parameters:
|
|
- description: "Options to apply when creating the client access token."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions?alt=com.azure.messaging.webpubsub.models.GetClientAccessTokenOptions&text=GetClientAccessTokenOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<WebPubSubClientAccessToken> getClientAccessToken(GetClientAccessTokenOptions options)"
|
|
desc: "Creates a client access token."
|
|
returns:
|
|
description: "A new client access token instance."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken?alt=com.azure.messaging.webpubsub.models.WebPubSubClientAccessToken&text=WebPubSubClientAccessToken\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.grantPermissionWithResponse(com.azure.messaging.webpubsub.models.WebPubSubPermission,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.grantPermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
name: "grantPermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.grantPermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
summary: "Grant permission to the connection."
|
|
parameters:
|
|
- description: "The permission: current supported actions are joinLeaveGroup and sendToGroup."
|
|
name: "permission"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubPermission?alt=com.azure.messaging.webpubsub.models.WebPubSubPermission&text=WebPubSubPermission\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Target connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> grantPermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
desc: "Grant permission to the connection."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.groupExistsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.groupExistsWithResponse(String group, RequestOptions requestOptions)"
|
|
name: "groupExistsWithResponse(String group, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.groupExistsWithResponse(String group, RequestOptions requestOptions)"
|
|
summary: "Check if there are any client connections inside the given group."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Boolean>> groupExistsWithResponse(String group, RequestOptions requestOptions)"
|
|
desc: "Check if there are any client connections inside the given group."
|
|
returns:
|
|
description: "whether resource exists."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.removeConnectionFromAllGroupsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.removeConnectionFromAllGroupsWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
name: "removeConnectionFromAllGroupsWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.removeConnectionFromAllGroupsWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
summary: "Remove a connection from all groups."
|
|
parameters:
|
|
- description: "Target connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> removeConnectionFromAllGroupsWithResponse(String connectionId, RequestOptions requestOptions)"
|
|
desc: "Remove a connection from all groups."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.removeConnectionFromGroupWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.removeConnectionFromGroupWithResponse(String group, String connectionId, RequestOptions requestOptions)"
|
|
name: "removeConnectionFromGroupWithResponse(String group, String connectionId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.removeConnectionFromGroupWithResponse(String group, String connectionId, RequestOptions requestOptions)"
|
|
summary: "Remove a connection from the target group."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Target connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> removeConnectionFromGroupWithResponse(String group, String connectionId, RequestOptions requestOptions)"
|
|
desc: "Remove a connection from the target group."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.removeUserFromAllGroupsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.removeUserFromAllGroupsWithResponse(String userId, RequestOptions requestOptions)"
|
|
name: "removeUserFromAllGroupsWithResponse(String userId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.removeUserFromAllGroupsWithResponse(String userId, RequestOptions requestOptions)"
|
|
summary: "Remove a user from all groups."
|
|
parameters:
|
|
- description: "Target user ID."
|
|
name: "userId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> removeUserFromAllGroupsWithResponse(String userId, RequestOptions requestOptions)"
|
|
desc: "Remove a user from all groups."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.removeUserFromGroupWithResponse(java.lang.String,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.removeUserFromGroupWithResponse(String group, String userId, RequestOptions requestOptions)"
|
|
name: "removeUserFromGroupWithResponse(String group, String userId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.removeUserFromGroupWithResponse(String group, String userId, RequestOptions requestOptions)"
|
|
summary: "Remove a user from the target group."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Target user ID."
|
|
name: "userId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> removeUserFromGroupWithResponse(String group, String userId, RequestOptions requestOptions)"
|
|
desc: "Remove a user from the target group."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.revokePermissionWithResponse(com.azure.messaging.webpubsub.models.WebPubSubPermission,java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.revokePermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
name: "revokePermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.revokePermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
summary: "Revoke permission for the connection."
|
|
parameters:
|
|
- description: "The permission: current supported actions are joinLeaveGroup and sendToGroup."
|
|
name: "permission"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubPermission?alt=com.azure.messaging.webpubsub.models.WebPubSubPermission&text=WebPubSubPermission\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Target connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> revokePermissionWithResponse(WebPubSubPermission permission, String connectionId, RequestOptions requestOptions)"
|
|
desc: "Revoke permission for the connection."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToAll(java.lang.String,com.azure.messaging.webpubsub.models.WebPubSubContentType)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToAll(String message, WebPubSubContentType contentType)"
|
|
name: "sendToAll(String message, WebPubSubContentType contentType)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToAll(String message, WebPubSubContentType contentType)"
|
|
summary: "Broadcast content inside request body to all the connected client connections."
|
|
parameters:
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Upload file type."
|
|
name: "contentType"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubContentType?alt=com.azure.messaging.webpubsub.models.WebPubSubContentType&text=WebPubSubContentType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Void> sendToAll(String message, WebPubSubContentType contentType)"
|
|
desc: "Broadcast content inside request body to all the connected client connections."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToAllWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToAllWithResponse(BinaryData message, RequestOptions requestOptions)"
|
|
name: "sendToAllWithResponse(BinaryData message, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToAllWithResponse(BinaryData message, RequestOptions requestOptions)"
|
|
summary: "Broadcast content inside request body to all the connected client connections."
|
|
parameters:
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> sendToAllWithResponse(BinaryData message, RequestOptions requestOptions)"
|
|
desc: "Broadcast content inside request body to all the connected client connections."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToAllWithResponse(com.azure.core.util.BinaryData,com.azure.messaging.webpubsub.models.WebPubSubContentType,long,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToAllWithResponse(BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
name: "sendToAllWithResponse(BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToAllWithResponse(BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
summary: "Broadcast content inside request body to all the connected client connections."
|
|
parameters:
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Upload file type."
|
|
name: "contentType"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubContentType?alt=com.azure.messaging.webpubsub.models.WebPubSubContentType&text=WebPubSubContentType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The contentLength parameter."
|
|
name: "contentLength"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> sendToAllWithResponse(BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
desc: "Broadcast content inside request body to all the connected client connections."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToConnection(java.lang.String,java.lang.String,com.azure.messaging.webpubsub.models.WebPubSubContentType)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToConnection(String connectionId, String message, WebPubSubContentType contentType)"
|
|
name: "sendToConnection(String connectionId, String message, WebPubSubContentType contentType)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToConnection(String connectionId, String message, WebPubSubContentType contentType)"
|
|
summary: "Send content inside request body to the specific connection."
|
|
parameters:
|
|
- description: "The connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Upload file type."
|
|
name: "contentType"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubContentType?alt=com.azure.messaging.webpubsub.models.WebPubSubContentType&text=WebPubSubContentType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Void> sendToConnection(String connectionId, String message, WebPubSubContentType contentType)"
|
|
desc: "Send content inside request body to the specific connection."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToConnectionWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToConnectionWithResponse(String connectionId, BinaryData message, RequestOptions requestOptions)"
|
|
name: "sendToConnectionWithResponse(String connectionId, BinaryData message, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToConnectionWithResponse(String connectionId, BinaryData message, RequestOptions requestOptions)"
|
|
summary: "Send content inside request body to the specific connection."
|
|
parameters:
|
|
- description: "The connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> sendToConnectionWithResponse(String connectionId, BinaryData message, RequestOptions requestOptions)"
|
|
desc: "Send content inside request body to the specific connection."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToConnectionWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.messaging.webpubsub.models.WebPubSubContentType,long,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToConnectionWithResponse(String connectionId, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
name: "sendToConnectionWithResponse(String connectionId, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToConnectionWithResponse(String connectionId, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
summary: "Send content inside request body to the specific connection."
|
|
parameters:
|
|
- description: "The connection ID."
|
|
name: "connectionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Upload file type."
|
|
name: "contentType"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubContentType?alt=com.azure.messaging.webpubsub.models.WebPubSubContentType&text=WebPubSubContentType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The contentLength parameter."
|
|
name: "contentLength"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> sendToConnectionWithResponse(String connectionId, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
desc: "Send content inside request body to the specific connection."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToGroup(java.lang.String,java.lang.String,com.azure.messaging.webpubsub.models.WebPubSubContentType)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToGroup(String group, String message, WebPubSubContentType contentType)"
|
|
name: "sendToGroup(String group, String message, WebPubSubContentType contentType)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToGroup(String group, String message, WebPubSubContentType contentType)"
|
|
summary: "Send content inside request body to a group of connections."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Upload file type."
|
|
name: "contentType"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubContentType?alt=com.azure.messaging.webpubsub.models.WebPubSubContentType&text=WebPubSubContentType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Void> sendToGroup(String group, String message, WebPubSubContentType contentType)"
|
|
desc: "Send content inside request body to a group of connections."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToGroupWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToGroupWithResponse(String group, BinaryData message, RequestOptions requestOptions)"
|
|
name: "sendToGroupWithResponse(String group, BinaryData message, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToGroupWithResponse(String group, BinaryData message, RequestOptions requestOptions)"
|
|
summary: "Send content inside request body to a group of connections."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> sendToGroupWithResponse(String group, BinaryData message, RequestOptions requestOptions)"
|
|
desc: "Send content inside request body to a group of connections."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToGroupWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.messaging.webpubsub.models.WebPubSubContentType,long,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToGroupWithResponse(String group, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
name: "sendToGroupWithResponse(String group, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToGroupWithResponse(String group, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
summary: "Send content inside request body to a group of connections."
|
|
parameters:
|
|
- description: "Target group name, which length should be greater than 0 and less than 1025."
|
|
name: "group"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Upload file type."
|
|
name: "contentType"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubContentType?alt=com.azure.messaging.webpubsub.models.WebPubSubContentType&text=WebPubSubContentType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The contentLength parameter."
|
|
name: "contentLength"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> sendToGroupWithResponse(String group, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
desc: "Send content inside request body to a group of connections."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToUser(java.lang.String,java.lang.String,com.azure.messaging.webpubsub.models.WebPubSubContentType)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToUser(String userId, String message, WebPubSubContentType contentType)"
|
|
name: "sendToUser(String userId, String message, WebPubSubContentType contentType)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToUser(String userId, String message, WebPubSubContentType contentType)"
|
|
summary: "Send content inside request body to the specific user."
|
|
parameters:
|
|
- description: "The user ID."
|
|
name: "userId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Upload file type."
|
|
name: "contentType"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubContentType?alt=com.azure.messaging.webpubsub.models.WebPubSubContentType&text=WebPubSubContentType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Void> sendToUser(String userId, String message, WebPubSubContentType contentType)"
|
|
desc: "Send content inside request body to the specific user."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToUserWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToUserWithResponse(String userId, BinaryData message, RequestOptions requestOptions)"
|
|
name: "sendToUserWithResponse(String userId, BinaryData message, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToUserWithResponse(String userId, BinaryData message, RequestOptions requestOptions)"
|
|
summary: "Send content inside request body to the specific user."
|
|
parameters:
|
|
- description: "The user ID."
|
|
name: "userId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> sendToUserWithResponse(String userId, BinaryData message, RequestOptions requestOptions)"
|
|
desc: "Send content inside request body to the specific user."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToUserWithResponse(java.lang.String,com.azure.core.util.BinaryData,com.azure.messaging.webpubsub.models.WebPubSubContentType,long,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.sendToUserWithResponse(String userId, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
name: "sendToUserWithResponse(String userId, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.sendToUserWithResponse(String userId, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
summary: "Send content inside request body to the specific user."
|
|
parameters:
|
|
- description: "The user ID."
|
|
name: "userId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The payload body."
|
|
name: "message"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Upload file type."
|
|
name: "contentType"
|
|
type: "<xref href=\"com.azure.messaging.webpubsub.models.WebPubSubContentType?alt=com.azure.messaging.webpubsub.models.WebPubSubContentType&text=WebPubSubContentType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The contentLength parameter."
|
|
name: "contentLength"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Void>> sendToUserWithResponse(String userId, BinaryData message, WebPubSubContentType contentType, long contentLength, RequestOptions requestOptions)"
|
|
desc: "Send content inside request body to the specific user."
|
|
returns:
|
|
description: "the completion."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>>"
|
|
- uid: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.userExistsWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.messaging.webpubsub.WebPubSubServiceAsyncClient.userExistsWithResponse(String userId, RequestOptions requestOptions)"
|
|
name: "userExistsWithResponse(String userId, RequestOptions requestOptions)"
|
|
nameWithType: "WebPubSubServiceAsyncClient.userExistsWithResponse(String userId, RequestOptions requestOptions)"
|
|
summary: "Check if there are any client connections connected for the given user."
|
|
parameters:
|
|
- description: "Target user ID."
|
|
name: "userId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The options to configure the HTTP request before HTTP client sends it."
|
|
name: "requestOptions"
|
|
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Mono<Response<Boolean>> userExistsWithResponse(String userId, RequestOptions requestOptions)"
|
|
desc: "Check if there are any client connections connected for the given user."
|
|
returns:
|
|
description: "whether resource exists."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a><<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>>>"
|
|
type: "class"
|
|
desc: "Initializes a new instance of the asynchronous AzureWebPubSubServiceRestAPI type."
|
|
metadata: {}
|
|
package: "com.azure.messaging.webpubsub"
|
|
artifact: com.azure:azure-messaging-webpubsub:1.3.2
|