azure-docs-sdk-java/docs-ref-autogen/com.azure.messaging.webpubsub.client.WebPubSubClient.yml

### YamlMime:JavaType
uid: "com.azure.messaging.webpubsub.client.WebPubSubClient"
fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient"
name: "WebPubSubClient"
nameWithType: "WebPubSubClient"
summary: "The Web<wbr>Pub<wbr>Sub client that manages the Web<wbr>Socket connections, join group, and send messages."
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 **WebPubSubClient**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html\">Closeable</a>"
methods:
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnConnectedEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.ConnectedEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnConnectedEventHandler(Consumer<ConnectedEvent> onConnectedEventHandler)"
  name: "addOnConnectedEventHandler(Consumer<ConnectedEvent> onConnectedEventHandler)"
  nameWithType: "WebPubSubClient.addOnConnectedEventHandler(Consumer<ConnectedEvent> onConnectedEventHandler)"
  summary: "Adds event handler for Connected<wbr>Event."
  parameters:
  - description: "the event handler for ConnectedEvent."
    name: "onConnectedEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.ConnectedEvent?alt=com.azure.messaging.webpubsub.client.models.ConnectedEvent&text=ConnectedEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void addOnConnectedEventHandler(Consumer<ConnectedEvent> onConnectedEventHandler)"
  desc: "Adds event handler for ConnectedEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnDisconnectedEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.DisconnectedEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnDisconnectedEventHandler(Consumer<DisconnectedEvent> onDisconnectedEventHandler)"
  name: "addOnDisconnectedEventHandler(Consumer<DisconnectedEvent> onDisconnectedEventHandler)"
  nameWithType: "WebPubSubClient.addOnDisconnectedEventHandler(Consumer<DisconnectedEvent> onDisconnectedEventHandler)"
  summary: "Adds event handler for Disconnected<wbr>Event."
  parameters:
  - description: "the event handler for DisconnectedEvent."
    name: "onDisconnectedEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.DisconnectedEvent?alt=com.azure.messaging.webpubsub.client.models.DisconnectedEvent&text=DisconnectedEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void addOnDisconnectedEventHandler(Consumer<DisconnectedEvent> onDisconnectedEventHandler)"
  desc: "Adds event handler for DisconnectedEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnGroupMessageEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.GroupMessageEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnGroupMessageEventHandler(Consumer<GroupMessageEvent> onGroupMessageEventHandler)"
  name: "addOnGroupMessageEventHandler(Consumer<GroupMessageEvent> onGroupMessageEventHandler)"
  nameWithType: "WebPubSubClient.addOnGroupMessageEventHandler(Consumer<GroupMessageEvent> onGroupMessageEventHandler)"
  summary: "Adds event handler for Group<wbr>Message<wbr>Event."
  parameters:
  - description: "the event handler for GroupMessageEvent."
    name: "onGroupMessageEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.GroupMessageEvent?alt=com.azure.messaging.webpubsub.client.models.GroupMessageEvent&text=GroupMessageEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void addOnGroupMessageEventHandler(Consumer<GroupMessageEvent> onGroupMessageEventHandler)"
  desc: "Adds event handler for GroupMessageEvent.\n\n**Code Samples**\n\n```java\nclient.addOnGroupMessageEventHandler(event -> {\n     System.out.println(\"Received group message from \" + event.getFromUserId() + \": \"\n         + event.getData().toString());\n });\n client.addOnServerMessageEventHandler(event -> {\n     System.out.println(\"Received server message: \"\n         + event.getData().toString());\n });\n```"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnRejoinGroupFailedEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.RejoinGroupFailedEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnRejoinGroupFailedEventHandler(Consumer<RejoinGroupFailedEvent> onRejoinGroupFailedEventHandler)"
  name: "addOnRejoinGroupFailedEventHandler(Consumer<RejoinGroupFailedEvent> onRejoinGroupFailedEventHandler)"
  nameWithType: "WebPubSubClient.addOnRejoinGroupFailedEventHandler(Consumer<RejoinGroupFailedEvent> onRejoinGroupFailedEventHandler)"
  summary: "Adds event handler for Rejoin<wbr>Group<wbr>Failed<wbr>Event."
  parameters:
  - description: "the event handler for RejoinGroupFailedEvent."
    name: "onRejoinGroupFailedEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.RejoinGroupFailedEvent?alt=com.azure.messaging.webpubsub.client.models.RejoinGroupFailedEvent&text=RejoinGroupFailedEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void addOnRejoinGroupFailedEventHandler(Consumer<RejoinGroupFailedEvent> onRejoinGroupFailedEventHandler)"
  desc: "Adds event handler for RejoinGroupFailedEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnServerMessageEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.ServerMessageEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnServerMessageEventHandler(Consumer<ServerMessageEvent> onServiceMessageEventHandler)"
  name: "addOnServerMessageEventHandler(Consumer<ServerMessageEvent> onServiceMessageEventHandler)"
  nameWithType: "WebPubSubClient.addOnServerMessageEventHandler(Consumer<ServerMessageEvent> onServiceMessageEventHandler)"
  summary: "Adds event handler for Server<wbr>Message<wbr>Event."
  parameters:
  - description: "the event handler for ServerMessageEvent."
    name: "onServiceMessageEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.ServerMessageEvent?alt=com.azure.messaging.webpubsub.client.models.ServerMessageEvent&text=ServerMessageEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void addOnServerMessageEventHandler(Consumer<ServerMessageEvent> onServiceMessageEventHandler)"
  desc: "Adds event handler for ServerMessageEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnStoppedEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.StoppedEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.addOnStoppedEventHandler(Consumer<StoppedEvent> onStoppedEventHandler)"
  name: "addOnStoppedEventHandler(Consumer<StoppedEvent> onStoppedEventHandler)"
  nameWithType: "WebPubSubClient.addOnStoppedEventHandler(Consumer<StoppedEvent> onStoppedEventHandler)"
  summary: "Adds event handler for Stopped<wbr>Event."
  parameters:
  - description: "the event handler for StoppedEvent."
    name: "onStoppedEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.StoppedEvent?alt=com.azure.messaging.webpubsub.client.models.StoppedEvent&text=StoppedEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void addOnStoppedEventHandler(Consumer<StoppedEvent> onStoppedEventHandler)"
  desc: "Adds event handler for StoppedEvent.\n\n**Code Samples**\n\n```java\nclient.addOnStoppedEventHandler(event -> {\n     System.out.println(\"Client is stopped\");\n });\n```"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.close()"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.close()"
  name: "close()"
  nameWithType: "WebPubSubClient.close()"
  syntax: "public void close()"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.getConnectionId()"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.getConnectionId()"
  name: "getConnectionId()"
  nameWithType: "WebPubSubClient.getConnectionId()"
  summary: "Gets the connection ID."
  syntax: "public String getConnectionId()"
  desc: "Gets the connection ID.\n\nConnection ID may not be available immediately after client start. It is provided by server via ConnectedEvent."
  returns:
    description: "the connection ID."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.joinGroup(java.lang.String)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.joinGroup(String group)"
  name: "joinGroup(String group)"
  nameWithType: "WebPubSubClient.joinGroup(String group)"
  summary: "Joins a group."
  parameters:
  - description: "the group name."
    name: "group"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public WebPubSubResult joinGroup(String group)"
  desc: "Joins a group.\n\n<xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.start()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#start()\"></xref> the client, before join group.\n\n**Code Samples**\n\n```java\nclient.start();\n client.joinGroup(\"message-group\");\n```"
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.joinGroup(java.lang.String,java.lang.Long)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.joinGroup(String group, Long ackId)"
  name: "joinGroup(String group, Long ackId)"
  nameWithType: "WebPubSubClient.joinGroup(String group, Long ackId)"
  summary: "Joins a group."
  parameters:
  - description: "the group name."
    name: "group"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the ackId. Client will provide auto increment ID, if set to <code>null</code>."
    name: "ackId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
  syntax: "public WebPubSubResult joinGroup(String group, Long ackId)"
  desc: "Joins a group.\n\n<xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.start()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#start()\"></xref> the client, before join group."
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.leaveGroup(java.lang.String)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.leaveGroup(String group)"
  name: "leaveGroup(String group)"
  nameWithType: "WebPubSubClient.leaveGroup(String group)"
  summary: "Leaves a group."
  parameters:
  - description: "the group name."
    name: "group"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public WebPubSubResult leaveGroup(String group)"
  desc: "Leaves a group."
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.leaveGroup(java.lang.String,java.lang.Long)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.leaveGroup(String group, Long ackId)"
  name: "leaveGroup(String group, Long ackId)"
  nameWithType: "WebPubSubClient.leaveGroup(String group, Long ackId)"
  summary: "Leaves a group."
  parameters:
  - description: "the group name."
    name: "group"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the ackId. Client will provide auto increment ID, if set to <code>null</code>."
    name: "ackId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
  syntax: "public WebPubSubResult leaveGroup(String group, Long ackId)"
  desc: "Leaves a group."
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnConnectedEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.ConnectedEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnConnectedEventHandler(Consumer<ConnectedEvent> onConnectedEventHandler)"
  name: "removeOnConnectedEventHandler(Consumer<ConnectedEvent> onConnectedEventHandler)"
  nameWithType: "WebPubSubClient.removeOnConnectedEventHandler(Consumer<ConnectedEvent> onConnectedEventHandler)"
  summary: "Removes event handler for Connected<wbr>Event."
  parameters:
  - description: "the event handler for ConnectedEvent."
    name: "onConnectedEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.ConnectedEvent?alt=com.azure.messaging.webpubsub.client.models.ConnectedEvent&text=ConnectedEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void removeOnConnectedEventHandler(Consumer<ConnectedEvent> onConnectedEventHandler)"
  desc: "Removes event handler for ConnectedEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnDisconnectedEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.DisconnectedEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnDisconnectedEventHandler(Consumer<DisconnectedEvent> onDisconnectedEventHandler)"
  name: "removeOnDisconnectedEventHandler(Consumer<DisconnectedEvent> onDisconnectedEventHandler)"
  nameWithType: "WebPubSubClient.removeOnDisconnectedEventHandler(Consumer<DisconnectedEvent> onDisconnectedEventHandler)"
  summary: "Removes event handler for Disconnected<wbr>Event."
  parameters:
  - description: "the event handler for DisconnectedEvent."
    name: "onDisconnectedEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.DisconnectedEvent?alt=com.azure.messaging.webpubsub.client.models.DisconnectedEvent&text=DisconnectedEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void removeOnDisconnectedEventHandler(Consumer<DisconnectedEvent> onDisconnectedEventHandler)"
  desc: "Removes event handler for DisconnectedEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnGroupMessageEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.GroupMessageEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnGroupMessageEventHandler(Consumer<GroupMessageEvent> onGroupMessageEventHandler)"
  name: "removeOnGroupMessageEventHandler(Consumer<GroupMessageEvent> onGroupMessageEventHandler)"
  nameWithType: "WebPubSubClient.removeOnGroupMessageEventHandler(Consumer<GroupMessageEvent> onGroupMessageEventHandler)"
  summary: "Removes event handler for Group<wbr>Message<wbr>Event."
  parameters:
  - description: "the event handler for GroupMessageEvent."
    name: "onGroupMessageEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.GroupMessageEvent?alt=com.azure.messaging.webpubsub.client.models.GroupMessageEvent&text=GroupMessageEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void removeOnGroupMessageEventHandler(Consumer<GroupMessageEvent> onGroupMessageEventHandler)"
  desc: "Removes event handler for GroupMessageEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnRejoinGroupFailedEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.RejoinGroupFailedEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnRejoinGroupFailedEventHandler(Consumer<RejoinGroupFailedEvent> onRejoinGroupFailedEventHandler)"
  name: "removeOnRejoinGroupFailedEventHandler(Consumer<RejoinGroupFailedEvent> onRejoinGroupFailedEventHandler)"
  nameWithType: "WebPubSubClient.removeOnRejoinGroupFailedEventHandler(Consumer<RejoinGroupFailedEvent> onRejoinGroupFailedEventHandler)"
  summary: "Removes event handler for Rejoin<wbr>Group<wbr>Failed<wbr>Event."
  parameters:
  - description: "the event handler for RejoinGroupFailedEvent."
    name: "onRejoinGroupFailedEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.RejoinGroupFailedEvent?alt=com.azure.messaging.webpubsub.client.models.RejoinGroupFailedEvent&text=RejoinGroupFailedEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void removeOnRejoinGroupFailedEventHandler(Consumer<RejoinGroupFailedEvent> onRejoinGroupFailedEventHandler)"
  desc: "Removes event handler for RejoinGroupFailedEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnServerMessageEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.ServerMessageEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnServerMessageEventHandler(Consumer<ServerMessageEvent> onServiceMessageEventHandler)"
  name: "removeOnServerMessageEventHandler(Consumer<ServerMessageEvent> onServiceMessageEventHandler)"
  nameWithType: "WebPubSubClient.removeOnServerMessageEventHandler(Consumer<ServerMessageEvent> onServiceMessageEventHandler)"
  summary: "Removes event handler for Server<wbr>Message<wbr>Event."
  parameters:
  - description: "the event handler for ServerMessageEvent."
    name: "onServiceMessageEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.ServerMessageEvent?alt=com.azure.messaging.webpubsub.client.models.ServerMessageEvent&text=ServerMessageEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void removeOnServerMessageEventHandler(Consumer<ServerMessageEvent> onServiceMessageEventHandler)"
  desc: "Removes event handler for ServerMessageEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnStoppedEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.StoppedEvent>)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.removeOnStoppedEventHandler(Consumer<StoppedEvent> onStoppedEventHandler)"
  name: "removeOnStoppedEventHandler(Consumer<StoppedEvent> onStoppedEventHandler)"
  nameWithType: "WebPubSubClient.removeOnStoppedEventHandler(Consumer<StoppedEvent> onStoppedEventHandler)"
  summary: "Removes event handler for Stopped<wbr>Event."
  parameters:
  - description: "the event handler for StoppedEvent."
    name: "onStoppedEventHandler"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<xref href=\"com.azure.messaging.webpubsub.client.models.StoppedEvent?alt=com.azure.messaging.webpubsub.client.models.StoppedEvent&text=StoppedEvent\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "public void removeOnStoppedEventHandler(Consumer<StoppedEvent> onStoppedEventHandler)"
  desc: "Removes event handler for StoppedEvent."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendEvent(java.lang.String,com.azure.core.util.BinaryData,com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendEvent(String eventName, BinaryData content, WebPubSubDataFormat dataFormat)"
  name: "sendEvent(String eventName, BinaryData content, WebPubSubDataFormat dataFormat)"
  nameWithType: "WebPubSubClient.sendEvent(String eventName, BinaryData content, WebPubSubDataFormat dataFormat)"
  summary: "Sends event."
  parameters:
  - description: "the event name."
    name: "eventName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the data."
    name: "content"
    type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
  - description: "the data format."
    name: "dataFormat"
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat?alt=com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat&text=WebPubSubDataFormat\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public WebPubSubResult sendEvent(String eventName, BinaryData content, WebPubSubDataFormat dataFormat)"
  desc: "Sends event.\n\n<xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.start()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#start()\"></xref> the client, before send event."
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendEvent(java.lang.String,com.azure.core.util.BinaryData,com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat,com.azure.messaging.webpubsub.client.models.SendEventOptions)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendEvent(String eventName, BinaryData content, WebPubSubDataFormat dataFormat, SendEventOptions options)"
  name: "sendEvent(String eventName, BinaryData content, WebPubSubDataFormat dataFormat, SendEventOptions options)"
  nameWithType: "WebPubSubClient.sendEvent(String eventName, BinaryData content, WebPubSubDataFormat dataFormat, SendEventOptions options)"
  summary: "Sends event."
  parameters:
  - description: "the event name."
    name: "eventName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the data."
    name: "content"
    type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
  - description: "the data format."
    name: "dataFormat"
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat?alt=com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat&text=WebPubSubDataFormat\" data-throw-if-not-resolved=\"False\" />"
  - description: "the options."
    name: "options"
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.SendEventOptions?alt=com.azure.messaging.webpubsub.client.models.SendEventOptions&text=SendEventOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public WebPubSubResult sendEvent(String eventName, BinaryData content, WebPubSubDataFormat dataFormat, SendEventOptions options)"
  desc: "Sends event.\n\n<xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.start()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#start()\"></xref> the client, before send event."
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(java.lang.String,com.azure.core.util.BinaryData,com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(String group, BinaryData content, WebPubSubDataFormat dataFormat)"
  name: "sendToGroup(String group, BinaryData content, WebPubSubDataFormat dataFormat)"
  nameWithType: "WebPubSubClient.sendToGroup(String group, BinaryData content, WebPubSubDataFormat dataFormat)"
  summary: "Sends message to group."
  parameters:
  - description: "the group name."
    name: "group"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the data."
    name: "content"
    type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
  - description: "the data format."
    name: "dataFormat"
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat?alt=com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat&text=WebPubSubDataFormat\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public WebPubSubResult sendToGroup(String group, BinaryData content, WebPubSubDataFormat dataFormat)"
  desc: "Sends message to group.\n\n<xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.start()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#start()\"></xref> the client, before send message.\n\n**Code Samples**\n\n```java\nclient.start();\n // it can be any class instance that can be serialized to JSON\n Map<String, String> jsonObject = new HashMap<>();\n jsonObject.put(\"name\", \"john\");\n client.sendToGroup(\"message-group\", BinaryData.fromObject(jsonObject), WebPubSubDataFormat.BINARY);\n```"
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(java.lang.String,com.azure.core.util.BinaryData,com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat,com.azure.messaging.webpubsub.client.models.SendToGroupOptions)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(String group, BinaryData content, WebPubSubDataFormat dataFormat, SendToGroupOptions options)"
  name: "sendToGroup(String group, BinaryData content, WebPubSubDataFormat dataFormat, SendToGroupOptions options)"
  nameWithType: "WebPubSubClient.sendToGroup(String group, BinaryData content, WebPubSubDataFormat dataFormat, SendToGroupOptions options)"
  summary: "Sends message to group."
  parameters:
  - description: "the group name."
    name: "group"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the data."
    name: "content"
    type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
  - description: "the data format."
    name: "dataFormat"
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat?alt=com.azure.messaging.webpubsub.client.models.WebPubSubDataFormat&text=WebPubSubDataFormat\" data-throw-if-not-resolved=\"False\" />"
  - description: "the options."
    name: "options"
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.SendToGroupOptions?alt=com.azure.messaging.webpubsub.client.models.SendToGroupOptions&text=SendToGroupOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public WebPubSubResult sendToGroup(String group, BinaryData content, WebPubSubDataFormat dataFormat, SendToGroupOptions options)"
  desc: "Sends message to group.\n\n<xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.start()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#start()\"></xref> the client, before send message."
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(java.lang.String,java.lang.String)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(String group, String content)"
  name: "sendToGroup(String group, String content)"
  nameWithType: "WebPubSubClient.sendToGroup(String group, String content)"
  summary: "Sends message to group."
  parameters:
  - description: "the group name."
    name: "group"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the data as WebPubSubDataType.TEXT."
    name: "content"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public WebPubSubResult sendToGroup(String group, String content)"
  desc: "Sends message to group.\n\n<xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.start()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#start()\"></xref> the client, before send message.\n\n**Code Samples**\n\n```java\nclient.start();\n client.sendToGroup(\"message-group\", \"hello world\");\n```"
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(java.lang.String,java.lang.String,com.azure.messaging.webpubsub.client.models.SendToGroupOptions)"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(String group, String content, SendToGroupOptions options)"
  name: "sendToGroup(String group, String content, SendToGroupOptions options)"
  nameWithType: "WebPubSubClient.sendToGroup(String group, String content, SendToGroupOptions options)"
  summary: "Sends message to group."
  parameters:
  - description: "the group name."
    name: "group"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the data as WebPubSubDataType.TEXT."
    name: "content"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "the options."
    name: "options"
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.SendToGroupOptions?alt=com.azure.messaging.webpubsub.client.models.SendToGroupOptions&text=SendToGroupOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public WebPubSubResult sendToGroup(String group, String content, SendToGroupOptions options)"
  desc: "Sends message to group.\n\n<xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.start()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#start()\"></xref> the client, before send message."
  returns:
    description: "the result."
    type: "<xref href=\"com.azure.messaging.webpubsub.client.models.WebPubSubResult?alt=com.azure.messaging.webpubsub.client.models.WebPubSubResult&text=WebPubSubResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.start()"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.start()"
  name: "start()"
  nameWithType: "WebPubSubClient.start()"
  summary: "Starts the client for connecting to the server."
  modifiers:
  - "synchronized"
  syntax: "public synchronized void start()"
  desc: "Starts the client for connecting to the server.\n\nClient is required to be started, before message to server can be sent via <xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.joinGroup(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#joinGroup(String)\"></xref> or <xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.sendToGroup(java.lang.String,java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#sendToGroup(String, String)\"></xref>. A WebSocket connection is established between the client and the Web PubSub server/hub.\n\nEvent handler can be added before client start, via e.g. <xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClient.addOnGroupMessageEventHandler(java.util.function.Consumer<com.azure.messaging.webpubsub.client.models.GroupMessageEvent>)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#addOnGroupMessageEventHandler(Consumer)\"></xref>."
- uid: "com.azure.messaging.webpubsub.client.WebPubSubClient.stop()"
  fullName: "com.azure.messaging.webpubsub.client.WebPubSubClient.stop()"
  name: "stop()"
  nameWithType: "WebPubSubClient.stop()"
  summary: "Stops the client for disconnecting from the server."
  modifiers:
  - "synchronized"
  syntax: "public synchronized void stop()"
  desc: "Stops the client for disconnecting from the server.\n\nThe WebSocket connection is closed."
type: "class"
desc: "The WebPubSub client that manages the WebSocket connections, join group, and send messages.\n\nThis client is instantiated through <xref uid=\"com.azure.messaging.webpubsub.client.WebPubSubClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"WebPubSubClientBuilder\"></xref>.\n\nPlease refer to [Azure Web PubSub][] for more information.\n\n**Code Samples**\n\n```java\n// create WebPubSub client\n WebPubSubClient client = new WebPubSubClientBuilder()\n     .clientAccessUrl(\"<client-access-url>\")\n     .buildClient();\n\n // add event handler for group message\n client.addOnGroupMessageEventHandler(event -> {\n     System.out.println(\"Received group message from \" + event.getFromUserId() + \": \"\n         + event.getData().toString());\n });\n\n // start\n client.start();\n // join group\n client.joinGroup(\"message-group\");\n // send message\n client.sendToGroup(\"message-group\", \"hello world\");\n```\n\n\n[Azure Web PubSub]: https://aka.ms/awps/doc"
implements:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html\">Closeable</a>"
metadata: {}
package: "com.azure.messaging.webpubsub.client"
artifact: com.azure:azure-messaging-webpubsub-client:1.0.5