Package com.subaio.subaio

Class SubaioConfiguration

java.lang.Object

com.subaio.subaio.SubaioConfiguration

public final class SubaioConfiguration
extends java.lang.Object

Configuration passed to `SubaioManager.getInstance().configure`.

Constructor Summary

Constructors

Constructor	Description
SubaioConfiguration(java.lang.String baseUrl)	Initialize a Subaio configuration object with the given parameters
SubaioConfiguration(java.lang.String baseUrl, boolean allowExternalUrls, boolean allowShare)	Initialize a Subaio configuration object with the given parameters
SubaioConfiguration(java.lang.String baseUrl, boolean allowExternalUrls, boolean allowShare, boolean disableSSLPinning)	Initialize a Subaio configuration object with the given parameters
SubaioConfiguration(java.lang.String baseUrl, java.util.Map<java.lang.String,java.lang.String> customConfig)	Initialize a Subaio configuration object with the given parameters
SubaioConfiguration(java.lang.String baseUrl, java.util.Map<java.lang.String,java.lang.String> customConfig, boolean allowExternalUrls, boolean allowShare)	Initialize a Subaio configuration object with the given parameters
SubaioConfiguration(java.lang.String baseUrl, java.util.Map<java.lang.String,java.lang.String> customConfig, boolean allowExternalUrls, boolean allowShare, boolean disableSSLPinning)	Initialize a Subaio configuration object with the given parameters

Method Summary

Modifier and Type	Method	Description
java.lang.String	getBaseUrl()	URL pointing to root of Subaio template, e.g.
java.util.Map<java.lang.String,java.lang.String>	getCustomConfig()	The custom configuration-values sent to all views.
boolean	isExternalUrlsAllowed()	Boolean used to control whether or not Subaio is allowed to open external URLs.
boolean	isSharingAllowed()	Boolean used to control whether or not Subaio is allowed to open share.
boolean	isSSLPinningDisabled()	Indicates if SSL pinning is disabled.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SubaioConfiguration

public SubaioConfiguration(@NonNull
                           java.lang.String baseUrl,
                           @NonNull
                           java.util.Map<java.lang.String,java.lang.String> customConfig,
                           @NonNull
                           boolean allowExternalUrls,
                           @NonNull
                           boolean allowShare,
                           boolean disableSSLPinning)

Initialize a Subaio configuration object with the given parameters

Parameters:

baseUrl - URL pointing to root of Subaio template, e.g. if template is at `https://www.bar.foo/template`, then baseUrl should be `https://www.bar.foo`

customConfig - Custom named values (such as customizable colors) sent to the views.

allowExternalUrls - Allow opening of external urls

allowShare - Allow sharing events

disableSSLPinning - Disables SSL pinning if true

SubaioConfiguration

public SubaioConfiguration(@NonNull
                           java.lang.String baseUrl,
                           @NonNull
                           java.util.Map<java.lang.String,java.lang.String> customConfig,
                           @NonNull
                           boolean allowExternalUrls,
                           @NonNull
                           boolean allowShare)

Initialize a Subaio configuration object with the given parameters

Parameters:

baseUrl - URL pointing to root of Subaio template, e.g. if template is at `https://www.bar.foo/template`, then baseUrl should be `https://www.bar.foo`

customConfig - Custom named values (such as customizable colors) sent to the views.

allowExternalUrls - Allow opening of external urls

allowShare - Allow sharing events

SubaioConfiguration

public SubaioConfiguration(@NonNull
                           java.lang.String baseUrl,
                           @NonNull
                           java.util.Map<java.lang.String,java.lang.String> customConfig)

Initialize a Subaio configuration object with the given parameters

Parameters:

baseUrl - URL pointing to root of Subaio template, e.g. if template is at `https://www.bar.foo/template`, then baseUrl should be `https://www.bar.foo`

customConfig - Custom named values (such as customizable colors) sent to the views.

SubaioConfiguration

public SubaioConfiguration(@NonNull
                           java.lang.String baseUrl,
                           @NonNull
                           boolean allowExternalUrls,
                           @NonNull
                           boolean allowShare)

Initialize a Subaio configuration object with the given parameters

Parameters:

baseUrl - URL pointing to root of Subaio template, e.g. if template is at `https://www.bar.foo/template`, then baseUrl should be `https://www.bar.foo`

allowExternalUrls - Allow opening of external urls

allowShare - Allow sharing events

SubaioConfiguration

public SubaioConfiguration(@NonNull
                           java.lang.String baseUrl,
                           @NonNull
                           boolean allowExternalUrls,
                           @NonNull
                           boolean allowShare,
                           boolean disableSSLPinning)

Initialize a Subaio configuration object with the given parameters

Parameters:

baseUrl - URL pointing to root of Subaio template, e.g. if template is at `https://www.bar.foo/template`, then baseUrl should be `https://www.bar.foo`

allowExternalUrls - Allow opening of external urls

allowShare - Allow sharing events

disableSSLPinning - Disables SSL pinning if true

SubaioConfiguration

public SubaioConfiguration(@NonNull
                           java.lang.String baseUrl)

Initialize a Subaio configuration object with the given parameters

Parameters:

baseUrl - URL pointing to root of Subaio template, e.g. if template is at `https://www.bar.foo/template`, then baseUrl should be `https://www.bar.foo`

Method Detail

getBaseUrl

public java.lang.String getBaseUrl()

URL pointing to root of Subaio template, e.g. if template is at `https://www.bar.foo/template`, then baseUrl should be `https://www.bar.foo`

Returns:

base URL

isExternalUrlsAllowed

public boolean isExternalUrlsAllowed()

Boolean used to control whether or not Subaio is allowed to open external URLs.

Returns:

true if external urls are allowed

isSharingAllowed

public boolean isSharingAllowed()

Boolean used to control whether or not Subaio is allowed to open share.

Returns:

true if sharing is allowed

isSSLPinningDisabled

public boolean isSSLPinningDisabled()

Indicates if SSL pinning is disabled. Use for debugging purposes.

Returns:

true if SSL pinning is disabled

getCustomConfig

public java.util.Map<java.lang.String,java.lang.String> getCustomConfig()

The custom configuration-values sent to all views.

Returns:

map of custom config