dc-delivery-sdk-js
    Preparing search index...

    Interface ContentClientConfigV1

    Configuration settings for Content Delivery V1 API.

    interface ContentClientConfigV1 {
        account: string;
        adaptor?: AxiosAdapter;
        baseUrl?: string;
        locale?: string;
        mediaHost?: string;
        previewKey?: string;
        secureMediaHost?: string;
        signingProxyAddress?: string;
        stagingEnvironment?: string;
        timeout?: number;
    }

    Hierarchy (View Summary)

    Index

    Properties

    account adaptor? baseUrl? locale? mediaHost? previewKey? secureMediaHost? signingProxyAddress? stagingEnvironment? timeout?

    Properties

    account: string

    Account to retrieve content from.

    adaptor?: AxiosAdapter

    Allows custom handling of requests which makes testing and supporting non-standard environments easier.

    baseUrl?: string

    Override for the content delivery API base URL. If “stagingEnvironment” is set the sdk will automatically update the baseUrl to load content from the virtual staging environment.

    locale?: string

    If set, the SDK will request content using the locale settings provided. If your content contains any localized fields, this will cause a single locale to be returned rather than the complete list of values.

    mediaHost?: string

    Allows users with custom hostnames to override the hostname used when constructing media URLs. E.g. images.mywebsite.com.

    previewKey?: string

    If set with stagingEnvironment, the SDK will send previewKey as an x-api-key header

    secureMediaHost?: string

    Allows users with custom hostnames to override the hostname used when constructing secure media URLs. E.g. images.mywebsite.com.

    signingProxyAddress?: string

    If set with stagingEnvironment, the SDK will send requests to the signing proxy address instead

    stagingEnvironment?: string

    If set, the SDK will request content and media from the staging environment host name specified. This will override any values set for “baseUrl”, “mediaHost” and “secureMediaHost”.

    timeout?: number

    If set, requests made will timeout after the number of milliseconds specified in this field. Set to 0 to disable timeout. Defaults to 0.

    Settings

    Member Visibility

    On This Page

    Properties