Version

API Reference Table

WebDashboard.Settings.save

This method is used to save custom settings for the SharePlus Mobile Workspace. The settings can be any JSON object and they persist even if SharePlus is shut down.

Syntax

SPlus.WebDashboard.Settings.save (settings, key, function (){
        //TODO: Implementation
}, function (errorResponse){
        var error = errorResponse['error#displayValue']; //Getting the error
        //TODO: Implement how to handle errors
});

WebDashboard.Settings.save Parameters

Parameter

Type

Description

settings

JSON Object

Custom settings to be saved.

key

String

Sets the unique key for custom settings.

onSuccess callback function

Parameter

Description

function ()

Success callback function to be implemented.

onError callback function

Parameter

Description

function (eResponse)

Error callback function to be implemented, which receives the eResponse JavaScript Object.

Sample

For a sample with this API method, refer to the Persisting SharePlus Mobile Workspaces Settings bridge scenario.