Skip to content

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.

label
inherited
string

The extension label.

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

inheritedinherited
Interface Property

index

optionalinheritedinherited
Interface Property

label

optionalinheritedinherited
Interface Property

name

optionalinheritedinherited
Interface Property

widgetId

optionalinheritedinherited
Interface Property

Methods

MethodReturnsNotes
getActions()string[]

The method that returns the redux actions.

getInitLocalState()any

The method that returns the redux initial store state.

getReducer()(localStateany, actionany, stateIMState) => any

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

getStoreKey()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
    localStateany
    actionany
    stateIMState
    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.