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

  • new default(fetcher?: DataFetcher): default

    Parameters

    • Optionalfetcher: DataFetcher

    Returns default

Properties

Static ReadonlyBOOK

BOOK: "BOOK"

Static ReadonlyBOOK_CLEAR

BOOK_CLEAR: "BOOK_CLEAR"

Static ReadonlyBOOK_FAILURE

BOOK_FAILURE: "BOOK_FAILURE"

Static ReadonlyBOOK_LOAD

BOOK_LOAD: "BOOK_LOAD"

Static ReadonlyBOOK_REQUEST

BOOK_REQUEST: "BOOK_REQUEST"

Static ReadonlyBOOK_SUCCESS

BOOK_SUCCESS: "BOOK_SUCCESS"

Static ReadonlyCLEAR

CLEAR: "CLEAR"

Static ReadonlyCLEAR_AUTH_CREDENTIALS

CLEAR_AUTH_CREDENTIALS: "CLEAR_AUTH_CREDENTIALS"

Static ReadonlyCLOSE_ERROR

CLOSE_ERROR: "CLOSE_ERROR"

Static ReadonlyCOLLECTION

COLLECTION: "COLLECTION"

Static ReadonlyCOLLECTION_CLEAR

COLLECTION_CLEAR: "COLLECTION_CLEAR"

Static ReadonlyCOLLECTION_FAILURE

COLLECTION_FAILURE: "COLLECTION_FAILURE"

Static ReadonlyCOLLECTION_LOAD

COLLECTION_LOAD: "COLLECTION_LOAD"

Static ReadonlyCOLLECTION_REQUEST

COLLECTION_REQUEST: "COLLECTION_REQUEST"

Static ReadonlyCOLLECTION_SUCCESS

COLLECTION_SUCCESS: "COLLECTION_SUCCESS"

Static ReadonlyEDIT_STAGES

EDIT_STAGES: "EDIT_STAGES"

Static ReadonlyFAILURE

FAILURE: "FAILURE"

Static ReadonlyFULFILL_BOOK

FULFILL_BOOK: "FULFILL_BOOK"

Static ReadonlyFULFILL_BOOK_FAILURE

FULFILL_BOOK_FAILURE: "FULFILL_BOOK_FAILURE"

Static ReadonlyFULFILL_BOOK_REQUEST

FULFILL_BOOK_REQUEST: "FULFILL_BOOK_REQUEST"

Static ReadonlyFULFILL_BOOK_SUCCESS

FULFILL_BOOK_SUCCESS: "FULFILL_BOOK_SUCCESS"

Static ReadonlyGET_ALL_LIBRARIES

GET_ALL_LIBRARIES: "GET_ALL_LIBRARIES"

Static ReadonlyGET_ONE_LIBRARY

GET_ONE_LIBRARY: "GET_ONE_LIBRARY"

Static ReadonlyGET_SOME_LIBRARIES

GET_SOME_LIBRARIES: "GET_SOME_LIBRARIES"

Static ReadonlyHIDE_AUTH_FORM

HIDE_AUTH_FORM: "HIDE_AUTH_FORM"

Static ReadonlyLOAD

LOAD: "LOAD"

Static ReadonlyLOANS

LOANS: "LOANS"

Static ReadonlyLOANS_FAILURE

LOANS_FAILURE: "LOANS_FAILURE"

Static ReadonlyLOANS_LOAD

LOANS_LOAD: "LOANS_LOAD"

Static ReadonlyLOANS_REQUEST

LOANS_REQUEST: "LOANS_REQUEST"

Static ReadonlyLOANS_SUCCESS

LOANS_SUCCESS: "LOANS_SUCCESS"

Static ReadonlyLOG_IN

LOG_IN: "LOG_IN"

Static ReadonlyPAGE

PAGE: "PAGE"

Static ReadonlyPAGE_FAILURE

PAGE_FAILURE: "PAGE_FAILURE"

Static ReadonlyPAGE_LOAD

PAGE_LOAD: "PAGE_LOAD"

Static ReadonlyPAGE_REQUEST

PAGE_REQUEST: "PAGE_REQUEST"

Static ReadonlyPAGE_SUCCESS

PAGE_SUCCESS: "PAGE_SUCCESS"

Static ReadonlyPOST_PLS_ID

POST_PLS_ID: "POST_PLS_ID"

Static ReadonlyREQUEST

REQUEST: "REQUEST"

Static ReadonlySAVE_AUTH_CREDENTIALS

SAVE_AUTH_CREDENTIALS: "SAVE_AUTH_CREDENTIALS"

Static ReadonlySEARCH_DESCRIPTION

SEARCH_DESCRIPTION: "SEARCH_DESCRIPTION"

Static ReadonlySEARCH_DESCRIPTION_LOAD

SEARCH_DESCRIPTION_LOAD: "SEARCH_DESCRIPTION_LOAD"

Static ReadonlySET_PREFERENCE

SET_PREFERENCE: "SET_PREFERENCE"

Static ReadonlySHOW_AUTH_FORM

SHOW_AUTH_FORM: "SHOW_AUTH_FORM"

Static ReadonlySUCCESS

SUCCESS: "SUCCESS"

Static ReadonlyUPDATE_BOOK

UPDATE_BOOK: "UPDATE_BOOK"

Static ReadonlyUPDATE_BOOK_FAILURE

UPDATE_BOOK_FAILURE: "UPDATE_BOOK_FAILURE"

Static ReadonlyUPDATE_BOOK_LOAD

UPDATE_BOOK_LOAD: "UPDATE_BOOK_LOAD"

Static ReadonlyUPDATE_BOOK_REQUEST

UPDATE_BOOK_REQUEST: "UPDATE_BOOK_REQUEST"

Static ReadonlyUPDATE_BOOK_SUCCESS

UPDATE_BOOK_SUCCESS: "UPDATE_BOOK_SUCCESS"

Static ReadonlyVALIDATE_EMAIL

VALIDATE_EMAIL: "VALIDATE_EMAIL"

Methods

clear

  • clear(type: string): { type: string }

    Parameters

    • type: string

    Returns { type: string }

clearAuthCredentials

  • clearAuthCredentials(): { type: string }

    Returns { type: string }

clearBook

  • clearBook(): { type: string }

    Returns { type: string }

clearCollection

  • clearCollection(): { type: string }

    Returns { type: string }

closeError

  • closeError(): { type: string }

    Returns { type: string }

closeErrorAndHideAuthForm

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

    Returns (dispatch: any) => void

editStages

  • editStages(data: FormData): any

    Parameters

    • data: FormData

    Returns any

failure

  • failure(
        type: string,
        error?: FetchErrorData,
    ): { error: FetchErrorData; type: string }

    Parameters

    • type: string
    • Optionalerror: FetchErrorData

    Returns { error: FetchErrorData; type: string }

fetchBlob

  • fetchBlob(type: string, url: string): (dispatch: any) => Promise<Blob>

    Parameters

    • type: string
    • url: string

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

fetchBook

  • fetchBook(url: string): (dispatch: any) => Promise<BookData>

    Parameters

    • url: string

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

fetchCollection

  • fetchCollection(url: string): (dispatch: any) => Promise<CollectionData>

    Parameters

    • url: string

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

fetchJSON

  • fetchJSON<T>(type: string, url: string): (dispatch: any) => Promise<T>

    Type Parameters

    • T

    Parameters

    • type: string
    • url: string

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

fetchLibraries

  • fetchLibraries(qa?: string): any

    Parameters

    • Optionalqa: string

    Returns any

fetchLibrary

  • fetchLibrary(uuid: string): any

    Parameters

    • uuid: string

    Returns any

fetchLoans

  • fetchLoans(url: string): (dispatch: any) => Promise<CollectionData>

    Parameters

    • url: string

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

fetchOPDS

  • fetchOPDS<T>(type: string, url: string): (dispatch: any) => Promise<T>

    Type Parameters

    • T

    Parameters

    • type: string
    • url: string

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

fetchPage

  • fetchPage(url: string): (dispatch: any) => Promise<CollectionData>

    Parameters

    • url: string

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

fetchSearchDescription

  • fetchSearchDescription(url: string): (dispatch: any) => Promise<SearchData>

    Parameters

    • url: string

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

fulfillBook

  • fulfillBook(url: string): (dispatch: any) => Promise<Blob>

    Parameters

    • url: string

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

hideAuthForm

  • hideAuthForm(): { type: string }

    Returns { type: string }

indirectFulfillBook

  • indirectFulfillBook(
        url: string,
        type: string,
    ): (dispatch: any) => Promise<string>

    Parameters

    • url: string
    • type: string

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

load

  • load<T>(type: string, data: T, url?: string): LoadAction<T>

    Type Parameters

    • T

    Parameters

    • type: string
    • data: T
    • Optionalurl: string

    Returns LoadAction<T>

loadBook

  • loadBook(data: BookData, url: string): LoadAction<BookData>

    Parameters

    • data: BookData
    • url: string

    Returns LoadAction<BookData>

logIn

  • logIn(data: FormData): any

    Parameters

    • data: FormData

    Returns any

postForm

  • postForm(
        type: string,
        url: string,
        data: FormData,
        method?: string,
        defaultErrorMessage?: string,
        returnType?: string,
    ): any

    Parameters

    • type: string
    • url: string
    • data: FormData
    • Optionalmethod: string
    • OptionaldefaultErrorMessage: string
    • OptionalreturnType: string

    Returns any

postJSON

  • postJSON<T>(
        type: string,
        url: string,
        data: T,
    ): (dispatch: any) => Promise<unknown>

    Type Parameters

    • T

    Parameters

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

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

postPlsID

  • postPlsID(data: FormData): any

    Parameters

    • data: FormData

    Returns any

request

  • request(type: string, url?: string): { type: string; url: string }

    Parameters

    • type: string
    • Optionalurl: string

    Returns { type: string; url: string }

saveAuthCredentials

  • saveAuthCredentials(
        credentials: AuthCredentials,
    ): { credentials: AuthCredentials; type: string }

    Parameters

    • credentials: AuthCredentials

    Returns { credentials: AuthCredentials; type: string }

search

  • search(data: FormData): any

    Parameters

    • data: FormData

    Returns any

setPreference

  • setPreference(
        key: string,
        value: string,
    ): { key: string; type: string; value: string }

    Parameters

    • key: string
    • value: string

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

showAuthForm

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

    Parameters

    • callback: AuthCallback
    • cancel: () => void
    • providers: AuthProvider<AuthMethod, AuthMethod>[]
    • title: string
    • Optionalerror: string
    • OptionalattemptedProvider: string

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

success

  • success(type: string): { type: string }

    Parameters

    • type: string

    Returns { type: string }

updateBook

  • updateBook(url: string): (dispatch: any) => Promise<BookData>

    Parameters

    • url: string

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

validateEmail

  • validateEmail(data: FormData): any

    Parameters

    • data: FormData

    Returns any

Settings

Member Visibility

On This Page

Constructors
Properties
Methods