WebPubSubServiceClient.GetClientAccessUri Method

Definition

Overloads

GetClientAccessUri(TimeSpan, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)

Creates a URI with authentication token.

GetClientAccessUri(DateTimeOffset, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)

Creates a URI with authentication token.

GetClientAccessUri(DateTimeOffset, String, IEnumerable<String>, CancellationToken)

Creates a URI with authentication token.

GetClientAccessUri(TimeSpan, String, IEnumerable<String>, CancellationToken)

Creates a URI with authentication token.

GetClientAccessUri(TimeSpan, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)

Source:
WebPubSubServiceClient_helpers.cs

Creates a URI with authentication token.

public virtual Uri GetClientAccessUri (TimeSpan expiresAfter = default, string userId = default, System.Collections.Generic.IEnumerable<string> roles = default, System.Collections.Generic.IEnumerable<string> groups = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetClientAccessUri : TimeSpan * string * seq<string> * seq<string> * System.Threading.CancellationToken -> Uri
override this.GetClientAccessUri : TimeSpan * string * seq<string> * seq<string> * System.Threading.CancellationToken -> Uri
Public Overridable Function GetClientAccessUri (Optional expiresAfter As TimeSpan = Nothing, Optional userId As String = Nothing, Optional roles As IEnumerable(Of String) = Nothing, Optional groups As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Uri

Parameters

expiresAfter
TimeSpan

Defaults to one hour, if not specified. Must be greater or equal zero.

userId
String

User Id.

roles
IEnumerable<String>

Roles that the connection with the generated token will have.

groups
IEnumerable<String>

Groups that the connection with the generated token will join when it connects.

cancellationToken
CancellationToken

Cancellation token.

Returns

Uri

Applies to

GetClientAccessUri(DateTimeOffset, String, IEnumerable<String>, IEnumerable<String>, CancellationToken)

Source:
WebPubSubServiceClient_helpers.cs

Creates a URI with authentication token.

public virtual Uri GetClientAccessUri (DateTimeOffset expiresAt, string userId = default, System.Collections.Generic.IEnumerable<string> roles = default, System.Collections.Generic.IEnumerable<string> groups = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetClientAccessUri : DateTimeOffset * string * seq<string> * seq<string> * System.Threading.CancellationToken -> Uri
override this.GetClientAccessUri : DateTimeOffset * string * seq<string> * seq<string> * System.Threading.CancellationToken -> Uri
Public Overridable Function GetClientAccessUri (expiresAt As DateTimeOffset, Optional userId As String = Nothing, Optional roles As IEnumerable(Of String) = Nothing, Optional groups As IEnumerable(Of String) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Uri

Parameters

expiresAt
DateTimeOffset

UTC time when the token expires.

userId
String

User Id.

roles
IEnumerable<String>

Roles that the connection with the generated token will have.

groups
IEnumerable<String>

Groups that the connection with the generated token will join when it connects.

cancellationToken
CancellationToken

Cancellation token.

Returns

Uri

Applies to

GetClientAccessUri(DateTimeOffset, String, IEnumerable<String>, CancellationToken)

Source:
WebPubSubServiceClient_helpers.cs

Creates a URI with authentication token.

public virtual Uri GetClientAccessUri (DateTimeOffset expiresAt, string userId, System.Collections.Generic.IEnumerable<string> roles, System.Threading.CancellationToken cancellationToken);
abstract member GetClientAccessUri : DateTimeOffset * string * seq<string> * System.Threading.CancellationToken -> Uri
override this.GetClientAccessUri : DateTimeOffset * string * seq<string> * System.Threading.CancellationToken -> Uri
Public Overridable Function GetClientAccessUri (expiresAt As DateTimeOffset, userId As String, roles As IEnumerable(Of String), cancellationToken As CancellationToken) As Uri

Parameters

expiresAt
DateTimeOffset

UTC time when the token expires.

userId
String

User Id.

roles
IEnumerable<String>

Roles that the connection with the generated token will have.

cancellationToken
CancellationToken

Cancellation token.

Returns

Uri

Applies to

GetClientAccessUri(TimeSpan, String, IEnumerable<String>, CancellationToken)

Source:
WebPubSubServiceClient_helpers.cs

Creates a URI with authentication token.

public virtual Uri GetClientAccessUri (TimeSpan expiresAfter, string userId, System.Collections.Generic.IEnumerable<string> roles, System.Threading.CancellationToken cancellationToken);
abstract member GetClientAccessUri : TimeSpan * string * seq<string> * System.Threading.CancellationToken -> Uri
override this.GetClientAccessUri : TimeSpan * string * seq<string> * System.Threading.CancellationToken -> Uri
Public Overridable Function GetClientAccessUri (expiresAfter As TimeSpan, userId As String, roles As IEnumerable(Of String), cancellationToken As CancellationToken) As Uri

Parameters

expiresAfter
TimeSpan

Defaults to one hour, if not specified. Must be greater or equal zero.

userId
String

User Id.

roles
IEnumerable<String>

Roles that the connection with the generated token will have.

cancellationToken
CancellationToken

Cancellation token.

Returns

Uri

Applies to