title: Capabilities

version: 1.2.0
layout: default
sdk: manage

# Capabilities

Version Capabilities 0.0.0-unknown.0

Table of Contents

• Table of Contents
• Overview
• Types
  • Role
  • DenyReason
  • Capability
  • CapPermissionStatus
  • CapabilityInfo
  • Permission

Overview

undefined

Types

Role

Role provides access level for the app for a given capability.

Role: {
    USE: 'use',
    MANAGE: 'manage',
    PROVIDE: 'provide',
},

DenyReason

Reasons why a Capability might not be invokable

DenyReason: {
    UNPERMITTED: 'unpermitted',
    UNSUPPORTED: 'unsupported',
    DISABLED: 'disabled',
    UNAVAILABLE: 'unavailable',
    GRANT_DENIED: 'grantDenied',
    UNGRANTED: 'ungranted',
},

Capability

A Capability is a discrete unit of functionality that a Firebolt device might be able to perform.

CapPermissionStatus

CapabilityInfo

type CapabilityInfo = {
  capability?: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform.
  supported: boolean // Provides info whether the capability is supported
  available: boolean // Provides info whether the capability is available
  use: object
  manage: object
  provide: object
  details?: DenyReason[] // Reasons why a Capability might not be invokable
}

See also:

Capability
DenyReason

Permission

A capability combined with a Role, which an app may be permitted (by a distributor) or granted (by an end user).

type Permission = {
  role?: Role // Role provides access level for the app for a given capability.
  capability: Capability // A Capability is a discrete unit of functionality that a Firebolt device might be able to perform.
}

See also:

Role
Capability