Microsoft.Azure.WebPubSub.Common 1.2.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Standard 2.0
dotnet add package Microsoft.Azure.WebPubSub.Common --version 1.2.0
NuGet\Install-Package Microsoft.Azure.WebPubSub.Common -Version 1.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Microsoft.Azure.WebPubSub.Common" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Azure.WebPubSub.Common --version 1.2.0
#r "nuget: Microsoft.Azure.WebPubSub.Common, 1.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Microsoft.Azure.WebPubSub.Common as a Cake Addin
#addin nuget:?package=Microsoft.Azure.WebPubSub.Common&version=1.2.0

// Install Microsoft.Azure.WebPubSub.Common as a Cake Tool
#tool nuget:?package=Microsoft.Azure.WebPubSub.Common&version=1.2.0

Azure Web PubSub Event Handler events data model client library for .NET

This library defines the class to process with Azure Web PubSub service upstream requests.

Getting started

Install the package

Install the client library from NuGet:

dotnet add package Microsoft.Azure.WebPubSub.Common

Prerequisites

Authenticate the client

Not applicable for the library. You should work with a client library to deserialize service requests in a friendly way.

Key concepts

Events

Connect, Connected, Disconnected are system events indicate connection stage. And Connect is a blocking event that service will wait for the response to determine next action. Any error returned will drop the connection.

User events are message event. It's also a blocking event which service is waiting for response. And server can return information in the response which will be sent to the caller directly.

WebPubSubEventRequest

WebPubSubEventRequest, represents a abstract request come from service side. In detail, it should be ValidationRequest or one of the 4 events, which are ConnectEventRequest, ConnectedEventRequest, UserEventRequest and DisconnectedEventRequest. ValidationRequest represent the request for Abuse Protection.

WebPubSubEventResponse

WebPubSubEventResponse, represents a abstract response should return to service. In detail, it should be EventErrorResponse or one of the 2 blocking events, which are ConnectEventResponse and UserEventResponse.

Examples

Check Microsoft.Azure.WebPubSub.AspNetCore for E2E using examples.

Troubleshooting

You can also easily enable console logging if you want to dig deeper into the requests you're making against the service.

Next steps

Please take a look at the samples directory for detailed examples on how to use this library.

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 (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][code_of_conduct_faq] or contact opencode@microsoft.com with any additional questions or comments.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Microsoft.Azure.WebPubSub.Common:

Package Downloads
Microsoft.Azure.WebJobs.Extensions.WebPubSub The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Azure Functions extension for the WebPubSub service

Microsoft.Azure.WebPubSub.AspNetCore The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Azure SDK client library for the WebPubSub service

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.0 17,804 11/11/2022
1.1.0 45,173 12/9/2021
1.0.0 3,140 11/12/2021
1.0.0-beta.1 1,153 10/28/2021