Language

WebPubSubChatServiceClient Class

Definition

Namespace:
Azure.Messaging.WebPubSub.Chat
Assembly:
Azure.Messaging.WebPubSub.Chat.dll
Package:
Azure.Messaging.WebPubSub.Chat v1.0.0-beta.1
Source:
WebPubSubChatServiceClient.cs

The WebPubSubChatServiceClient.

public class WebPubSubChatServiceClient
type WebPubSubChatServiceClient = class
Public Class WebPubSubChatServiceClient
Inheritance
Object
WebPubSubChatServiceClient

Constructors

Name Description
WebPubSubChatServiceClient()

Initializes a new instance of WebPubSubChatServiceClient for mocking.
WebPubSubChatServiceClient(String, String, WebPubSubChatServiceClientOptions)

Initializes a new instance of WebPubSubChatServiceClient using a connection string.
WebPubSubChatServiceClient(String, String)

Initializes a new instance of WebPubSubChatServiceClient using a connection string.
WebPubSubChatServiceClient(Uri, String, AzureKeyCredential, WebPubSubChatServiceClientOptions)

Initializes a new instance of WebPubSubChatServiceClient using an endpoint and AzureKeyCredential.
WebPubSubChatServiceClient(Uri, String, AzureKeyCredential)

Initializes a new instance of WebPubSubChatServiceClient using an endpoint and AzureKeyCredential.
WebPubSubChatServiceClient(Uri, String, TokenCredential, WebPubSubChatServiceClientOptions)

Initializes a new instance of WebPubSubChatServiceClient.
WebPubSubChatServiceClient(Uri, String, TokenCredential)

Initializes a new instance of WebPubSubChatServiceClient.
WebPubSubChatServiceClient(WebPubSubChatServiceClientSettings)

Initializes a new instance of WebPubSubChatServiceClient from a WebPubSubChatServiceClientSettings.

Properties

Name Description
Hub

The hub name this client is connected to.
Pipeline

The HTTP pipeline for sending and receiving REST requests and responses.

Methods

Name Description
CreateOrReplaceRole(String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a role.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrReplaceRole(String, WebPubSubChatRole, MatchConditions, CancellationToken)

Create or replace a role.
CreateOrReplaceRoleAsync(String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a role.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrReplaceRoleAsync(String, WebPubSubChatRole, MatchConditions, CancellationToken)

Create or replace a role.
CreateOrReplaceRoom(String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a room with a client-specified ID.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrReplaceRoom(String, WebPubSubChatRoom, MatchConditions, CancellationToken)

Create or replace a room with a client-specified ID.
CreateOrReplaceRoomAsync(String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a room with a client-specified ID.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrReplaceRoomAsync(String, WebPubSubChatRoom, MatchConditions, CancellationToken)

Create or replace a room with a client-specified ID.
CreateOrReplaceRoomMember(String, String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a room member.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrReplaceRoomMember(String, String, WebPubSubChatRoomMember, MatchConditions, CancellationToken)

Create or replace a room member.
CreateOrReplaceRoomMemberAsync(String, String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a room member.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrReplaceRoomMemberAsync(String, String, WebPubSubChatRoomMember, MatchConditions, CancellationToken)

Create or replace a room member.
CreateOrReplaceUser(String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a user. The request body is a polymorphic ChatUser (e.g. HumanChatUser) selected by the kind discriminator.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrReplaceUser(String, WebPubSubChatUser, MatchConditions, CancellationToken)

Create or replace a user. The request body is a polymorphic ChatUser (e.g. HumanChatUser) selected by the kind discriminator.
CreateOrReplaceUserAsync(String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Create or replace a user. The request body is a polymorphic ChatUser (e.g. HumanChatUser) selected by the kind discriminator.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
CreateOrReplaceUserAsync(String, WebPubSubChatUser, MatchConditions, CancellationToken)

Create or replace a user. The request body is a polymorphic ChatUser (e.g. HumanChatUser) selected by the kind discriminator.
DeleteMessage(String, String, MatchConditions, CancellationToken)

Delete a message.
DeleteMessage(String, String, MatchConditions, RequestContext)

[Protocol Method] Delete a message.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteMessageAsync(String, String, MatchConditions, CancellationToken)

Delete a message.
DeleteMessageAsync(String, String, MatchConditions, RequestContext)

[Protocol Method] Delete a message.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRole(String, MatchConditions, CancellationToken)

Delete a role.
DeleteRole(String, MatchConditions, RequestContext)

[Protocol Method] Delete a role.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRoleAsync(String, MatchConditions, CancellationToken)

Delete a role.
DeleteRoleAsync(String, MatchConditions, RequestContext)

[Protocol Method] Delete a role.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRoom(String, MatchConditions, CancellationToken)

Delete a room.
DeleteRoom(String, MatchConditions, RequestContext)

[Protocol Method] Delete a room.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRoomAsync(String, MatchConditions, CancellationToken)

Delete a room.
DeleteRoomAsync(String, MatchConditions, RequestContext)

[Protocol Method] Delete a room.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRoomMember(String, String, MatchConditions, CancellationToken)

Delete a room member.
DeleteRoomMember(String, String, MatchConditions, RequestContext)

[Protocol Method] Delete a room member.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteRoomMemberAsync(String, String, MatchConditions, CancellationToken)

Delete a room member.
DeleteRoomMemberAsync(String, String, MatchConditions, RequestContext)

[Protocol Method] Delete a room member.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteUser(String, MatchConditions, CancellationToken)

Delete a user.
DeleteUser(String, MatchConditions, RequestContext)

[Protocol Method] Delete a user.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
DeleteUserAsync(String, MatchConditions, CancellationToken)

Delete a user.
DeleteUserAsync(String, MatchConditions, RequestContext)

[Protocol Method] Delete a user.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetClientAccessUri(ClientAccessUriOptions, CancellationToken)

Generates a client access URI that a client can use to connect to the Web PubSub Chat service. The URI includes a JWT access token as a query parameter.
GetClientAccessUriAsync(ClientAccessUriOptions, CancellationToken)

Generates a client access URI that a client can use to connect to the Web PubSub Chat service. The URI includes a JWT access token as a query parameter.
GetConversation(String, CancellationToken)

Get conversation information.
GetConversation(String, RequestContext)

[Protocol Method] Get conversation information.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetConversationAsync(String, CancellationToken)

Get conversation information.
GetConversationAsync(String, RequestContext)

[Protocol Method] Get conversation information.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetMessages(String, MessageQueryOptions, CancellationToken)

Query messages in a conversation from latest to earliest.
GetMessages(String, String, String, Nullable<Int32>, RequestContext)

[Protocol Method] Query messages in a conversation from latest to earliest.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetMessagesAsync(String, MessageQueryOptions, CancellationToken)

Query messages in a conversation from latest to earliest.
GetMessagesAsync(String, String, String, Nullable<Int32>, RequestContext)

[Protocol Method] Query messages in a conversation from latest to earliest.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRole(String, CancellationToken)

Get role information.
GetRole(String, RequestContext)

[Protocol Method] Get role information.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRoleAsync(String, CancellationToken)

Get role information.
GetRoleAsync(String, RequestContext)

[Protocol Method] Get role information.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRoles(Nullable<Int32>, String, CancellationToken)

Query roles in a hub.
GetRoles(Nullable<Int32>, String, RequestContext)

[Protocol Method] Query roles in a hub.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRolesAsync(Nullable<Int32>, String, CancellationToken)

Query roles in a hub.
GetRolesAsync(Nullable<Int32>, String, RequestContext)

[Protocol Method] Query roles in a hub.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRoom(String, CancellationToken)

Get room information.
GetRoom(String, RequestContext)

[Protocol Method] Get room information.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRoomAsync(String, CancellationToken)

Get room information.
GetRoomAsync(String, RequestContext)

[Protocol Method] Get room information.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRoomMembers(String, Nullable<Int32>, String, CancellationToken)

Get room members.
GetRoomMembers(String, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get room members.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetRoomMembersAsync(String, Nullable<Int32>, String, CancellationToken)

Get room members.
GetRoomMembersAsync(String, Nullable<Int32>, String, RequestContext)

[Protocol Method] Get room members.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUser(String, CancellationToken)

Get a user's profile. The response is a polymorphic ChatUser (e.g. HumanChatUser) selected by the kind discriminator.
GetUser(String, RequestContext)

[Protocol Method] Get a user's profile. The response is a polymorphic ChatUser (e.g. HumanChatUser) selected by the kind discriminator.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
GetUserAsync(String, CancellationToken)

Get a user's profile. The response is a polymorphic ChatUser (e.g. HumanChatUser) selected by the kind discriminator.
GetUserAsync(String, RequestContext)

[Protocol Method] Get a user's profile. The response is a polymorphic ChatUser (e.g. HumanChatUser) selected by the kind discriminator.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateMessage(String, String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Update a message.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateMessage(String, String, WebPubSubChatMessage, MatchConditions, CancellationToken)

Updates a message.
UpdateMessageAsync(String, String, RequestContent, MatchConditions, RequestContext)

[Protocol Method] Update a message.

  • This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
UpdateMessageAsync(String, String, WebPubSubChatMessage, MatchConditions, CancellationToken)

Updates a message.

Applies to