BELHop

Namespace: configuration

belhop. configuration

This namespace contains APIs targeting the configuration of the library.

Tutorials:

Methods

staticbelhop.configuration.getAPIURL() {string}

/u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 912

Get the current API URL.

Returns:
Type Description
string Current API URL
Example
> belhop.configuration.getAPIURL()
'http://next.belframework.org/api'

staticbelhop.configuration.getSchemaURL() {string}

/u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 946

Get the current schema URL.

Returns:
Type Description
string Current schema URL
Example
> belhop.configuration.getSchemaURL()
'http://next.belframework.org/schema'

staticbelhop.configuration.setAPIURL(url)

/u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 931

Set the API URL.

Name Type Description
url string

The API URL to use
Example
> // reset to the default URL
> belhop.configuration.setAPIURL(null);

staticbelhop.configuration.setSchemaURL(url)

/u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 965

Set the schema URL.

Name Type Description
url string

The schema URL to use
Example
> // reset to the default URL
> belhop.configuration.setSchemaURL(null);

staticbelhop.configuration.test(cb)

/u01/opt/atlassian/bamboo-home/build-dir/8454146/BH-BN-JOB1/src/belhop.js, line 977

Verify the library configuration and server availability.

Name Type Description
cb belhop.Callback
Tutorials: