Interface ISignalRFunctionBuilder

Namespace: FunctionMonkey.Abstractions.Builders
Assembly: FunctionMonkey.Abstractions.dll
Syntax
public interface ISignalRFunctionBuilder

Methods

| Improve this Doc View Source

Negotiate(String, String, String, Nullable<AuthorizationTypeEnum>, HttpMethod[])

Creates a SignalR negotiator at the specified route attached to the given hub name and, optionally, with a user ID sourced using a binding expression e.g. {headers.x-ms-client-principal-id} to use the ID passed in from App Service Authentication (EasyAuth).

Declaration
ISignalRFunctionBuilder Negotiate(string route, string hubName, string userIdExpression = null, AuthorizationTypeEnum? authorizationType = null, params HttpMethod[] method)
Parameters
Type Name Description
System.String route

The route
System.String hubName

The hub name
System.String userIdExpression
System.Nullable<AuthorizationTypeEnum> authorizationType

The authorization type to use
HttpMethod[] method

The HTTP methods to bind to
Returns
Type Description
ISignalRFunctionBuilder
| Improve this Doc View Source

Negotiate<TCommand>(String, Nullable<AuthorizationTypeEnum>, HttpMethod[])

Declaration
ISignalRFunctionConfigurationBuilder<TCommand> Negotiate<TCommand>(string route, AuthorizationTypeEnum? authorizationType = null, params HttpMethod[] method)
Parameters
Type Name Description
System.String route
System.Nullable<AuthorizationTypeEnum> authorizationType
HttpMethod[] method
Returns
Type Description
ISignalRFunctionConfigurationBuilder<TCommand>
Type Parameters
Name Description
TCommand
| Improve this Doc View Source

NegotiateWithClaim(String, String, String, HttpMethod[])

Creates a SignalR negotiator at the specified route attached to the given hub name that will source the user ID from the specified claim. Claim based negotiators always use token based authorization.

Declaration
ISignalRFunctionBuilder NegotiateWithClaim(string route, string hubName, string claimType, params HttpMethod[] method)
Parameters
Type Name Description
System.String route

The route for the negotiator
System.String hubName

The name of the hub
System.String claimType

The type of claim to use for a user ID
HttpMethod[] method

The HTTP methods to bind to
Returns
Type Description
ISignalRFunctionBuilder

Extension Methods