Microsoft.Azure.WebJobs.Extensions.SignalRService Namespace
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Classes
InvocationContext |
An object represents the context of a serverless message invocation. |
InvocationContextExtensions |
A class contains extension methods for InvocationContext. |
NegotiationBaseAttribute |
The base class of input binding attributes used for SignalR client negotiation. |
SecurityTokenResult |
Defines the result of a security token validation. |
SecurityTokenValidationAttribute | |
ServerlessHub |
When a class derived from ServerlessHub, all the methods in the class are identified as using class based model. HubName is resolved from class name. Event is resolved from method name. Category is determined by the method name. Only OnConnected and OnDisconnected will be considered as Connections and others will be Messages. ParameterNames will be automatically resolved by all the parameters of the method in order, except the parameter which belongs to a binding parameter, or has the type of ILogger or CancellationToken, or marked by SignalRIgnoreAttribute. Note that SignalRTriggerAttribute MUST use parameterless constructor in class based model. |
ServerlessHub.SignalRConnectionAttribute |
Customized settings to be passed into the serverless hub context. |
ServerlessHub<T> | |
SignalRAsyncCollector<T> |
An SignalR async collector used to send SignalR message or group action. |
SignalRAttribute |
Attribute used to specify the attribute target should output its data to SignalR Service. |
SignalRConnectionAttribute |
Applies to ServerlessHub<T> to customize the Azure SignalR connection name. |
SignalRConnectionDetail |
Contains details to SignalR connection information that is used in generating SignalR access token. |
SignalRConnectionInfo |
A POJO class contains necessary information for a SignalR client to connect to Azure SignalR Service. |
SignalRConnectionInfoAttribute |
Attribute used to bind necessary information for a SignalR client to connect to SignalR Service. |
SignalREndpointsAttribute |
Attribute used to bind a list of SignalR Service endpoints to the parameter. |
SignalRFilterAttribute | |
SignalRFunctionsHostBuilderExtensions |
Extensions to add security token validator and SignalR connection configuration |
SignalRGroupAction |
Class that contains parameters needed for group operations. Either the group operation on connectionId or userId is supported. If connectionId and userId are both set, it will be resolved by the following order: 1. ConnectionId 2. UserId |
SignalRIgnoreAttribute |
In class based model, mark the parameter explicitly not to be a SignalR parameter. That means it won't be bound to a InvocationMessage argument. |
SignalRMessage |
Class that contains parameters needed for sending messages. There are three kinds of scope to send, and if more than one scopes are set, it will be resolved by the following order: 1. ConnectionId 2. UserId 3. GroupName |
SignalRNegotiationAttribute |
An input binding attribute to bind Microsoft.Azure.WebJobs.Extensions.SignalRService.NegotiationContext to the function parameter. |
SignalROptions |
Configuration options for SignalR extensions. |
SignalROutputConverter |
A helper class to convert JObject to either SignalRMessage or SignalRGroupAction. |
SignalRParameterAttribute |
Mark the parameter as the SignalR parameter that need to bind arguments. It's mutually exclusive with ParameterNames. That means you can not set ParameterNames and use SignalRParameterAttribute at the same time. |
SignalRTriggerAttribute |
Attribute used to mark a function that should be triggered by messages sent from SignalR clients. |
SignalRTriggerCategories |
A class contains constant strings that represent SignalR trigger category. |
SignalRTriggerEvents |
A class contains constant strings that represents different trigger event type. |
SignalRTriggerException | |
SignalRWebJobsBuilderExtensions |
Extension methods for SignalR Service integration |
SignalRWebJobsStartup | |
StaticServiceHubContextStore |
A global Microsoft.Azure.WebJobs.Extensions.SignalRService.IServiceManagerStore for the extension. It stores IServiceHubContextStore per set of connection strings. |
Interfaces
ISecurityTokenValidator |
An abstraction for validating security token. |
IServiceHubContextStore |
IServiceHubContextStore stores Microsoft.Azure.SignalR.Management.IServiceHubContext for each hub name. |
ISignalRConnectionInfoConfigurer |
A configuration abstraction for configuring SignalR connection information |
Enums
GroupAction |
The type of group action. |
SecurityTokenStatus |