Skip to main content
Version: 0.6.0-alpha.2

Account Module


Version 0.6.0

OpenRPC

This document was generated from an OpenRPC JSON-Schema, and is intended to provide a human readable overview and examples of the methods contained in the module.

For the full schema, see the link below.

Schema
account.json

Table of Contents

Usage

To use the Account module, you can import it into your project from the Firebolt SDK:

import { Account } from '@firebolt-js/sdk'

Overview

A module for querying about the device account.

Events

Methods

id

Get the platform back-office account identifier

To get the property value, use id():

function id(): Promise<string>

Parameters

ParamTypeRequiredSummary

Promise Resolution

TypeSummary
stringthe id

Examples

Default Example
JavaScript
import { Account } from '@firebolt-js/sdk'

Account.id()
.then(id => {
console.log(id)
})

Value of value

"123"
JSON-RPC
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "account.id",
"params": {}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": "123"
}

uid

Gets a unique id for the current app & account

To get the property value, use uid():

function uid(): Promise<string>

Parameters

ParamTypeRequiredSummary

Promise Resolution

TypeSummary
stringa unique ID

Examples

Getting the unique ID
JavaScript
import { Account } from '@firebolt-js/sdk'

Account.uid()
.then(uniqueId => {
console.log(uniqueId)
})

Value of value

"ee6723b8-7ab3-462c-8d93-dbf61227998e"
JSON-RPC
Request
{
"jsonrpc": "2.0",
"id": 1,
"method": "account.uid",
"params": {}
}
Response
{
"jsonrpc": "2.0",
"id": 1,
"result": "ee6723b8-7ab3-462c-8d93-dbf61227998e"
}