voltmx.application.settings Namespace

This function enables your app to read the configuration values associated with specified keys.

Syntax

voltmx.application.settings.read(  
    key,  
    onsuccesscallback,  
    onfailureback)

Input Parameters

Example

read: function() {

    voltmx.application.settings.read("key1", this.onsuccesscallbackR, this.onfailureback);
    voltmx.application.settings.read("key2", this.onsuccesscallbackR, this.onfailurebackR);
},

onfailureback: function(errorcode, errormessage) {
    alert("err is :" + errormessage);
},
onsuccesscallbackR: function(key, value) {
    var params = {};
    params.value = value;

    switch (value) {
        case "Table view":
            params.viewType = constants.SEGUI_VIEW_TYPE_TABLEVIEW;
            break;
        case "Page view":
            params.viewType = constants.SEGUI_VIEW_TYPE_PAGEVIEW;
            params.pageOffDotImage = "orngsld";
            params.pageOnDotImage = "whitesld";
            break;
        case "Coverflow view":
            params.viewType = constants.SEGUI_VIEW_TYPE_COVERFLOW;
            break;
        case "Cylinder view":
            params.viewType = constants.SEGUI_VIEW_TYPE_CYLINDER;
            break;
        case "Linear view":
            params.viewType = constants.SEGUI_VIEW_TYPE_LINEAR;
            break;
        case "Stack view":
            params.viewType = constants.SEGUI_VIEW_TYPE_STACK;
            break;

    }
    var ntf = new voltmx.mvc.Navigation("frmAppSetRead");
    ntf.navigate(params);
},

onfailurebackR: function(errorcode, errormessage) {
    alert("Err is :" + errormessage);
}

Return Values

None.

Remarks

This function reads an app’s settings from the settings file that is bundled with the application’s binary. Your app can use this function to read, among other things, the user-defined values such as the preferred locations.

This is an asynchronous call so it returns immediately. Upon successfully reading the app’s settings, the Volt MX Iris API framework automatically invokes the callback your app passes in the onsuccesscallback parameter. The callback function has the following signature.

onsuccess(key, value);

When this callback function is invoked, the key parameter contains a string that specifies the name of the key whose value is being retrieved.

The value parameter contains the settings that were read. It can be Boolean, string, double, or an object. It contains an object when Display option is set to multiselect.

If the Volt MX Iris API framework cannot read the settings associated with the key parameter to the voltmx.application.settings.read function, then the framework automatically invokes the function in the onfailurecallback parameter. The callback function has the following signature.

onfailure(errorcode,errormessage);

When the framework calls the onfailure callback function errorcode parameter of contains a numeric error code and the errormessage parameter contains the corresponding error message as a string.

Platform Availability

Available only on iPhone

This function enables your app to write values associated with specified keys.

Syntax

voltmx.application.settings.write(  
    key,  
    value,  
    onsuccesscallback,  
    onfailurecallback);

Input Parameters

Example

write: function() {

    var str1 = this.view.txtMsg.text + " ";
    var str2 = this.view.lstBxType.selectedKey;

    voltmx.application.settings.write("key1", str1, this.onsuccesscallbackw, this.onfailurebackw);
    voltmx.application.settings.write("key2", str2, this.onsuccesscallbackWrite, this.onfailurebackWrite);

},
onsuccesscallbackw: function(key, value) {
    voltmx.print("Value is :" + value);
},

onfailurebackw: function(errorcode, errormessage) {
    alert("Error is :" + errormessage);
},


onsuccesscallbackWrite: function(key, value) {

    this.view.lblAppAfterSet.text = "App settings are successful";


},
onfailurebackWrite: function(errorcode, errormessage) {
    alert("Error is :" + errormessage);
}

Return Values

None.

Remarks

This function sets the value of configuration options in the configuration file that is associated with the app. New keys cannot be introduced with this function. Your app can only write to existing keys. This is an asynchronous call, so it returns immediately and does not wait for the underlying hardware to write the value to the specified key. It uses callback functions to communicate success or failure. The callback functions for success and failure are set using this function’s onsuccesscallback and onfailurecallback, respectively.

The callback function for the onsuccesscallback parameter of the voltmx.application.settings.write function has the following

syntax.

onsuccesscallback(key,value);

where the key parameter to this callback is a string containing the name of the key that was set, and the callback function’s value parameter contains the value that the key was set to. The callback function’s value parameter can be boolean, string, double, or an object. An object is only passed in through the value parameter when “Display option” is multiselect.

If the voltmx.application.settings.write function cannot set the value of the specified key, in invokes another callback function. The callback function for the voltmx.application.settings.write function’s onfailurecallback parameter has the following syntax.

onfailurecallback(errorcode,errormessage);

where the errorcode parameter contains a numeric error code and the errormessage parameter holds a string that specifies the error message.

Platform Availability

Available only on iPhone