OptionaladaptorAllows custom handling of requests which makes testing and supporting non-standard environments easier.
OptionalbaseOverride 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.
Hub name to retrieve content from, used in creating the Content Delivery V2 and Fresh API hostname, which contains the hub name
Example:
OptionallocaleIf 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.
OptionalmediaAllows users with custom hostnames to override the hostname used when constructing media URLs. E.g. images.mywebsite.com.
OptionalpreviewIf set with stagingEnvironment, the SDK will send previewKey as an x-api-key header
OptionalsecureAllows users with custom hostnames to override the hostname used when constructing secure media URLs. E.g. images.mywebsite.com.
OptionalsigningIf set with stagingEnvironment, the SDK will send requests to the signing proxy address instead
OptionalstagingIf 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”.
OptionaltimeoutIf set, requests made will timeout after the number of milliseconds specified in this field. Set to 0 to disable timeout. Defaults to 0.
Configuration settings for Content Delivery V2 API.