userPreferences.voiceGuidance()

Prev

userPreferences.voiceGuidance()

Retrieves the voiceGuidance user preferences.

Signature:

$badger.userPreferences().voiceGuidance();

Parameters:

None.

Return Values:

Returns a promise that is called with the voiceGuidance settings.

voiceGuidanceSettings object

enabled (boolean): true if voiceGuidance is enabled, false otherwise

Usage Example:

$badger.userPreferences().voiceGuidance()
    .success(function(data) {	
		    console.log(JSON.stringify(data));
		})
    .failure(function(err) {
		    console.log(JSON.stringify(err));
		});