Forge.Security.Jwt.Client.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Forge.Security.Jwt.Client</name>
    </assembly>
    <members>
        <member name="T:Forge.Security.Jwt.Client.Api.ApiCommunicationHttpClientFactory">
            <summary>Represents a HttpClient with a unique configuration</summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.ApiCommunicationHttpClientFactory.#ctor(Forge.Security.Jwt.Shared.Client.Models.JwtClientAuthenticationCoreOptions,System.IServiceProvider,Microsoft.Extensions.Logging.ILogger{Forge.Security.Jwt.Client.Api.ApiCommunicationHttpClientFactory})">
            <summary>Initializes a new instance of the <see cref="T:Forge.Security.Jwt.Client.Api.ApiCommunicationHttpClientFactory" /> class.</summary>
            <param name="options">The options.</param>
            <param name="serviceProvider">The serviceProvider.</param>
            <param name="logger">The logger.</param>
            <exception cref="T:System.ArgumentNullException">logger
            or
            options</exception>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.ApiCommunicationHttpClientFactory.#ctor(Microsoft.Extensions.Options.IOptions{Forge.Security.Jwt.Shared.Client.Models.JwtClientAuthenticationCoreOptions},System.IServiceProvider,Microsoft.Extensions.Logging.ILogger{Forge.Security.Jwt.Client.Api.ApiCommunicationHttpClientFactory})">
            <summary>Initializes a new instance of the <see cref="T:Forge.Security.Jwt.Client.Api.ApiCommunicationHttpClientFactory" /> class.</summary>
            <param name="options">The options.</param>
            <param name="serviceProvider">The serviceProvider.</param>
            <param name="logger">The options.</param>
            <exception cref="T:System.ArgumentNullException">options</exception>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.ApiCommunicationHttpClientFactory.GetHttpClient">
            <summary>Gets the HTTP client.</summary>
            <value>The HTTP client.</value>
        </member>
        <member name="T:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService">
            <summary>API communication implementation</summary>
        </member>
        <member name="E:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.OnPrepareRequest">
            <summary>Occurs before the request sent out to prepare it manually</summary>
        </member>
        <member name="E:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.OnPrepareResponse">
            <summary>Occurs after the response arrived. Gain full control over the content deserialization.</summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.#ctor(Microsoft.Extensions.Logging.ILogger{Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService},Forge.Security.Jwt.Shared.Client.Api.IApiCommunicationHttpClientFactory,Forge.Security.Jwt.Shared.Serialization.ISerializationProvider,Forge.Security.Jwt.Shared.Client.Models.DataStore,Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationServiceOptions)">
            <summary>Initializes a new instance of the <see cref="T:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService" /> class.</summary>
            <param name="logger">The logger.</param>
            <param name="apiCommunicationHttpClientFactory">The HTTP client.</param>
            <param name="serializer">The serializer.</param>
            <param name="dataStore">The dataStore.</param>
            <param name="options">The options.</param>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.#ctor(Microsoft.Extensions.Logging.ILogger{Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService},Forge.Security.Jwt.Shared.Client.Api.IApiCommunicationHttpClientFactory,Forge.Security.Jwt.Shared.Serialization.ISerializationProvider,Forge.Security.Jwt.Shared.Client.Models.DataStore,Microsoft.Extensions.Options.IOptions{Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationServiceOptions})">
            <summary>Initializes a new instance of the <see cref="T:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService" /> class.</summary>
            <param name="logger">The logger.</param>
            <param name="apiCommunicationHttpClientFactory">The HTTP client.</param>
            <param name="serializer">The serializer.</param>
            <param name="dataStore">The dataStore.</param>
            <param name="options">The options.</param>
        </member>
        <member name="P:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.DefaultEncoding">
            <summary>Gets or sets the default encoding for sending.</summary>
            <value>The default encoding is UTF8.</value>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.GetAsync``1(System.String,System.Threading.CancellationToken)">
            <summary>Gets data</summary>
            <typeparam name="TResult">The type of the result.</typeparam>
            <param name="uri">The URI.</param>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>The result object</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.PostAsync``2(System.String,``0,System.Threading.CancellationToken)">
            <summary>Posts data or creates a resource</summary>
            <typeparam name="TData">The type of the data.</typeparam>
            <typeparam name="TResult">The type of the result data.</typeparam>
            <param name="uri">The URI.</param>
            <param name="data">The data.</param>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>The result data</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.PutAsync``2(System.String,``0,System.Threading.CancellationToken)">
            <summary>Puts data or update a resource</summary>
            <typeparam name="TData">The type of the data.</typeparam>
            <typeparam name="TResult">The type of the result data.</typeparam>
            <param name="uri">The URI.</param>
            <param name="data">The data.</param>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>The result data</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.DeleteAsync``1(System.String,System.Threading.CancellationToken)">
            <summary>Deletes a</summary>
            <typeparam name="TResult">The type of the result.</typeparam>
            <param name="uri">The URI.</param>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>The return data</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationService.ApiCall``1(System.Net.Http.HttpMethod,System.String,System.Object,System.Threading.CancellationToken)">
            <summary>Perform the API call with the given parameters.</summary>
            <typeparam name="TResult">The type of the result.</typeparam>
            <param name="httpMethod">The HTTP method.</param>
            <param name="uri">The URI.</param>
            <param name="data">The data.</param>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>The return value</returns>
            <exception cref="T:Forge.Security.Jwt.Shared.Client.Api.HttpRequestException"></exception>
        </member>
        <member name="T:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationServiceOptions">
            <summary>Represents the default values for a Http request</summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationServiceOptions.#ctor">
            <summary>Initializes a new instance of the <see cref="T:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationServiceOptions" /> class.</summary>
        </member>
        <member name="P:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationServiceOptions.Request_Header_Accepts">
            <summary>Configure the header accept list for a request</summary>
            <value>List of media types</value>
        </member>
        <member name="P:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationServiceOptions.RequestEncoding">
            <summary>Gets or sets the request encoding.
            Default is UTF8.</summary>
            <value>The request encoding.</value>
        </member>
        <member name="P:Forge.Security.Jwt.Client.Api.TokenizedApiCommunicationServiceOptions.RequestMediaType">
            <summary>Gets or sets the type of the request media type.
            Default is "application/json".</summary>
            <value>The type of the request media.</value>
        </member>
        <member name="T:Forge.Security.Jwt.Client.Consts">
            <summary>Constant(s)</summary>
        </member>
        <member name="F:Forge.Security.Jwt.Client.Consts.HTTP_CLIENT_FACTORY_NAME">
            <summary>The HTTP client factory name</summary>
        </member>
        <member name="T:Forge.Security.Jwt.Client.ServiceCollectionExtensions">
            <summary>ServiceCollection extension methods</summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.ServiceCollectionExtensions.AddForgeJwtClientAuthenticationCore(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Forge.Security.Jwt.Shared.Client.Models.JwtClientAuthenticationCoreOptions})">
            <summary>
            Registers the Forge Jwt Client side security services as scoped.
            </summary>
            <returns>IServiceCollection</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.ServiceCollectionExtensions.AddForgeJwtClientAuthenticationCoreAsSingleton(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Forge.Security.Jwt.Shared.Client.Models.JwtClientAuthenticationCoreOptions})">
            <summary>
            Registers the Forge Jwt Client side security services as singletons.
            </summary>
            <returns>IServiceCollection</returns>
        </member>
        <member name="T:Forge.Security.Jwt.Client.Services.AuthenticationService">
            <summary>User service with basic features</summary>
        </member>
        <member name="E:Forge.Security.Jwt.Client.Services.AuthenticationService.OnUserAuthenticationStateChanged">
            <summary>Occurs when a user authentication state changed</summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.#ctor(Microsoft.Extensions.Logging.ILogger{Forge.Security.Jwt.Client.Services.AuthenticationService},Forge.Security.Jwt.Shared.Client.Api.ITokenizedApiCommunicationService,Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider,Forge.Security.Jwt.Shared.Client.Services.IAdditionalData,Forge.Security.Jwt.Shared.Client.Models.DataStore,Microsoft.Extensions.Options.IOptions{Forge.Security.Jwt.Shared.Client.Models.JwtClientAuthenticationCoreOptions})">
            <summary>Initializes a new instance of the <see cref="T:Forge.Security.Jwt.Client.Services.AuthenticationService" /> class.</summary>
            <param name="logger">The logger.</param>
            <param name="apiService">The API service.</param>
            <param name="authenticationStateProvider">The authentication state provider.</param>
            <param name="additionalData">Optionally the logout data</param>
            <param name="dataStore">The dataStore.</param>
            <param name="options">Optionally the logout data</param>
            <exception cref="T:System.ArgumentNullException">apiService
            or
            authenticationStateProvider</exception>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.Finalize">
            <summary>Finalizes an instance of the <see cref="T:Forge.Security.Jwt.Client.Services.AuthenticationService" /> class.</summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.AuthenticateUserAsync``2(``0)">
            <summary>Authenticates the user with the given credentials</summary>
            <typeparam name="TAuthCredentials">The type of the authentication credentials.</typeparam>
            <typeparam name="TAuthResult">The type of the authentication result.</typeparam>
            <param name="userCredentials">The user credentials.</param>
            <returns>Authentication result data</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.AuthenticateUserAsync``2(``0,System.Threading.CancellationToken)">
            <summary>Authenticates the user with the given credentials</summary>
            <typeparam name="TAuthCredentials">The type of the authentication credentials.</typeparam>
            <typeparam name="TAuthResult">The type of the authentication result.</typeparam>
            <param name="userCredentials">The user credentials.</param>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>Authentication result data</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.GetCurrentUserInfoAsync">
            <summary>Gets the current user information.</summary>
            <returns>A data object which responded back by the provider/server/service</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.LogoutUserAsync">
            <summary>Logs out the current user.</summary>
            <returns>True, if the logout was successful, otherwise, False</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.LogoutUserAsync(System.Threading.CancellationToken)">
            <summary>Logs out the current user.</summary>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>True, if the logout was successful, otherwise, False</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.ValidateTokenAsync">
            <summary>Validates the current token.</summary>
            <returns>True, if the token is valid, otherwise, False.</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.ValidateTokenAsync(System.Threading.CancellationToken)">
            <summary>Validates the current token.</summary>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>True, if the token is valid, otherwise, False.</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.RefreshTokenAsync">
            <summary>Refreshes the current token and get a new one.</summary>
            <returns>The new token, or null, if it is not valid.</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.RefreshTokenAsync(System.Threading.CancellationToken)">
            <summary>Refreshes the current token and get a new one.</summary>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>The new token, or null, if it is not valid.</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.Dispose">
            <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.AuthenticationService.Dispose(System.Boolean)">
            <summary>Releases unmanaged and - optionally - managed resources.</summary>
            <param name="disposing">
              <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
        </member>
        <member name="T:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider">
            <summary>Jwt Token based AuthenticationStateProvider implementation</summary>
        </member>
        <member name="F:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.PARSED_TOKEN_STORAGE_KEY">
            <summary>The parsed token storage key</summary>
        </member>
        <member name="E:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.OnAuthenticationStateStaticChanged">
            <summary>
            An event that provides notification when the <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/>
            has changed. For example, this event may be raised if a user logs in or out.
            This is a static event.
            </summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.#ctor(Microsoft.Extensions.Logging.ILogger{Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider},Forge.Security.Jwt.Shared.Storage.IStorage{Forge.Security.Jwt.Shared.Client.Models.ParsedTokenData},Forge.Security.Jwt.Shared.Client.Models.DataStore,System.IServiceProvider)">
            <summary>Initializes a new instance of the <see cref="T:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider" /> class.</summary>
            <param name="logger">The logger.</param>
            <param name="storage">The storage service.</param>
            <param name="dataStore">The dataStore.</param>
            <param name="serviceProvider">The service provider</param>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.GetAuthenticationStateAsync">
            <summary>Asynchronously gets an <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState">AuthenticationState</see> that describes the current user.</summary>
            <returns>
            A task that, when resolved, gives an <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState">AuthenticationState</see> instance that describes the current user.
            </returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.AuthenticateUserAsync``1(``0)">
            <summary>Authenticates the user with the gives login response</summary>
            <typeparam name="TAuthenticationResponse">The type of the login response.</typeparam>
            <param name="authenticationResponse">The login response.</param>
            <returns>Task</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.AuthenticateUserAsync(Forge.Security.Jwt.Shared.Client.Models.ParsedTokenData)">
            <summary>Authenticates the user with the given authentication response.</summary>
            <param name="parsedTokenData">The parsed token data.</param>
            <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">Invalid token</exception>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.LogoutUserAsync">
            <summary>Marks the user as logged out</summary>
            <returns>Task</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.AuthenticateUserInnerAsync(Forge.Security.Jwt.Shared.Client.Models.ParsedTokenData)">
            <summary>Authenticates the user with the given token</summary>
            <param name="parsedTokenData">The parsed token data.</param>
            <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">Invalid token</exception>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.GetParsedTokenDataAsync">
            <summary>Gets the parsed/extracted data asynchronously from the security token.</summary>
            <returns>
              ParsedTokenData
            </returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.ParseTokenAsync(Forge.Security.Jwt.Shared.Client.Services.IAuthenticationResponse)">
            <summary>Parses the given authentication tokens.</summary>
            <param name="loginResponse">The login response.</param>
            <returns>
              ParsedTokenData
            </returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.IsTokenExpired(System.DateTime)">
            <summary>Determines whether the token expired</summary>
            <param name="expireDate">The expire date.</param>
            <returns>
              <c>true</c> if the token expired, otherwise, <c>false</c>.</returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.NotifyAuthenticationStateStaticChanged(System.Threading.Tasks.Task{Microsoft.AspNetCore.Components.Authorization.AuthenticationState})">
            <summary>
            Raises the <see cref="E:Forge.Security.Jwt.Client.Services.JwtTokenAuthenticationStateProvider.OnAuthenticationStateStaticChanged"/> event.
            </summary>
            <param name="task">A <see cref="T:System.Threading.Tasks.Task"/> that supplies the updated <see cref="T:Microsoft.AspNetCore.Components.Authorization.AuthenticationState"/>.</param>
        </member>
        <member name="T:Forge.Security.Jwt.Client.Services.JwtTokenRefreshHostedService">
            <summary>Automatically refresh the token before it expires</summary>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenRefreshHostedService.#ctor(Microsoft.Extensions.Logging.ILogger{Forge.Security.Jwt.Client.Services.JwtTokenRefreshHostedService},Forge.Security.Jwt.Shared.Client.Services.IAuthenticationService,Microsoft.AspNetCore.Components.Authorization.AuthenticationStateProvider,Forge.Security.Jwt.Shared.Client.Models.DataStore,Microsoft.Extensions.Options.IOptions{Forge.Security.Jwt.Shared.Client.Models.JwtClientAuthenticationCoreOptions})">
            <summary>Initializes a new instance of the <see cref="T:Forge.Security.Jwt.Client.Services.JwtTokenRefreshHostedService" /> class.</summary>
            <param name="logger">The logger.</param>
            <param name="authenticationService">The authentication service.</param>
            <param name="authenticationStateProvider">The JWT token authentication state provider.</param>
            <param name="dataStore">The dataStore.</param>
            <param name="options">The options.</param>
            <exception cref="T:System.ArgumentNullException">authenticationService
            or
            jwtTokenAuthenticationStateProvider</exception>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenRefreshHostedService.StartAsync(System.Threading.CancellationToken)">
            <summary>Starts the service</summary>
            <param name="cancellationToken">CancellationToken</param>
            <returns>
              Task
            </returns>
        </member>
        <member name="M:Forge.Security.Jwt.Client.Services.JwtTokenRefreshHostedService.StopAsync(System.Threading.CancellationToken)">
            <summary>Stops the service</summary>
            <param name="cancellationToken">CancellationToken</param>
            <returns>
              Task
            </returns>
        </member>
    </members>
</doc>