Module: Live Update Service API

Methods

(async, static) disableFeature(featureId) → {Promise}

Turn the feature with the given featureID OFF
Parameters:
Name Type Description
featureId string The feature ID as defined in the Mobile Foundation Live Update Service
Returns:
The promise is resolved if the feature was disabled and rejected if the feature was not disabled
Type
Promise

(async, static) enableFeature(featureId) → {Promise}

Turn the feature with the given featureID ON
Parameters:
Name Type Description
featureId string The feature ID as defined in the Mobile Foundation Live Update Service
Returns:
The promise is resolved if the feature was enabled and rejected if the feature was not enabled
Type
Promise

(async, static) getProperty(propertyId) → {Promise}

Returns the value of the property set in the Mobile Foundation Live Update Service
Parameters:
Name Type Description
propertyId string The property ID whose value is to be returned
Returns:
The promise is resolved with the property value upon success and rejected with the error message on failure
Type
Promise

(async, static) isFeatureEnabled(featureId) → {Promise}

Returns whether or not a feature with the given feature ID is enabled
Parameters:
Name Type Description
featureId string The feature ID as defined in the Mobile Foundation Live Update Service
Returns:
True/False if the feature is enabled. Error if the feature doesn't exist or the Live Update service returns an error
Type
Promise

(async, static) setProperty(propertyId, propertyName, value, description) → {Promise}

Sets the value of the property in the Mobile Foundation Live Update Service. Creates a new property if one doesn't exist
Parameters:
Name Type Description
propertyId string The property ID whose value is to be set
propertyName string The name of the property to be set
value string The value of the property to be set
description string The description of the property to be set
Returns:
The promise is resolved upon success and rejected with the error message on failure
Type
Promise