Version

WebDashboard.Settings.load

This method is used to load custom settings that were previously saved.

Syntax

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

WebDashboard.Settings.load Parameters

Parameter

Type

Description

key

String

Ynique key for the custom settings to be loaded.

onSuccess callback function

Parameter

Description

function (settings)

Success callback function to be implemented, which receives a JSON Object with the configuration settings loaded.

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.