Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add compare for next #2

Open
wants to merge 1 commit into
base: kp-compare-1.3.0
Choose a base branch
from
Open

add compare for next #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions apis/compare/core/Accessibility/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Accessibility

version: 1.3.0
version: next
layout: default
sdk: core
---
Expand All @@ -10,7 +10,7 @@ sdk: core

---

Version Accessibility 1.3.0
Version Accessibility 1.4.0-next.3

## Table of Contents

Expand Down
6 changes: 3 additions & 3 deletions apis/compare/core/Accessibility/schemas/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Accessibility

version: 1.3.0
version: next
layout: default
sdk: core
---
Expand Down Expand Up @@ -56,7 +56,7 @@ undefined
```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
speed?: VoiceSpeed // The speed at which voice guidance speech will be read back to the user
}
```

Expand Down Expand Up @@ -142,7 +142,7 @@ type ClosedCaptionsStyles = {
```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
styles?: ClosedCaptionsStyles // The default styles to use when displaying closed-captions
preferredLanguages?: string[]
}
```
Expand Down
4 changes: 2 additions & 2 deletions apis/compare/core/Account/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Account

version: 1.3.0
version: next
layout: default
sdk: core
---
Expand All @@ -10,7 +10,7 @@ sdk: core

---

Version Account 1.3.0
Version Account 1.4.0-next.3

## Table of Contents

Expand Down
45 changes: 31 additions & 14 deletions apis/compare/core/Advertising/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Advertising

version: 1.3.0
version: next
layout: default
sdk: core
---
Expand All @@ -10,7 +10,7 @@ sdk: core

---

Version Advertising 1.3.0
Version Advertising 1.4.0-next.3

## Table of Contents

Expand All @@ -31,6 +31,7 @@ Version Advertising 1.3.0
- [AdConfigurationOptions](#adconfigurationoptions)
- [AdPolicy](#adpolicy)
- [AdvertisingIdOptions](#advertisingidoptions)
- [AdvertisingIdResult](#advertisingidresult)

## Usage

Expand All @@ -48,10 +49,12 @@ A module for platform provided advertising settings and functionality.

### advertisingId

Get the advertising ID
Get the IAB compliant identifier for advertising (IFA). It is recommended to use the IFA to manage advertising related activities while respecting the user's privacy settings.

```typescript
function advertisingId(options: AdvertisingIdOptions): Promise<object>
function advertisingId(
options: AdvertisingIdOptions,
): Promise<AdvertisingIdResult>
```

Parameters:
Expand All @@ -62,6 +65,8 @@ Parameters:

Promise resolution:

[AdvertisingIdResult](#advertisingidresult)

Capabilities:

| Role | Capability |
Expand All @@ -86,7 +91,7 @@ Value of `advertisingId`:
```javascript
{
"ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
"ifa_type": "idfa",
"ifa_type": "sspid",
"lmt": "0"
}
```
Expand All @@ -112,7 +117,7 @@ Response:
"id": 1,
"result": {
"ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
"ifa_type": "idfa",
"ifa_type": "sspid",
"lmt": "0"
}
}
Expand All @@ -138,7 +143,7 @@ Value of `advertisingId`:
```javascript
{
"ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
"ifa_type": "idfa",
"ifa_type": "sspid",
"lmt": "0"
}
```
Expand Down Expand Up @@ -171,7 +176,7 @@ Response:
"id": 1,
"result": {
"ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
"ifa_type": "idfa",
"ifa_type": "sspid",
"lmt": "0"
}
}
Expand All @@ -197,7 +202,7 @@ Value of `advertisingId`:
```javascript
{
"ifa": "01234567-89AB-CDEF-GH01-23456789ABCD",
"ifa_type": "idfa",
"ifa_type": "sspid",
"lmt": "0"
}
```
Expand Down Expand Up @@ -272,7 +277,7 @@ console.log(appBundleId)
Value of `appBundleId`:

```javascript
'operator.app'
'app.operator'
```

<details markdown="1" >
Expand All @@ -294,7 +299,7 @@ Response:
{
"jsonrpc": "2.0",
"id": 1,
"result": "operator.app"
"result": "app.operator"
}
```

Expand Down Expand Up @@ -599,9 +604,9 @@ Promise resolution:

Capabilities:

| Role | Capability |
| ---- | ------------------------------------------------------------------------------------------------- |
| uses | xrn:firebolt:capability:privacy:advertising<br/>xrn:firebolt:capability:advertising:configuration |
| Role | Capability |
| ---- | ------------------------------------------ |
| uses | xrn:firebolt:capability:advertising:policy |

#### Examples

Expand Down Expand Up @@ -769,3 +774,15 @@ type AdvertisingIdOptions = {
```

---

### AdvertisingIdResult

```typescript
type AdvertisingIdResult = {
ifa: string // UUID conforming to IAB standard
ifa_type: string // source of the IFA as defined by IAB
lmt: '0' | '1' // boolean that if set to 1, user has requested ad tracking and measurement is disabled
}
```

---
2 changes: 1 addition & 1 deletion apis/compare/core/Advertising/schemas/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Advertising

version: 1.3.0
version: next
layout: default
sdk: core
---
Expand Down
24 changes: 21 additions & 3 deletions apis/compare/core/Authentication/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Authentication

version: 1.3.0
version: next
layout: default
sdk: core
---
Expand All @@ -10,7 +10,7 @@ sdk: core

---

Version Authentication 1.3.0
Version Authentication 1.4.0-next.3

## Table of Contents

Expand All @@ -24,6 +24,7 @@ Version Authentication 1.3.0
- [token](#token)
- [Types](#types)
- [TokenType](#tokentype)
- [AuthenticationTokenResult](#authenticationtokenresult)

## Usage

Expand Down Expand Up @@ -230,7 +231,10 @@ Response:
Get a specific `type` of authentication token

```typescript
function token(type: TokenType, options: object): Promise<object>
function token(
type: TokenType,
options: object,
): Promise<AuthenticationTokenResult>
```

Parameters:
Expand All @@ -242,6 +246,8 @@ Parameters:

Promise resolution:

[AuthenticationTokenResult](#authenticationtokenresult)

Capabilities:

| Role | Capability |
Expand Down Expand Up @@ -429,3 +435,15 @@ TokenType: {
```

---

### AuthenticationTokenResult

```typescript
type AuthenticationTokenResult = {
value: string
expires?: string
type?: string
}
```

---
4 changes: 2 additions & 2 deletions apis/compare/core/Capabilities/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Capabilities

version: 1.3.0
version: next
layout: default
sdk: core
---
Expand All @@ -10,7 +10,7 @@ sdk: core

---

Version Capabilities 1.3.0
Version Capabilities 1.4.0-next.3

## Table of Contents

Expand Down
2 changes: 1 addition & 1 deletion apis/compare/core/Capabilities/schemas/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Capabilities

version: 1.3.0
version: next
layout: default
sdk: core
---
Expand Down
Loading