@coveo/headless-react
    Preparing search index...

    Interface UpdateSearchConfigurationActionCreatorPayload

    interface UpdateSearchConfigurationActionCreatorPayload {
        authenticationProviders?: string[];
        locale?: string;
        pipeline?: string;
        proxyBaseUrl?: string;
        searchHub?: string;
        timezone?: string;
    }
    Index

    Properties

    authenticationProviders? locale? pipeline? proxyBaseUrl? searchHub? timezone?

    Properties

    authenticationProviders?: string[]

    Specifies the name of the authentication providers to use to perform queries.

    See SAML Authentication.

    locale?: string

    The locale of the current user. Must comply with IETF’s BCP 47 definition: https://www.rfc-editor.org/rfc/bcp/bcp47.txt.

    pipeline?: string

    The name of the query pipeline to use for the query (for example, External Search).

    proxyBaseUrl?: string

    The base URL to use to proxy Coveo search requests (for example, https://example.com/search).

    This is an advanced option that you only set if you proxy Coveo searchrequests through your own server. In most cases, you should not set this option.

    See Headless proxy: Search.

    searchHub?: string

    The first level of origin of the request, typically the identifier of the graphical search interface from which the request originates (for example, ExternalSearch).

    timezone?: string

    The tz database identifier of the time zone of the user.

    Settings

    Member Visibility
    In this article
    Properties