dotnet add package Microsoft.Azure.WebPubSub.Common --version 1.2.0
NuGet\Install-Package Microsoft.Azure.WebPubSub.Common -Version 1.2.0
<PackageReference Include="Microsoft.Azure.WebPubSub.Common" Version="1.2.0" />
paket add Microsoft.Azure.WebPubSub.Common --version 1.2.0
#r "nuget: Microsoft.Azure.WebPubSub.Common, 1.2.0"
// 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.
Install the package
Install the client library from NuGet:
dotnet add package Microsoft.Azure.WebPubSub.Common
- An Azure subscription.
- An existing Azure Web PubSub service instance.
Authenticate the client
Not applicable for the library. You should work with a client library to deserialize service requests in a friendly way.
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, 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, 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.
Check Microsoft.Azure.WebPubSub.AspNetCore for E2E using examples.
You can also easily enable console logging if you want to dig deeper into the requests you're making against the service.
Please take a look at the samples directory for detailed examples on how to use this library.
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 firstname.lastname@example.org with any additional questions or comments.
|Product||Versions Compatible and additional computed target framework versions.|
|.NET||net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed.|
|.NET Core||netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.|
|.NET Standard||netstandard2.0 is compatible. netstandard2.1 was computed.|
|.NET Framework||net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.|
|MonoAndroid||monoandroid was computed.|
|MonoMac||monomac was computed.|
|MonoTouch||monotouch was computed.|
|Tizen||tizen40 was computed. tizen60 was computed.|
|Xamarin.iOS||xamarinios was computed.|
|Xamarin.Mac||xamarinmac was computed.|
|Xamarin.TVOS||xamarintvos was computed.|
|Xamarin.WatchOS||xamarinwatchos was computed.|
- System.Memory.Data (>= 1.0.2)
- System.Text.Encodings.Web (>= 4.7.2)
- System.Text.Json (>= 4.7.2)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Microsoft.Azure.WebPubSub.Common:
Azure Functions extension for the WebPubSub service
Azure SDK client library for the WebPubSub service
This package is not used by any popular GitHub repositories.