ReduxStoreExtension

Interface

The extension interface for ReduxStore extension point.

Inheritance: ReduxStoreExtensionBaseExtension

Properties

Hide inherited properties
PropertyTypeNotes
id
 inherited 
string

The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName

index
 inherited 
number

If an extension point supports multiple extensions, the index is used to determine the extension order.

name
 inherited 
string

The extension name.

widgetId
 inherited 
string

The widget id that provides the extension. No widget id means the extension is provided by Jimu.

id

inherited
Interface Property
id: string

The unique id. For widget's provided extension, the id pattern is: widgetId + extensionName

Inherited from BaseExtension.id

index

optionalinherited
Interface Property
index: number

If an extension point supports multiple extensions, the index is used to determine the extension order.

Inherited from BaseExtension.index

name

optionalinherited
Interface Property
name: string

The extension name.

Inherited from BaseExtension.name

widgetId

optionalinherited
Interface Property
widgetId: string

The widget id that provides the extension. No widget id means the extension is provided by Jimu.

Inherited from BaseExtension.widgetId

Methods

MethodReturnsNotes
string[]

The method that returns the redux actions.

any

The method that returns the redux initial store state.

(localStateany, actionany, stateIMState) => any

The method that returns the redux reducer. The reducer should return local state.

string

The method that returns the redux store key. The key supports this format: a.b.c.

getActions

Interface Method
getActions(): string[]

The method that returns the redux actions.

Returns 
string[]

getInitLocalState

Interface Method
getInitLocalState(): any

The method that returns the redux initial store state.

Returns 
any

getReducer

Interface Method
getReducer(): (localStateany, actionany, stateIMState) => any

The method that returns the redux reducer. The reducer should return local state.

Returns 
(localStateany, actionany, stateIMState) => any
    function(localStateany, actionany, stateIMState): any
    Parameters
    ParameterType
    localState
    any
    action
    any
    state
    IMState
    Returns 
    any

getStoreKey

Interface Method
getStoreKey(): string

The method that returns the redux store key. The key supports this format: a.b.c.

Returns 
string

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.