Skip to content

Commit

Permalink
chore: Publish next
Browse files Browse the repository at this point in the history
  • Loading branch information
Your Name committed Mar 27, 2024
1 parent 3123dc6 commit 2be38ec
Show file tree
Hide file tree
Showing 55 changed files with 2,916 additions and 2,758 deletions.
109 changes: 71 additions & 38 deletions apis/next/core/Accessibility/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sdk: core

---

Version Accessibility 1.1.1-next.2
Version Accessibility 1.2.0-next.1

## Table of Contents

Expand Down Expand Up @@ -55,21 +55,28 @@ Get the user's preferred audio description settings
To get the value of `audioDescriptionSettings` call the method like this:

```typescript
function audioDescriptionSettings(): Promise<AudioDescriptionSettings>
${method.signature}
```

Promise resolution:

[AudioDescriptionSettings](#audiodescriptionsettings-1)
````typescript
```typescript
````
````
Capabilities:
| Role | Capability |
| ---- | ------------------------------------------------------- |
| Role | Capability |
| --------------------- | -------------------------- |
| uses | xrn:firebolt:capability:accessibility:audiodescriptions |
#### Examples
Getting the audio description settings
JavaScript:
Expand All @@ -79,7 +86,7 @@ import { Accessibility } from '@firebolt-js/sdk'

let settings = await Accessibility.audioDescriptionSettings()
console.log(settings)
```
````

Value of `settings`:

Expand Down Expand Up @@ -121,9 +128,7 @@ Response:
To subscribe to notifications when the value changes, call the method like this:

```typescript
function audioDescriptionSettings(
callback: (value) => AudioDescriptionSettings,
): Promise<number>
function audioDescriptionSettings(callback: (value) => ): Promise<number>
```

Promise resolution:
Expand Down Expand Up @@ -191,21 +196,28 @@ Response:
Get the user's preferred closed-captions settings

```typescript
function closedCaptions(): Promise<ClosedCaptionsSettings>
${method.signature}
```

Promise resolution:

[ClosedCaptionsSettings](../Accessibility/schemas/#ClosedCaptionsSettings)
````typescript
```typescript
````
````
Capabilities:
| Role | Capability |
| ---- | ---------------------------------------------------- |
| Role | Capability |
| --------------------- | -------------------------- |
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
#### Examples
Getting the closed captions settings
JavaScript:
Expand All @@ -215,7 +227,7 @@ import { Accessibility } from '@firebolt-js/sdk'

let closedCaptionsSettings = await Accessibility.closedCaptions()
console.log(closedCaptionsSettings)
```
````

Value of `closedCaptionsSettings`:

Expand Down Expand Up @@ -294,21 +306,28 @@ Get the user's preferred closed-captions settings
To get the value of `closedCaptionsSettings` call the method like this:

```typescript
function closedCaptionsSettings(): Promise<ClosedCaptionsSettings>
${method.signature}
```

Promise resolution:

[ClosedCaptionsSettings](../Accessibility/schemas/#ClosedCaptionsSettings)
````typescript
```typescript
````
````
Capabilities:
| Role | Capability |
| ---- | ---------------------------------------------------- |
| Role | Capability |
| --------------------- | -------------------------- |
| uses | xrn:firebolt:capability:accessibility:closedcaptions |
#### Examples
Getting the closed captions settings
JavaScript:
Expand All @@ -318,7 +337,7 @@ import { Accessibility } from '@firebolt-js/sdk'

let closedCaptionsSettings = await Accessibility.closedCaptionsSettings()
console.log(closedCaptionsSettings)
```
````

Value of `closedCaptionsSettings`:

Expand Down Expand Up @@ -393,9 +412,7 @@ Response:
To subscribe to notifications when the value changes, call the method like this:

```typescript
function closedCaptionsSettings(
callback: (value) => ClosedCaptionsSettings,
): Promise<number>
function closedCaptionsSettings(callback: (value) => ): Promise<number>
```

Promise resolution:
Expand Down Expand Up @@ -606,21 +623,28 @@ See [Listening for events](../../docs/listening-for-events/) for more informatio
Get the user's preferred voice guidance settings

```typescript
function voiceGuidance(): Promise<VoiceGuidanceSettings>
${method.signature}
```

Promise resolution:

[VoiceGuidanceSettings](../Accessibility/schemas/#VoiceGuidanceSettings)
````typescript
```typescript
````
````
Capabilities:
| Role | Capability |
| ---- | --------------------------------------------------- |
| Role | Capability |
| --------------------- | -------------------------- |
| uses | xrn:firebolt:capability:accessibility:voiceguidance |
#### Examples
Getting the voice guidance settings
JavaScript:
Expand All @@ -630,7 +654,7 @@ import { Accessibility } from '@firebolt-js/sdk'

let settings = await Accessibility.voiceGuidance()
console.log(settings)
```
````

Value of `settings`:

Expand Down Expand Up @@ -678,21 +702,28 @@ Get the user's preferred voice guidance settings
To get the value of `voiceGuidanceSettings` call the method like this:

```typescript
function voiceGuidanceSettings(): Promise<VoiceGuidanceSettings>
${method.signature}
```

Promise resolution:

[VoiceGuidanceSettings](../Accessibility/schemas/#VoiceGuidanceSettings)
````typescript
```typescript
````
````
Capabilities:
| Role | Capability |
| ---- | --------------------------------------------------- |
| Role | Capability |
| --------------------- | -------------------------- |
| uses | xrn:firebolt:capability:accessibility:voiceguidance |
#### Examples
Getting the voice guidance settings
JavaScript:
Expand All @@ -702,7 +733,7 @@ import { Accessibility } from '@firebolt-js/sdk'

let settings = await Accessibility.voiceGuidanceSettings()
console.log(settings)
```
````

Value of `settings`:

Expand Down Expand Up @@ -746,9 +777,7 @@ Response:
To subscribe to notifications when the value changes, call the method like this:

```typescript
function voiceGuidanceSettings(
callback: (value) => VoiceGuidanceSettings,
): Promise<number>
function voiceGuidanceSettings(callback: (value) => ): Promise<number>
```

Promise resolution:
Expand Down Expand Up @@ -831,10 +860,14 @@ See: [voiceGuidanceSettings](#voiceguidancesettings)

### AudioDescriptionSettings

````typescript
```typescript
type AudioDescriptionSettings = {
enabled: boolean // Whether or not audio descriptions should be enabled by default
}
````
```



---
```
Loading

0 comments on commit 2be38ec

Please sign in to comment.