WebPubSubEventHandler Class

Definition

Namespace:
Azure.ResourceManager.WebPubSub.Models
Assembly:
Azure.ResourceManager.WebPubSub.dll
Package:
Azure.ResourceManager.WebPubSub v1.2.0
Package:
Azure.ResourceManager.WebPubSub v1.3.0-beta.1
Source:
WebPubSubEventHandler.cs
Source:
WebPubSubEventHandler.cs

Properties of event handler.

public class WebPubSubEventHandler : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.WebPubSub.Models.WebPubSubEventHandler>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.WebPubSub.Models.WebPubSubEventHandler>
type WebPubSubEventHandler = class
    interface IJsonModel<WebPubSubEventHandler>
    interface IPersistableModel<WebPubSubEventHandler>
Public Class WebPubSubEventHandler
Implements IJsonModel(Of WebPubSubEventHandler), IPersistableModel(Of WebPubSubEventHandler)
Inheritance
Object
WebPubSubEventHandler
Implements
IJsonModel<WebPubSubEventHandler> IPersistableModel<WebPubSubEventHandler> IPersistableModel<T>

Constructors

Name Description
WebPubSubEventHandler(String)

Initializes a new instance of WebPubSubEventHandler.

Properties

Name Description
Auth

Upstream auth settings. If not set, no auth is used for upstream messages.
GroupPresenceEvents

The group presence events that this event handler is concerned with. Group presence events are triggered when connections join or leave groups in the hub. If the value is null, no presence events will be sent to this event handler.
SystemEvents

Gets or sets the list of system events.
UrlTemplate

Gets or sets the URL template for the event handler. The actual URL is calculated when the corresponding event is triggered. The template supports predefined parameters syntax: {event}, {hub}, and KeyVault reference syntax {@Microsoft.KeyVault(SecretUri=_your_secret_identifier_)} For example, if the template is http://example.com/api/{event}, when connect event is triggered, a POST request will be sent to the URL http://example.com/chat/api/connect. Note: Parameters are not allowed in the hostname of the URL, and curly brackets {} are reserved for parameter syntax only. If your URL path contains literal curly brackets, please URL-encode them to ensure proper handling.
UserEventPattern

Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported:

  1. "*", it matches any event name
  2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2"
  3. A single event name, for example, "event1", it matches "event1"

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<WebPubSubEventHandler>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<WebPubSubEventHandler>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IPersistableModel<WebPubSubEventHandler>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<WebPubSubEventHandler>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<WebPubSubEventHandler>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to