---
title: "userPreferences.voiceGuidance()"
slug: "voiceguidance-1"
updated: 2024-07-17T19:08:53Z
published: 2024-07-17T19:08:53Z
canonical: "docs.developer.comcast.com/voiceguidance-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.developer.comcast.com/llms.txt
> Use this file to discover all available pages before exploring further.

# userPreferences.voiceGuidance()

## 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));
		});
```