RemoteAuthenticatorViewCore<TAuthenticationState> Class

Definition

A component that handles remote authentication operations in an application.

generic <typename TAuthenticationState>
 where TAuthenticationState : RemoteAuthenticationStatepublic ref class RemoteAuthenticatorViewCore : Microsoft::AspNetCore::Components::ComponentBase
public class RemoteAuthenticatorViewCore<TAuthenticationState> : Microsoft.AspNetCore.Components.ComponentBase where TAuthenticationState : RemoteAuthenticationState
type RemoteAuthenticatorViewCore<'AuthenticationState (requires 'AuthenticationState :> RemoteAuthenticationState)> = class
    inherit ComponentBase
Public Class RemoteAuthenticatorViewCore(Of TAuthenticationState)
Inherits ComponentBase

Type Parameters

TAuthenticationState

The user state type persisted while the operation is in progress. It must be serializable.

Inheritance
RemoteAuthenticatorViewCore<TAuthenticationState>
Derived

Constructors

RemoteAuthenticatorViewCore<TAuthenticationState>()

Properties

Action

Gets or sets the RemoteAuthenticationActions action the component needs to handle.

ApplicationPaths

Gets or sets the RemoteAuthenticationApplicationPathsOptions with the paths to different authentication pages.

AuthenticationState

Gets or sets the TAuthenticationState instance to be preserved during the authentication operation.

CompletingLoggingIn

Gets or sets a RenderFragment with the UI to display while LogInCallback is being handled.

CompletingLogOut

Gets or sets a RenderFragment with the UI to display while LogOutCallback is being handled.

LoggingIn

Gets or sets a RenderFragment with the UI to display while LogIn is being handled.

LogInFailed

Gets or sets a RenderFragment with the UI to display while LogInFailed is being handled.

LogOut

Gets or sets a RenderFragment with the UI to display while LogOut is being handled.

LogOutFailed

Gets or sets a RenderFragment with the UI to display while LogOutFailed is being handled.

LogOutSucceeded

Gets or sets a RenderFragment with the UI to display while LogOutSucceeded is being handled.

OnLogInSucceeded

Gets or sets an event callback that will be invoked with the stored authentication state when a log in operation succeeds.

OnLogOutSucceeded

Gets or sets an event callback that will be invoked with the stored authentication state when a log out operation succeeds.

Registering

Gets or sets a RenderFragment with the UI to display while Register is being handled.

UserProfile

Gets or sets a RenderFragment with the UI to display while Profile is being handled.

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.

DispatchExceptionAsync(Exception)

Treats the supplied exception as being thrown by this component. This will cause the enclosing ErrorBoundary to transition into a failed state. If there is no enclosing ErrorBoundary, it will be regarded as an exception from the enclosing renderer.

This is useful if an exception occurs outside the component lifecycle methods, but you wish to treat it the same as an exception from a component lifecycle method.

(Inherited from ComponentBase)
InvokeAsync(Action)

Executes the supplied work item on the associated renderer's synchronization context.

(Inherited from ComponentBase)
InvokeAsync(Func<Task>)

Executes the supplied work item on the associated renderer's synchronization context.

(Inherited from ComponentBase)
OnAfterRender(Boolean)

Method invoked after each time the component has rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs.

This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated.

(Inherited from ComponentBase)
OnAfterRenderAsync(Boolean)

Method invoked after each time the component has been rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs.

This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated.

Note that the component does not automatically re-render after the completion of any returned Task, because that would cause an infinite render loop.

(Inherited from ComponentBase)
OnInitialized()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.

(Inherited from ComponentBase)
OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.

Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

(Inherited from ComponentBase)
OnParametersSet()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

(Inherited from ComponentBase)
OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

SetParametersAsync(ParameterView)

Sets parameters supplied by the component's parent in the render tree.

(Inherited from ComponentBase)
ShouldRender()

Returns a flag to indicate whether the component should render.

(Inherited from ComponentBase)
StateHasChanged()

Notifies the component that its state has changed. When applicable, this will cause the component to be re-rendered.

(Inherited from ComponentBase)

Explicit Interface Implementations

IComponent.Attach(RenderHandle) (Inherited from ComponentBase)
IHandleAfterRender.OnAfterRenderAsync() (Inherited from ComponentBase)
IHandleEvent.HandleEventAsync(EventCallbackWorkItem, Object) (Inherited from ComponentBase)

Applies to