Package com.zendesk.sdk.network

Interface SdkOptions

All Known Implementing Classes:

DefaultSdkOptions

public interface SdkOptions

Defines behaviour for controlling optional behaviour of the SDK.

Behaviour should only be defined here if it is truly optional and it is usually the case where the behaviour presents a workaround. Think of it like a quirks mode.

If you specify an SdkOptions in ZendeskConfig.setSdkOptions(SdkOptions) it will be used. If you don't then DefaultSdkOptions will be used.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SdkOptions.ServiceOptions Defines behaviour for controlling network services that the SDK uses.

Method Summary

Modifier and Type	Method and Description
SdkOptions.ServiceOptions	getServiceOptions() Gets the parameters used for overriding behaviour in service classes.
boolean	overrideResourceLoadingInWebview() Determines whether overriding resource loading is allowed in webviews.

Method Detail

overrideResourceLoadingInWebview

boolean overrideResourceLoadingInWebview()

Determines whether overriding resource loading is allowed in webviews.

ViewArticleActivity contains a webview. This usually works fine but sometimes a Help Center is available only to logged in users. In this case we need to override the resource loading if we want to see the inline resources such as images. We do this by adding an authorisation header but this changes the behaviour of the webview from loading the text first and images after to loading the images first and text after.

If you have a restricted Help Center you almost definitely want to return true from this.

Returns:

true if overriding resource loading is allowed. False otherwise.

getServiceOptions

SdkOptions.ServiceOptions getServiceOptions()

Gets the parameters used for overriding behaviour in service classes.

The default implementation will specify the correct parameters to use so overriding this is rarely required.

Returns:

The parameters that service classes will use