Azure Web PubSub Chat client library for .NET - version 1.0.0-beta.1

Azure.Messaging.WebPubSub.Chat is a client library for developing .NET applications with rich experience.

Getting started

Install the package

Install the client library for .NET with NuGet:

dotnet add package Azure.Messaging.WebPubSub.Chat --prerelease

Prerequisites

Authenticate the client

Create a WebPubSubChatServiceClient using the connection string for your Web PubSub resource and the target hub name.

var client = new WebPubSubChatServiceClient("<connection-string>", "chat");

Key concepts

Examples

Generate a client access URI

Uri clientAccessUri = client.GetClientAccessUri(new ClientAccessUriOptions
{
    UserId = "user1",
    ExpiresAfter = TimeSpan.FromHours(1),
});

Create a room and add a member

// Create (or replace) a room.
WebPubSubChatRoom room = client.CreateOrReplaceRoom("room1", new WebPubSubChatRoom("General")).Value;

// Create (or replace) a user with a built-in role.
client.CreateOrReplaceUser("user1", new WebPubSubHumanChatUser("Alice", BuiltInChatRoles.UserNormal));

// Add the user to the room as a room member.
client.CreateOrReplaceRoomMember("room1", "user1", new WebPubSubChatRoomMember(BuiltInChatRoles.RoomMember));

Define a custom role from built-in permissions

var role = new WebPubSubChatRole(new[]
{
    ChatPermission.RoomPublishMessage,
    ChatPermission.RoomHistory,
    ChatPermission.RoomInvite,
});

client.CreateOrReplaceRole("room.contributor", role);

Inspect a built-in role

WebPubSubChatRole memberRole = client.GetRole(BuiltInChatRoles.RoomMember).Value;

Console.WriteLine($"{memberRole.Name}: {string.Join(", ", memberRole.Permissions)}");

Read message history

WebPubSubChatRoom room = client.GetRoom("room1").Value;

foreach (WebPubSubChatMessage message in client.GetMessages(room.DefaultConversation))
{
    Console.WriteLine($"{message.CreatedBy}: {message.Content.Text}");
}

More detailed examples are available in the samples folder.

Troubleshooting

Next steps

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (for example, label, comment). Follow the instructions provided by the bot. You'll only need to do this action once across all repositories using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact opencode@microsoft.com with any other questions or comments.

  • Last updated on