title: Capabilities

version: 0.15.0
layout: default
sdk: manage

# Capabilities

Version Capabilities 0.0.0-unknown.0

Table of Contents

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

Overview

undefined

Types

Capability

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

type Capability = string

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: {
    permitted?: boolean       // Provides info whether the capability is permitted
    granted?: boolean | void
  }
  manage: {
    permitted?: boolean       // Provides info whether the capability is permitted
    granted?: boolean | void
  }
  provide: {
    permitted?: boolean       // Provides info whether the capability is permitted
    granted?: boolean | void
  }
  details?: DenyReason[]
}

See also:

string
'unpermitted' | 'unsupported' | 'disabled' | 'unavailable' | 'grantDenied' | 'ungranted'

Permission

A sapability 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:

'use' | 'manage' | 'provide'
string

Role

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

enum Role {
	USE = 'use',
	MANAGE = 'manage',
	PROVIDE = 'provide'
}

CapPermissionStatus

type CapPermissionStatus = {
  permitted?: boolean         // Provides info whether the capability is permitted
  granted?: boolean | void
}

DenyReason

Reasons why a Capability might not be invokable

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