Interface IAuthenticationResultSource
The IAuthenticationResult source that is able to mutate the result with additional roles and properties.
Namespace: PushTechnology.ClientInterface.Client.Security.Authentication
Assembly: Diffusion.Client.dll
Syntax
public interface IAuthenticationResultSource : IAuthenticationResult
Remarks
Deprecated: This interface is used by IAuthenticationHandler which is deprecated. This interface will be removed in a future release.
Methods
WithProperties(IReadOnlyDictionary<String, String>)
Copies this authentication result with additional property values.
Declaration
IAuthenticationResultSource WithProperties(IReadOnlyDictionary<string, string> properties)
Parameters
Type | Name | Description |
---|---|---|
IReadOnlyDictionary<String, String> | properties | The properties used to add to or replace any current properties. |
Returns
Type | Description |
---|---|
IAuthenticationResultSource | The new mmutable result with the property values set. |
Remarks
New values will be added to any current values and if any specified key already had a value then it will be replaced.
The calling authentication result is left unmodified.
WithProperty(String, String)
Copies this authentication result with an additional property value.
Declaration
IAuthenticationResultSource WithProperty(string key, string value)
Parameters
Type | Name | Description |
---|---|---|
String | key | The property key. |
String | value | The property value. |
Returns
Type | Description |
---|---|
IAuthenticationResultSource | The new immutable result with the property value set. |
Remarks
If the specified key already had a value then it will be replaced.
The calling authentication result is left unmodified.
WithRoles(String[])
Copies this authentication result with additional roles.
Declaration
IAuthenticationResultSource WithRoles(params string[] roles)
Parameters
Type | Name | Description |
---|---|---|
String[] | roles | The additional roles to be added to the session. |
Returns
Type | Description |
---|---|
IAuthenticationResultSource | The new immutable result with the added roles. |
Remarks
The calling authentication result is left unmodified.