Class default

Create redux actions to be dispatched by connected components, mostly to make requests to the server.

Hierarchy

  • default
    • default

Constructors

constructor

Properties

BOOK BOOK_CLEAR BOOK_FAILURE BOOK_LOAD BOOK_REQUEST BOOK_SUCCESS CLEAR CLEAR_AUTH_CREDENTIALS CLOSE_ERROR COLLECTION COLLECTION_CLEAR COLLECTION_FAILURE COLLECTION_LOAD COLLECTION_REQUEST COLLECTION_SUCCESS EDIT_STAGES FAILURE FULFILL_BOOK FULFILL_BOOK_FAILURE FULFILL_BOOK_REQUEST FULFILL_BOOK_SUCCESS GET_ALL_LIBRARIES GET_ONE_LIBRARY GET_SOME_LIBRARIES HIDE_AUTH_FORM LOAD LOANS LOANS_FAILURE LOANS_LOAD LOANS_REQUEST LOANS_SUCCESS LOG_IN PAGE PAGE_FAILURE PAGE_LOAD PAGE_REQUEST PAGE_SUCCESS POST_PLS_ID REQUEST SAVE_AUTH_CREDENTIALS SEARCH_DESCRIPTION SEARCH_DESCRIPTION_LOAD SET_PREFERENCE SHOW_AUTH_FORM SUCCESS UPDATE_BOOK UPDATE_BOOK_FAILURE UPDATE_BOOK_LOAD UPDATE_BOOK_REQUEST UPDATE_BOOK_SUCCESS VALIDATE_EMAIL

Methods

clear clearAuthCredentials clearBook clearCollection closeError closeErrorAndHideAuthForm editStages failure fetchBlob fetchBook fetchCollection fetchJSON fetchLibraries fetchLibrary fetchLoans fetchOPDS fetchPage fetchSearchDescription fulfillBook hideAuthForm indirectFulfillBook load loadBook logIn postForm postJSON postPlsID request saveAuthCredentials search setPreference showAuthForm success updateBook validateEmail

Constructors

constructor

  • Parameters

    • Optional fetcher: default

    Returns default

Properties

Static Readonly BOOK

BOOK: "BOOK" = "BOOK"

Static Readonly BOOK_CLEAR

BOOK_CLEAR: "BOOK_CLEAR" = "BOOK_CLEAR"

Static Readonly BOOK_FAILURE

BOOK_FAILURE: "BOOK_FAILURE" = "BOOK_FAILURE"

Static Readonly BOOK_LOAD

BOOK_LOAD: "BOOK_LOAD" = "BOOK_LOAD"

Static Readonly BOOK_REQUEST

BOOK_REQUEST: "BOOK_REQUEST" = "BOOK_REQUEST"

Static Readonly BOOK_SUCCESS

BOOK_SUCCESS: "BOOK_SUCCESS" = "BOOK_SUCCESS"

Static Readonly CLEAR

CLEAR: "CLEAR" = "CLEAR"

Static Readonly CLEAR_AUTH_CREDENTIALS

CLEAR_AUTH_CREDENTIALS: "CLEAR_AUTH_CREDENTIALS" = "CLEAR_AUTH_CREDENTIALS"

Static Readonly CLOSE_ERROR

CLOSE_ERROR: "CLOSE_ERROR" = "CLOSE_ERROR"

Static Readonly COLLECTION

COLLECTION: "COLLECTION" = "COLLECTION"

Static Readonly COLLECTION_CLEAR

COLLECTION_CLEAR: "COLLECTION_CLEAR" = "COLLECTION_CLEAR"

Static Readonly COLLECTION_FAILURE

COLLECTION_FAILURE: "COLLECTION_FAILURE" = "COLLECTION_FAILURE"

Static Readonly COLLECTION_LOAD

COLLECTION_LOAD: "COLLECTION_LOAD" = "COLLECTION_LOAD"

Static Readonly COLLECTION_REQUEST

COLLECTION_REQUEST: "COLLECTION_REQUEST" = "COLLECTION_REQUEST"

Static Readonly COLLECTION_SUCCESS

COLLECTION_SUCCESS: "COLLECTION_SUCCESS" = "COLLECTION_SUCCESS"

Static Readonly EDIT_STAGES

EDIT_STAGES: "EDIT_STAGES" = "EDIT_STAGES"

Static Readonly FAILURE

FAILURE: "FAILURE" = "FAILURE"

Static Readonly FULFILL_BOOK

FULFILL_BOOK: "FULFILL_BOOK" = "FULFILL_BOOK"

Static Readonly FULFILL_BOOK_FAILURE

FULFILL_BOOK_FAILURE: "FULFILL_BOOK_FAILURE" = "FULFILL_BOOK_FAILURE"

Static Readonly FULFILL_BOOK_REQUEST

FULFILL_BOOK_REQUEST: "FULFILL_BOOK_REQUEST" = "FULFILL_BOOK_REQUEST"

Static Readonly FULFILL_BOOK_SUCCESS

FULFILL_BOOK_SUCCESS: "FULFILL_BOOK_SUCCESS" = "FULFILL_BOOK_SUCCESS"

Static Readonly GET_ALL_LIBRARIES

GET_ALL_LIBRARIES: "GET_ALL_LIBRARIES" = "GET_ALL_LIBRARIES"

Static Readonly GET_ONE_LIBRARY

GET_ONE_LIBRARY: "GET_ONE_LIBRARY" = "GET_ONE_LIBRARY"

Static Readonly GET_SOME_LIBRARIES

GET_SOME_LIBRARIES: "GET_SOME_LIBRARIES" = "GET_SOME_LIBRARIES"

Static Readonly HIDE_AUTH_FORM

HIDE_AUTH_FORM: "HIDE_AUTH_FORM" = "HIDE_AUTH_FORM"

Static Readonly LOAD

LOAD: "LOAD" = "LOAD"

Static Readonly LOANS

LOANS: "LOANS" = "LOANS"

Static Readonly LOANS_FAILURE

LOANS_FAILURE: "LOANS_FAILURE" = "LOANS_FAILURE"

Static Readonly LOANS_LOAD

LOANS_LOAD: "LOANS_LOAD" = "LOANS_LOAD"

Static Readonly LOANS_REQUEST

LOANS_REQUEST: "LOANS_REQUEST" = "LOANS_REQUEST"

Static Readonly LOANS_SUCCESS

LOANS_SUCCESS: "LOANS_SUCCESS" = "LOANS_SUCCESS"

Static Readonly LOG_IN

LOG_IN: "LOG_IN" = "LOG_IN"

Static Readonly PAGE

PAGE: "PAGE" = "PAGE"

Static Readonly PAGE_FAILURE

PAGE_FAILURE: "PAGE_FAILURE" = "PAGE_FAILURE"

Static Readonly PAGE_LOAD

PAGE_LOAD: "PAGE_LOAD" = "PAGE_LOAD"

Static Readonly PAGE_REQUEST

PAGE_REQUEST: "PAGE_REQUEST" = "PAGE_REQUEST"

Static Readonly PAGE_SUCCESS

PAGE_SUCCESS: "PAGE_SUCCESS" = "PAGE_SUCCESS"

Static Readonly POST_PLS_ID

POST_PLS_ID: "POST_PLS_ID" = "POST_PLS_ID"

Static Readonly REQUEST

REQUEST: "REQUEST" = "REQUEST"

Static Readonly SAVE_AUTH_CREDENTIALS

SAVE_AUTH_CREDENTIALS: "SAVE_AUTH_CREDENTIALS" = "SAVE_AUTH_CREDENTIALS"

Static Readonly SEARCH_DESCRIPTION

SEARCH_DESCRIPTION: "SEARCH_DESCRIPTION" = "SEARCH_DESCRIPTION"

Static Readonly SEARCH_DESCRIPTION_LOAD

SEARCH_DESCRIPTION_LOAD: "SEARCH_DESCRIPTION_LOAD" = "SEARCH_DESCRIPTION_LOAD"

Static Readonly SET_PREFERENCE

SET_PREFERENCE: "SET_PREFERENCE" = "SET_PREFERENCE"

Static Readonly SHOW_AUTH_FORM

SHOW_AUTH_FORM: "SHOW_AUTH_FORM" = "SHOW_AUTH_FORM"

Static Readonly SUCCESS

SUCCESS: "SUCCESS" = "SUCCESS"

Static Readonly UPDATE_BOOK

UPDATE_BOOK: "UPDATE_BOOK" = "UPDATE_BOOK"

Static Readonly UPDATE_BOOK_FAILURE

UPDATE_BOOK_FAILURE: "UPDATE_BOOK_FAILURE" = "UPDATE_BOOK_FAILURE"

Static Readonly UPDATE_BOOK_LOAD

UPDATE_BOOK_LOAD: "UPDATE_BOOK_LOAD" = "UPDATE_BOOK_LOAD"

Static Readonly UPDATE_BOOK_REQUEST

UPDATE_BOOK_REQUEST: "UPDATE_BOOK_REQUEST" = "UPDATE_BOOK_REQUEST"

Static Readonly UPDATE_BOOK_SUCCESS

UPDATE_BOOK_SUCCESS: "UPDATE_BOOK_SUCCESS" = "UPDATE_BOOK_SUCCESS"

Static Readonly VALIDATE_EMAIL

VALIDATE_EMAIL: "VALIDATE_EMAIL" = "VALIDATE_EMAIL"

Methods

clear

  • Parameters

    • type: string

    Returns {
        type: string;
    }

    • type: string

clearAuthCredentials

  • Returns {
        type: string;
    }

    • type: string

clearBook

  • Returns {
        type: string;
    }

    • type: string

clearCollection

  • Returns {
        type: string;
    }

    • type: string

closeError

  • Returns {
        type: string;
    }

    • type: string

closeErrorAndHideAuthForm

  • Returns ((dispatch: any) => void)

      • (dispatch: any): void

      • Parameters

        • dispatch: any

        Returns void

editStages

  • Parameters

    • data: FormData

    Returns any

failure

  • Parameters

    • type: string
    • Optional error: FetchErrorData

    Returns {
        error: FetchErrorData;
        type: string;
    }

    • error: FetchErrorData
    • type: string

fetchBlob

  • Parameters

    • type: string
    • url: string

    Returns ((dispatch: any) => Promise<Blob>)

      • (dispatch: any): Promise<Blob>

      • Parameters

        • dispatch: any

        Returns Promise<Blob>

fetchBook

  • Parameters

    • url: string

    Returns ((dispatch: any) => Promise<BookData>)

      • (dispatch: any): Promise<BookData>

      • Parameters

        • dispatch: any

        Returns Promise<BookData>

fetchCollection

  • Parameters

    • url: string

    Returns ((dispatch: any) => Promise<CollectionData>)

      • (dispatch: any): Promise<CollectionData>

      • Parameters

        • dispatch: any

        Returns Promise<CollectionData>

fetchJSON

  • Type Parameters

    • T

    Parameters

    • type: string
    • url: string

    Returns ((dispatch: any) => Promise<T>)

      • (dispatch: any): Promise<T>

      • Parameters

        • dispatch: any

        Returns Promise<T>

fetchLibraries

  • Parameters

    • Optional qa: string

    Returns any

fetchLibrary

  • Parameters

    • uuid: string

    Returns any

fetchLoans

  • Parameters

    • url: string

    Returns ((dispatch: any) => Promise<CollectionData>)

      • (dispatch: any): Promise<CollectionData>

      • Parameters

        • dispatch: any

        Returns Promise<CollectionData>

fetchOPDS

  • Type Parameters

    • T

    Parameters

    • type: string
    • url: string

    Returns ((dispatch: any) => Promise<T>)

      • (dispatch: any): Promise<T>

      • Parameters

        • dispatch: any

        Returns Promise<T>

fetchPage

  • Parameters

    • url: string

    Returns ((dispatch: any) => Promise<CollectionData>)

      • (dispatch: any): Promise<CollectionData>

      • Parameters

        • dispatch: any

        Returns Promise<CollectionData>

fetchSearchDescription

  • Parameters

    • url: string

    Returns ((dispatch: any) => Promise<SearchData>)

      • (dispatch: any): Promise<SearchData>

      • Parameters

        • dispatch: any

        Returns Promise<SearchData>

fulfillBook

  • Parameters

    • url: string

    Returns ((dispatch: any) => Promise<Blob>)

      • (dispatch: any): Promise<Blob>

      • Parameters

        • dispatch: any

        Returns Promise<Blob>

hideAuthForm

  • Returns {
        type: string;
    }

    • type: string

indirectFulfillBook

  • Parameters

    • url: string
    • type: string

    Returns ((dispatch: any) => Promise<string>)

      • (dispatch: any): Promise<string>

      • Parameters

        • dispatch: any

        Returns Promise<string>

load

  • Type Parameters

    • T

    Parameters

    • type: string
    • data: T
    • Optional url: string

    Returns LoadAction<T>

loadBook

  • Parameters

    • data: BookData
    • url: string

    Returns LoadAction<BookData>

logIn

  • Parameters

    • data: FormData

    Returns any

postForm

  • Parameters

    • type: string
    • url: string
    • data: FormData
    • Optional method: string
    • Optional defaultErrorMessage: string
    • Optional returnType: string

    Returns any

postJSON

  • Type Parameters

    • T

    Parameters

    • type: string
    • url: string
    • data: T

    Returns ((dispatch: any) => Promise<unknown>)

      • (dispatch: any): Promise<unknown>

      • Parameters

        • dispatch: any

        Returns Promise<unknown>

postPlsID

  • Parameters

    • data: FormData

    Returns any

request

  • Parameters

    • type: string
    • Optional url: string

    Returns {
        type: string;
        url: string;
    }

    • type: string
    • url: string

saveAuthCredentials

  • Parameters

    • credentials: AuthCredentials

    Returns {
        credentials: AuthCredentials;
        type: string;
    }

    • credentials: AuthCredentials
    • type: string

search

  • Parameters

    • data: FormData

    Returns any

setPreference

  • Parameters

    • key: string
    • value: string

    Returns {
        key: string;
        type: string;
        value: string;
    }

    • key: string
    • type: string
    • value: string

showAuthForm

  • Parameters

    • callback: AuthCallback
    • cancel: (() => void)
        • (): void

        • Returns void

    • providers: AuthProvider<AuthMethod, AuthMethod>[]
    • title: string
    • Optional error: string
    • Optional attemptedProvider: string

    Returns {
        attemptedProvider: string;
        callback: AuthCallback;
        cancel: (() => void);
        error: string;
        providers: AuthProvider<AuthMethod, AuthMethod>[];
        title: string;
        type: string;
    }

    • attemptedProvider: string
    • callback: AuthCallback
    • cancel: (() => void)
        • (): void

        • Returns void

    • error: string
    • providers: AuthProvider<AuthMethod, AuthMethod>[]
    • title: string
    • type: string

success

  • Parameters

    • type: string

    Returns {
        type: string;
    }

    • type: string

updateBook

  • Parameters

    • url: string

    Returns ((dispatch: any) => Promise<BookData>)

      • (dispatch: any): Promise<BookData>

      • Parameters

        • dispatch: any

        Returns Promise<BookData>

validateEmail

  • Parameters

    • data: FormData

    Returns any

Settings

Member Visibility

Theme

Generated using TypeDoc