Class: MobileBackend

Members

---

<readonly> Analytics :Analytics

Returns the Analytics object that enables capture of mobile analytics events.

Returns the Analytics object that enables capture of mobile analytics events.

Type:

• Analytics

Deprecated:

• Will be deleted in next version. Use MobileBackend#analytics instead.

Source:

• mobile-backend/mobile-backend.js, line 108

---

analytics

Returns the Analytics object that enables capture of mobile analytics events.

Returns the Analytics object that enables capture of mobile analytics events.

Source:

• mobile-backend/mobile-backend.js, line 106

---

appConfig

Returns an instance of the application configuration object.

Returns an instance of the application configuration object. Callers can download the configuration from the service by invoking loadAppConfig().

Source:

• mobile-backend/mobile-backend.js, line 187

---

<readonly> AppConfig :Object

Returns an instance of the application configuration object.

Returns an instance of the application configuration object. Callers can download the configuration from the service by invoking loadAppConfig().

Type:

• Object

Deprecated:

• Will be deleted in next version. Use MobileBackend#appConfig instead.

Source:

• mobile-backend/mobile-backend.js, line 189

---

authorization

Get current authorization object.

Get current authorization object.

Source:

• mobile-backend/mobile-backend.js, line 50

---

<readonly> Authorization :Authorization

Current authorization object.

Current authorization object.

Type:

• Authorization

Deprecated:

• Will be removed in next version. Use MobileBackend#authorization instead.

Source:

• mobile-backend/mobile-backend.js, line 52

---

<readonly> CustomCode :CustomCode

Returns the CustomCode object that enables calls to custom APIs.

Returns the CustomCode object that enables calls to custom APIs.

Type:

• CustomCode

Deprecated:

• Will be deleted in next version. Use MobileBackend#customCode instead.

Source:

• mobile-backend/mobile-backend.js, line 89

---

customCode

Returns the CustomCode object that enables calls to custom APIs.

Returns the CustomCode object that enables calls to custom APIs.

Source:

• mobile-backend/mobile-backend.js, line 87

---

diagnostics

Returns the Diagnostics object that enables end-end debugging across application and cloud.

Returns the Diagnostics object that enables end-end debugging across application and cloud.

Source:

• mobile-backend/mobile-backend.js, line 69

---

Diagnostics :Diagnostics

Returns the Diagnostics object that enables end-end debugging across application and cloud.

Returns the Diagnostics object that enables end-end debugging across application and cloud.

Type:

• Diagnostics

Deprecated:

• Will be deleted in next version. Use MobileBackend#diagnostics instead.

Source:

• mobile-backend/mobile-backend.js, line 71

---

<readonly> name :String

The name of the MobileBackend as read from the configuration.

The name of the MobileBackend as read from the configuration.

Type:

• String

Source:

• mobile-backend/mobile-backend.js, line 37

---

notifications

Returns the Notifications object that provides notification capabilities.

Returns the Notifications object that provides notification capabilities.

Source:

• mobile-backend/mobile-backend.js, line 166

---

<readonly> Notifications :Notifications

Returns the Notifications object that provides notification capabilities.

Returns the Notifications object that provides notification capabilities.

Type:

• Notifications

Deprecated:

• Will be deleted in next version. Use MobileBackend#notifications instead.

Source:

• mobile-backend/mobile-backend.js, line 168

---

storage

Returns the Storage object that provides cloud-based object storage capabilities.

Returns the Storage object that provides cloud-based object storage capabilities.

Source:

• mobile-backend/mobile-backend.js, line 125

---

<readonly> Storage :Storage

Returns the Storage object that provides cloud-based object storage capabilities.

Returns the Storage object that provides cloud-based object storage capabilities.

Type:

• Storage

Deprecated:

• Will be deleted in next version. Use MobileBackend#storage instead.

Source:

• mobile-backend/mobile-backend.js, line 127

---

synchronization

Returns the Synchronization object that provides caching and synchronization capabilities.

Returns the Synchronization object that provides caching and synchronization capabilities.

Source:

• mobile-backend/mobile-backend.js, line 158

---

<readonly> synchronization :Synchronization

Returns the Synchronization object that provides caching and synchronization capabilities.

Returns the Synchronization object that provides caching and synchronization capabilities.

Type:

• Synchronization

Deprecated:

• Will be deleted in next version. Use MobileBackend#synchronization instead.

Source:

• mobile-backend/mobile-backend.js, line 141

Methods

---

getAuthenticationType()

Returns the Authentication type.

Returns the Authentication type.

Source:

• mobile-backend/mobile-backend.js, line 316

Returns:

Authentication type

Type

String

---

getAuthenticationTypeVariable()

Returns the Authentication type.

Returns the Authentication type.

Deprecated:

• Will be deleted in next version. Use MobileBackend#getAuthenticationType instead.

Source:

• mobile-backend/mobile-backend.js, line 299

Returns:

Authentication type

Type

String

---

getCustomCodeUrl(path)

Constructs a full URL by prepending the prefix for custom API REST endpoints to the given endpoint path.

Constructs a full URL by prepending the prefix for custom API REST endpoints to the given endpoint path.

Parameters:

Name	Type	Description
path	String	The relative path of the endpoint following the platform prefix, i.e. {BaseUrl}/mobile/custom.

Source:

• mobile-backend/mobile-backend.js, line 230

Returns:

The full URL.

Type

String

---

getHttpHeaders(headers)

Populates auth and diagnostics HTTP headers for making REST calls to a mobile backend.

Populates auth and diagnostics HTTP headers for making REST calls to a mobile backend.

Parameters:

Name	Type	Argument	Description
headers	Object	<optional>	An optional object with which to populate with the headers.

Source:

• mobile-backend/mobile-backend.js, line 264

Returns:

The headers parameter that is passed in. If not provided, a new object with the populated headers as properties of that object is created.

Type

Object

---

getOAuthTokenUrl()

Constructs a full URL, including the prefix, for the OAuth token endpoint.

Constructs a full URL, including the prefix, for the OAuth token endpoint.

Source:

• mobile-backend/mobile-backend.js, line 238

Returns:

The full URL for the OAuth token endpoint.

Type

String

---

getPlatformUrl(path)

Constructs a full URL by prepending the prefix for platform API REST endpoints to the given endpoint path.

Constructs a full URL by prepending the prefix for platform API REST endpoints to the given endpoint path.

Parameters:

Name	Type	Description
path	String	The relative path of the endpoint following the platform prefix, i.e. {BaseUrl}/mobile/platform.

Source:

• mobile-backend/mobile-backend.js, line 208

Returns:

The full URL.

Type

String

---

getSSOAuthTokenUrl()

Constructs a full URL, including the prefix, for the SSO token endpoint.

Constructs a full URL, including the prefix, for the SSO token endpoint.

Source:

• mobile-backend/mobile-backend.js, line 250

Returns:

The full URL for the SSO token endpoint.

Type

String

---

loadAppConfig(successCallback, errorCallback)

Downloads the configuration from the service.

Downloads the configuration from the service. The AppConfig property will contain the downloaded configuration.

Parameters:

Name	Type	Argument	Description
successCallback	MobileBackend~appConfigSuccessCallback	<optional>	Optional callback invoked on success (deprecated use promises instead).
errorCallback	MobileBackend~errorCallback	<optional>	Optional callback invoked on failure (deprecated use promises instead).

Source:

• mobile-backend/mobile-backend.js, line 411

Returns:

Type

Promise.<(NetworkResponse|NetworkResponse)>

---

setAuthenticationType()

Returns the Authorization object that provides authorization capabilities and access to user properties.

Returns the Authorization object that provides authorization capabilities and access to user properties.

Parameters:

Name	Type	Description
type.	string	For Basic Authentication, you would specify "basicAuth" to use the Basic Authentication security schema. For OAuth authentication, you would specify "oAuth" to use OAuth Authentication security schema. If you put any type other than those two, it will throw an Exception stating that the type of Authentication that you provided is not supported at this time.

Source:

• mobile-backend/mobile-backend.js, line 341

Examples

<caption>Example usage of mobileBackend.setAuthenticationType()</caption>

var mobileBackend = mcs.mobileBackendManager.getMobileBackend('YOUR_BACKEND_NAME');

mobileBackend.setAuthenicationType("basicAuth");
//Basic Authorization schema

mobileBackend.setAuthenicationType("oAuth");
//OAuth Authorization schema

mobileBackend.setAuthenicationType("facebookAuth");
//Facebook Authorization schema

mobileBackend.setAuthenicationType("ssoAuth");
//Single Sign On Authorization schema

mobileBackend.setAuthenicationType("tokenAuth");
//Token Exchange Authorization schema

---

setAuthenticationTypeVariable(type)

Sets Authentication variable for MobileBackend.

Sets Authentication variable for MobileBackend.

Parameters:

Name	Type	Description
type

Deprecated:

• Will be deleted in next version. Use MobileBackend#setAuthenticationType instead.

Source:

• mobile-backend/mobile-backend.js, line 308

Type Definitions

---

appConfigSuccessCallback(statusCode, appConfig)

Callback invoked after downloading the application configuration.

Callback invoked after downloading the application configuration.

Parameters:

Name	Type	Description
statusCode	Number	Any HTTP status code returned from the server, if available.
appConfig	Object	The downloaded application configuration object.

Deprecated:

• Use promises instead

Source:

• mobile-backend/mobile-backend.js, line 389

---

errorCallback(statusCode, message)

Callback invoked on an error while downloading the application configuration.

Callback invoked on an error while downloading the application configuration.

Parameters:

Name	Type	Description
statusCode	Number	Any HTTP status code returned from the server, if available.
message	String	The HTTP payload from the server, if available, or an error message.

Deprecated:

• Use promises instead

Source:

• mobile-backend/mobile-backend.js, line 397