-
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-media-access
- Loading branch information
Your Name
committed
Apr 4, 2024
1 parent
2be38ec
commit d9772ec
Showing
78 changed files
with
90,775 additions
and
0 deletions.
There are no files selected for viewing
873 changes: 873 additions & 0 deletions
873
apis/pr-feature-media-access/core/Accessibility/index.md
Large diffs are not rendered by default.
Oops, something went wrong.
150 changes: 150 additions & 0 deletions
150
apis/pr-feature-media-access/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,150 @@ | ||
--- | ||
title: Accessibility | ||
|
||
version: pr-feature-media-access | ||
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 | ||
|
||
``` | ||
|
||
--- | ||
|
||
### VoiceSpeed | ||
|
||
```typescript | ||
|
||
``` | ||
|
||
--- | ||
|
||
### VoiceGuidanceSettings | ||
|
||
````typescript | ||
```typescript | ||
```` | ||
```` | ||
See also: | ||
--- | ||
### FontSize | ||
```typescript | ||
|
||
```` | ||
|
||
--- | ||
|
||
### Color | ||
|
||
```typescript | ||
|
||
``` | ||
|
||
--- | ||
|
||
### FontEdge | ||
|
||
```typescript | ||
|
||
``` | ||
|
||
--- | ||
|
||
### Opacity | ||
|
||
```typescript | ||
|
||
``` | ||
|
||
--- | ||
|
||
### HorizontalAlignment | ||
|
||
```typescript | ||
|
||
``` | ||
|
||
--- | ||
|
||
### VerticalAlignment | ||
|
||
```typescript | ||
|
||
``` | ||
|
||
--- | ||
|
||
### ClosedCaptionsStyles | ||
|
||
The default styles to use when displaying closed-captions | ||
|
||
````typescript | ||
```typescript | ||
```` | ||
```` | ||
--- | ||
### ClosedCaptionsSettings | ||
```typescript | ||
```typescript | ||
```` | ||
``` | ||
|
||
See also: | ||
|
||
|
||
|
||
--- | ||
``` |
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,175 @@ | ||
--- | ||
title: Account | ||
|
||
version: pr-feature-media-access | ||
layout: default | ||
sdk: core | ||
--- | ||
|
||
# Account Module | ||
|
||
--- | ||
|
||
Version Account 1.2.0-feature-media-access.0 | ||
|
||
## Table of Contents | ||
|
||
- [Table of Contents](#table-of-contents) | ||
- [Usage](#usage) | ||
- [Overview](#overview) | ||
- [Methods](#methods) | ||
- [id](#id) | ||
- [uid](#uid) | ||
- [Types](#types) | ||
|
||
## 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 | ||
${method.signature} | ||
``` | ||
|
||
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 | ||
${method.signature} | ||
``` | ||
|
||
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> | ||
|
||
--- | ||
|
||
## Types |
Oops, something went wrong.