Skip to main content

Options Class

Options manages configuration parameters used by the Client . Parameters are set via a fluent interface.

Example

Options opts = new Options()
.sitekey('FC0123456789ABCD')
.timeout(500);

System.debug(opts.sitekey());

Methods​

sitekey()​

Signature​

global String sitekey()

Return Type​

String


sitekey(sitekey)​

Signature​

global Options sitekey(String sitekey)

Parameters​

NameTypeDescription
sitekeyString

Return Type​

Options


apiKey()​

Signature​

global String apiKey()

Return Type​

String


apiKey(apiKey)​

Signature​

global Options apiKey(String apiKey)

Parameters​

NameTypeDescription
apiKeyString

Return Type​

Options


apiEndpoint()​

Signature​

global String apiEndpoint()

Return Type​

String


apiEndpoint(apiEndpoint)​

Signature​

global Options apiEndpoint(String apiEndpoint)

Parameters​

NameTypeDescription
apiEndpointString

Return Type​

Options


strict()​

Signature​

global Boolean strict()

Return Type​

Boolean


strict(strict)​

Signature​

global Options strict(Boolean strict)

Parameters​

NameTypeDescription
strictBoolean

Return Type​

Options


timeout()​

Signature​

global Integer timeout()

Return Type​

Integer


timeout(timeout)​

Signature​

global Options timeout(Integer timeout)

Parameters​

NameTypeDescription
timeoutInteger

Return Type​

Options

Classes​

InvalidOptionsException Class​