@firebolt-js/sdk/dist/docs/Profile/index.md

The Firebolt JS SDK

---
title: Profile
---

# Profile Module

---

Version Profile 1.5.0

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [Overview](#overview)
- [Methods](#methods)
  - [approveContentRating](#approvecontentrating)
  - [approvePurchase](#approvepurchase)
  - [flags](#flags)
- [Types](#types)

## Usage

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

```javascript
import { Profile } from '@firebolt-js/sdk'
```

## Overview

Methods for getting information about the current user/account profile

## Methods

### approveContentRating

Verifies that the current profile should have access to mature/adult content.

```typescript
function approveContentRating(): Promise<boolean>
```

Promise resolution:

Capabilities:

| Role | Capability                              |
| ---- | --------------------------------------- |
| uses | xrn:firebolt:capability:approve:content |

#### Examples

Default Example

JavaScript:

```javascript
import { Profile } from '@firebolt-js/sdk'

let allow = await Profile.approveContentRating()
console.log(allow)
```

Value of `allow`:

```javascript
false
```

<details>
<summary>JSON-RPC:</summary>
Request:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Profile.approveContentRating",
  "params": {}
}
```

Response:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": false
}
```

</details>

---

### approvePurchase

Verifies that the current profile should have access to making purchases.

```typescript
function approvePurchase(): Promise<boolean>
```

Promise resolution:

Capabilities:

| Role | Capability                               |
| ---- | ---------------------------------------- |
| uses | xrn:firebolt:capability:approve:purchase |

#### Examples

Default Example

JavaScript:

```javascript
import { Profile } from '@firebolt-js/sdk'

let allow = await Profile.approvePurchase()
console.log(allow)
```

Value of `allow`:

```javascript
false
```

<details>
<summary>JSON-RPC:</summary>
Request:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Profile.approvePurchase",
  "params": {}
}
```

Response:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": false
}
```

</details>

---

### flags

Get a map of profile flags for the current session.

```typescript
function flags(): Promise<FlatMap>
```

Promise resolution:

[FlatMap](../Types/schemas/#FlatMap)

Capabilities:

| Role | Capability                            |
| ---- | ------------------------------------- |
| uses | xrn:firebolt:capability:profile:flags |

#### Examples

Default Example

JavaScript:

```javascript
import { Profile } from '@firebolt-js/sdk'

let flags = await Profile.flags()
console.log(flags)
```

Value of `flags`:

```javascript
{
	"userExperience": "1000"
}
```

<details>
<summary>JSON-RPC:</summary>
Request:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "Profile.flags",
  "params": {}
}
```

Response:

```json
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "userExperience": "1000"
  }
}
```

</details>

---

## Types