Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SetCustomUserData

Implements SetCustomUserData fetch for the Redux store

export

Hierarchy

Index

Constructors

constructor

Properties

actions

actions: {}

The actions for the fetchable data

memberof

StoreFetchableData

Type declaration

  • [key: string]: any

Protected dispatchCount

dispatchCount: number = 0

The dispatch count. Used for the dispatchId

memberof

StoreFetchableData

Protected Optional fetchOptions

fetchOptions: any

name

name: string

The store section name Used to name the rootState member and postfixed to all actions

memberof

StoreFetchableData

reducer

reducer: Reducer<ISetCustomUserDataState>

The reducers for the fetchable data

memberof

StoreFetchableData

Protected Optional requestOptions

Protected url

url: string

The url to fetch the data from

Accessors

initialState

Methods

createFetchAction

  • Create a fetch action using the class request type This helper will setup and add promises for the fetch call and any chain that is triggered

    TODO: If typings provide optional-ness correctly we can remove the Partial

    NOTE: omitSessionId is deprecated but remains to not mess up parameter ordering

    memberof

    StoreFetchableData

    Parameters

    • Optional request: Partial<SetCustomUserData>
    • Default value chainStarter: string = this.name
    • Optional timeout: undefined | number
    • Default value omitSessionIdDeprecated: boolean = false
    • Optional elevationToken: undefined | string
    • Optional serviceContext: undefined | string
    • Optional chainContext: undefined | string

    Returns [AnyAction, Promise<EmptyResponseMessage>, Promise<TSetCustomUserDataChainData>]

createResponseAction

  • createResponseAction(response?: RES): any

fetchData

  • fetchData(action: any, timeout?: undefined | number, authorisationToken?: undefined | string, endPointURL?: undefined | string): Promise<EmptyResponseMessage>

getError$

  • getError$(): Observable<Error | null>

getPropertyState$

  • getPropertyState$(propertyPath: string | string[]): Observable<any>

Protected getReducerFunctions

  • getReducerFunctions(): {}

getRequest$

getResponse$

getState

getState$

getUrl

  • getUrl(): string

isFetching$

  • isFetching$(): Observable<boolean>

saga

  • saga(): Generator<ForkEffect, void, unknown>

timeout

  • timeout(ms: number): Promise<any>