UNPKG

@firebolt-js/sdk

Version:

The Firebolt JS SDK

github.com/rdkcentral/firebolt-apis

rdkcentral/firebolt-apis

123 lines (89 loc) • 2.4 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
--- title: Capabilities --- # Capabilities --- ## Table of Contents - [Table of Contents](#table-of-contents) - [Types](#types) - [Role](#role) - [DenyReason](#denyreason) - [Capability](#capability) - [CapPermissionStatus](#cappermissionstatus) - [CapabilityInfo](#capabilityinfo) - [Permission](#permission) ## Types ### Role Role provides access level for the app for a given capability. ```typescript Role: { USE: 'use', MANAGE: 'manage', PROVIDE: 'provide', }, ``` --- ### DenyReason Reasons why a Capability might not be invokable ```typescript 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. ```typescript type Capability = string ``` --- ### CapPermissionStatus ```typescript type CapPermissionStatus = { permitted?: boolean // Provides info whether the capability is permitted granted?: boolean } ``` --- ### CapabilityInfo ```typescript 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 } manage: { permitted?: boolean // Provides info whether the capability is permitted granted?: boolean } provide: { permitted?: boolean // Provides info whether the capability is permitted granted?: boolean } details?: DenyReason[] // Reasons why a Capability might not be invokable } ``` See also: [Capability](#capability) [DenyReason](#denyreason) --- ### Permission A capability combined with a Role, which an app may be permitted (by a distributor) or granted (by an end user). ```typescript 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](#role) [Capability](#capability) ---