-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Publish pr-feature-next-major-docs
- Loading branch information
Your Name
committed
Mar 11, 2024
1 parent
cacbc67
commit 946ee24
Showing
73 changed files
with
86,926 additions
and
0 deletions.
There are no files selected for viewing
840 changes: 840 additions & 0 deletions
840
apis/pr-feature-next-major-docs/core/Accessibility/index.md
Large diffs are not rendered by default.
Oops, something went wrong.
154 changes: 154 additions & 0 deletions
154
apis/pr-feature-next-major-docs/core/Accessibility/schemas/index.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,154 @@ | ||
--- | ||
title: Accessibility | ||
|
||
version: pr-feature-next-major-docs | ||
layout: default | ||
sdk: core | ||
--- | ||
|
||
# Accessibility | ||
|
||
--- | ||
|
||
Version Accessibility 0.0.0-unknown.0 | ||
|
||
## Table of Contents | ||
|
||
- [Table of Contents](#table-of-contents) | ||
- [Overview](#overview) | ||
- [Types](#types) | ||
- [FontFamily](#fontfamily) | ||
- [VoiceSpeed](#voicespeed) | ||
- [VoiceGuidanceSettings](#voiceguidancesettings) | ||
- [FontSize](#fontsize) | ||
- [Color](#color) | ||
- [FontEdge](#fontedge) | ||
- [Opacity](#opacity) | ||
- [HorizontalAlignment](#horizontalalignment) | ||
- [VerticalAlignment](#verticalalignment) | ||
- [ClosedCaptionsStyles](#closedcaptionsstyles) | ||
- [ClosedCaptionsSettings](#closedcaptionssettings) | ||
|
||
## Overview | ||
|
||
undefined | ||
|
||
## Types | ||
|
||
### FontFamily | ||
|
||
```typescript | ||
type FontFamily = string | ||
``` | ||
--- | ||
### VoiceSpeed | ||
```typescript | ||
type VoiceSpeed = number | ||
``` | ||
--- | ||
### VoiceGuidanceSettings | ||
```typescript | ||
type VoiceGuidanceSettings = { | ||
enabled: boolean // Whether or not voice guidance should be enabled by default | ||
speed: VoiceSpeed | ||
} | ||
``` | ||
See also: | ||
number | ||
--- | ||
### FontSize | ||
```typescript | ||
type FontSize = number | ||
``` | ||
--- | ||
### Color | ||
```typescript | ||
type Color = string | ||
``` | ||
--- | ||
### FontEdge | ||
```typescript | ||
type FontEdge = string | ||
``` | ||
--- | ||
### Opacity | ||
```typescript | ||
type Opacity = number | ||
``` | ||
--- | ||
### HorizontalAlignment | ||
```typescript | ||
type HorizontalAlignment = string | ||
``` | ||
--- | ||
### VerticalAlignment | ||
```typescript | ||
type VerticalAlignment = string | ||
``` | ||
--- | ||
### ClosedCaptionsStyles | ||
The default styles to use when displaying closed-captions | ||
```typescript | ||
type ClosedCaptionsStyles = { | ||
fontFamily?: string | ||
fontSize?: number | ||
fontColor?: string | ||
fontEdge?: string | ||
fontEdgeColor?: string | ||
fontOpacity?: number | ||
backgroundColor?: string | ||
backgroundOpacity?: number | ||
textAlign?: string | ||
textAlignVertical?: string | ||
windowColor?: string | ||
windowOpacity?: number | ||
} | ||
``` | ||
--- | ||
### ClosedCaptionsSettings | ||
```typescript | ||
type ClosedCaptionsSettings = { | ||
enabled: boolean // Whether or not closed-captions should be enabled by default | ||
styles: ClosedCaptionsStyles // The default styles to use when displaying closed-captions | ||
preferredLanguages?: string[] | ||
} | ||
``` | ||
See also: | ||
[ClosedCaptionsStyles](#closedcaptionsstyles) | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,172 @@ | ||
--- | ||
title: Account | ||
|
||
version: pr-feature-next-major-docs | ||
layout: default | ||
sdk: core | ||
--- | ||
|
||
# Account Module | ||
|
||
--- | ||
|
||
Version Account 1.1.1-feature-next-major-docs.0 | ||
|
||
## Table of Contents | ||
|
||
- [Table of Contents](#table-of-contents) | ||
- [Usage](#usage) | ||
- [Overview](#overview) | ||
- [Methods](#methods) | ||
- [id](#id) | ||
- [uid](#uid) | ||
|
||
## Usage | ||
|
||
To use the Account module, you can import it into your project from the Firebolt SDK: | ||
|
||
```javascript | ||
import { Account } from '@firebolt-js/sdk' | ||
``` | ||
|
||
## Overview | ||
|
||
A module for querying about the device account. | ||
|
||
## Methods | ||
|
||
### id | ||
|
||
Get the platform back-office account identifier | ||
|
||
To get the value of `id` call the method like this: | ||
|
||
```typescript | ||
function id(): Promise<string> | ||
``` | ||
|
||
Promise resolution: | ||
|
||
```typescript | ||
string | ||
``` | ||
|
||
Capabilities: | ||
|
||
| Role | Capability | | ||
| ---- | ---------------------------------- | | ||
| uses | xrn:firebolt:capability:account:id | | ||
|
||
#### Examples | ||
|
||
Default Example | ||
|
||
JavaScript: | ||
|
||
```javascript | ||
import { Account } from '@firebolt-js/sdk' | ||
let id = await Account.id() | ||
console.log(id) | ||
``` | ||
|
||
Value of `id`: | ||
|
||
```javascript | ||
'123' | ||
``` | ||
|
||
<details markdown="1" > | ||
<summary>JSON-RPC:</summary> | ||
Request: | ||
|
||
```json | ||
{ | ||
"jsonrpc": "2.0", | ||
"id": 1, | ||
"method": "Account.id", | ||
"params": {} | ||
} | ||
``` | ||
|
||
Response: | ||
|
||
```json | ||
{ | ||
"jsonrpc": "2.0", | ||
"id": 1, | ||
"result": "123" | ||
} | ||
``` | ||
|
||
</details> | ||
|
||
--- | ||
|
||
### uid | ||
|
||
Gets a unique id for the current app & account | ||
|
||
To get the value of `uid` call the method like this: | ||
|
||
```typescript | ||
function uid(): Promise<string> | ||
``` | ||
|
||
Promise resolution: | ||
|
||
```typescript | ||
string | ||
``` | ||
|
||
Capabilities: | ||
|
||
| Role | Capability | | ||
| ---- | ----------------------------------- | | ||
| uses | xrn:firebolt:capability:account:uid | | ||
|
||
#### Examples | ||
|
||
Getting the unique ID | ||
|
||
JavaScript: | ||
|
||
```javascript | ||
import { Account } from '@firebolt-js/sdk' | ||
let uniqueId = await Account.uid() | ||
console.log(uniqueId) | ||
``` | ||
|
||
Value of `uniqueId`: | ||
|
||
```javascript | ||
'ee6723b8-7ab3-462c-8d93-dbf61227998e' | ||
``` | ||
|
||
<details markdown="1" > | ||
<summary>JSON-RPC:</summary> | ||
Request: | ||
|
||
```json | ||
{ | ||
"jsonrpc": "2.0", | ||
"id": 1, | ||
"method": "Account.uid", | ||
"params": {} | ||
} | ||
``` | ||
|
||
Response: | ||
|
||
```json | ||
{ | ||
"jsonrpc": "2.0", | ||
"id": 1, | ||
"result": "ee6723b8-7ab3-462c-8d93-dbf61227998e" | ||
} | ||
``` | ||
|
||
</details> | ||
|
||
--- |
Oops, something went wrong.