Skip to content

Commit

Permalink
chore: Publish pr-release-1-3-0
Browse files Browse the repository at this point in the history
  • Loading branch information
Your Name committed Aug 8, 2024
1 parent bcb2258 commit f233a3c
Show file tree
Hide file tree
Showing 111 changed files with 93,609 additions and 0 deletions.
840 changes: 840 additions & 0 deletions apis/pr-release-1-3-0/core/Accessibility/index.md

Large diffs are not rendered by default.

154 changes: 154 additions & 0 deletions apis/pr-release-1-3-0/core/Accessibility/schemas/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
---
title: Accessibility

version: pr-release-1-3-0
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
type VoiceGuidanceSettings = {
enabled: boolean // Whether or not voice guidance should be enabled by default
speed: VoiceSpeed // The speed at which voice guidance speech will be read back to the user
}
```
See also:
[VoiceSpeed](#voicespeed)
---
### FontSize
```typescript

```

---

### Color

```typescript

```

---

### FontEdge

```typescript

```

---

### Opacity

```typescript

```

---

### HorizontalAlignment

```typescript

```

---

### VerticalAlignment

```typescript

```

---

### 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)
---
167 changes: 167 additions & 0 deletions apis/pr-release-1-3-0/core/Account/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
---
title: Account

version: pr-release-1-3-0
layout: default
sdk: core
---

# Account Module

---

Version Account 1.3.0-release-1-3-0.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
function id(): Promise<string>
```

Promise resolution:

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:

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
Loading

0 comments on commit f233a3c

Please sign in to comment.