Interface IInstrumentedStore
The instrumented store interface.
Namespace: Unity.AppUI.Redux.DevTools
Assembly: Unity.AppUI.Redux.dll
Syntax
public interface IInstrumentedStore : IStore, IDispatchable, IDisposableProperties
displayName
The display name of the store.
Declaration
string displayName { get; }Property Value
| Type | Description |
|---|---|
| string |
id
The unique identifier of the store.
Declaration
string id { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
GetLiftedState()
Get the current lifted state of the store.
Declaration
LiftedState GetLiftedState()Returns
| Type | Description |
|---|---|
| Lifted |
The current lifted state. |
Subscribe<TSelected>(Selector<LiftedState, TSelected>, Listener<TSelected>, SubscribeOptions<TSelected>)
Subscribe to the lifted state of the store.
Declaration
IDisposableSubscription Subscribe<TSelected>(Selector<LiftedState, TSelected> selector, Listener<TSelected> listener, SubscribeOptions<TSelected> options = default)Parameters
| Type | Name | Description |
|---|---|---|
| Selector<Lifted |
selector | The selector to use to select the state. |
| Listener<TSelected> | listener | The listener to notify of state changes. |
| Subscribe |
options | The options for the subscription. |
Returns
| Type | Description |
|---|---|
| IDisposable |
The subscription. |
Type Parameters
| Name | Description |
|---|---|
| TSelected | The type of the selected state. |
Unsubscribe(ISubscription<LiftedState>)
Unsubscribe from the lifted state of the store.
Declaration
bool Unsubscribe(ISubscription<LiftedState> subscription)Parameters
| Type | Name | Description |
|---|---|---|
| ISubscription<Lifted |
subscription | The subscription to remove. |
Returns
| Type | Description |
|---|---|
| bool | True if the subscription was removed, false otherwise. |