Interface IDispatchable

An object that can dispatch an Action.

Namespace: Unity.AppUI.Redux

Assembly: Unity.AppUI.Redux.dll

Syntax

public interface IDispatchable

Properties

dispatcher

The dispatcher that will be used to dispatch actions.

Declaration

Dispatcher dispatcher { get; set; }

Property Value

Type	Description
Dispatcher

Methods

Dispatch(IAction)

Dispatches an action. This is the only way to trigger a state change.

Declaration

void Dispatch(IAction action)

Parameters

Type	Name	Description
IAction	action	An object describing the change that makes up the action.

Exceptions

Type	Condition
ArgumentException	Thrown if the reducer for the action type does not exist.
ArgumentNullException	Thrown if the action is null.

Extension Methods

StoreExtensions.Dispatch(IDispatchable, string)

StoreExtensions.Dispatch(IDispatchable, ActionCreator)

StoreExtensions.DispatchAsyncThunkCoroutine<TPayload, TArg>(IDispatchable, AsyncThunkAction<TPayload, TArg>, CancellationToken)

StoreExtensions.DispatchAsyncThunk<TPayload, TArg>(IDispatchable, AsyncThunkAction<TPayload, TArg>, CancellationToken)

StoreExtensions.Dispatch<TPayload>(IDispatchable, string, TPayload)

StoreExtensions.Dispatch<TPayload>(IDispatchable, ActionCreator<TPayload>, TPayload)