@thepalaceproject/circulation-admin
    Preparing search index...

    Interface ConfigurationSettings

    interface ConfigurationSettings {
        csrfToken: string;
        dashboardCollectionsBarChart?: DashboardCollectionsBarChart;
        email?: string;
        featureFlags: FeatureFlags;
        quicksightPagePath: string;
        roles?: AdminRoleData[];
        settingUp: boolean;
        showCircEventsDownload: boolean;
        support_contact_url?: string;
        supportContactText?: string;
        supportContactUrl?: string;
        tos_link_href?: string;
        tos_link_text?: string;
    }
    Index

    Properties

    csrfToken dashboardCollectionsBarChart? email? featureFlags quicksightPagePath roles? settingUp showCircEventsDownload support_contact_url? supportContactText? supportContactUrl? tos_link_href? tos_link_text?

    Properties

    csrfToken: string

    A token generated by the server to prevent Cross-Site Request Forgery. The token should be included in an 'X-CSRF-Token' header in any non-GET requests.

    dashboardCollectionsBarChart?: DashboardCollectionsBarChart

    Configuration for dashboard collections barchart.

    email?: string

    email will be the email address of the currently logged in admin.

    featureFlags: FeatureFlags
    quicksightPagePath: string

    quickSightPagePath contains the URL to the QuickSight dashboard page. Currently, this value does not change, so we can share it via fixed config.

    roles?: AdminRoleData[]

    roles contains the logged in admin's roles and their associated libraries, where appropriate.

    settingUp: boolean

    settingUp will be true if this is a new circulation manager and the admin interface has never been used before. The interface will show a page for configuring admin authentication. The admin will need to set that up and log in before accessing the rest of the interface.

    showCircEventsDownload: boolean

    DEPRECATED. Use the showCircEventsDownload feature flag instead. This can be removed once the backend stops sending it.

    support_contact_url?: string

    Settings for a support contact link. A URL for the application's support contact... For example:

    supportContactText?: string
    supportContactUrl?: string
    tos_link_href?: string

    Optionaltos_link_text

    tos_link_text?: string

    Settings

    Member Visibility

    On This Page

    Properties