Skip to content

Commit d8840f1

Browse files
committed
docs: update api docs
1 parent f47d704 commit d8840f1

File tree

2 files changed

+25
-13
lines changed

2 files changed

+25
-13
lines changed

docs/API-Reference/command/Commands.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -920,6 +920,12 @@ Hides the sidebar
920920
## SHOW\_SIDEBAR
921921
Shows the sidebar
922922

923+
**Kind**: global variable
924+
<a name="REINSTALL_CREDS"></a>
925+
926+
## REINSTALL\_CREDS
927+
Reinstalls credentials in keychain
928+
923929
**Kind**: global variable
924930
<a name="CMD_GIT_INIT"></a>
925931

docs/API-Reference/utils/NodeUtils.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -107,9 +107,20 @@ Opens a file in the default application for its type on Windows, macOS, and Linu
107107
| --- | --- | --- |
108108
| fullPath | <code>string</code> | The path to the file/folder to open. |
109109

110-
<a name="addDeviceLicense"></a>
110+
<a name="getDeviceID"></a>
111111

112-
## addDeviceLicense() ⇒ <code>Promise.&lt;boolean&gt;</code>
112+
## getDeviceID() ⇒ <code>Promise.&lt;(string\|null)&gt;</code>
113+
gets the os device id. this usually won't change till os reinstall.
114+
115+
**Kind**: global function
116+
**Returns**: <code>Promise.&lt;(string\|null)&gt;</code> - - Resolves with the os identifier or null
117+
**Throws**:
118+
119+
- <code>Error</code> - If called from the browser
120+
121+
<a name="addDeviceLicenseSystemWide"></a>
122+
123+
## addDeviceLicenseSystemWide() ⇒ <code>Promise.&lt;boolean&gt;</code>
113124
Enables device license by creating a system-wide license file.
114125
On Windows, macOS, and Linux this will request elevation if needed.
115126

@@ -119,9 +130,9 @@ On Windows, macOS, and Linux this will request elevation if needed.
119130

120131
- <code>Error</code> - If called from the browser
121132

122-
<a name="removeDeviceLicense"></a>
133+
<a name="removeDeviceLicenseSystemWide"></a>
123134

124-
## removeDeviceLicense() ⇒ <code>Promise.&lt;boolean&gt;</code>
135+
## removeDeviceLicenseSystemWide() ⇒ <code>Promise.&lt;boolean&gt;</code>
125136
Removes the system-wide device license file.
126137
On Windows, macOS, and Linux this will request elevation if needed.
127138

@@ -131,16 +142,11 @@ On Windows, macOS, and Linux this will request elevation if needed.
131142

132143
- <code>Error</code> - If called from the browser
133144

134-
<a name="isLicensedDevice"></a>
145+
<a name="isLicensedDeviceSystemWide"></a>
135146

136-
## isLicensedDevice() ⇒ <code>Promise.&lt;boolean&gt;</code>
137-
Checks if the current machine is licensed.
138-
This validates that the system-wide license file exists,
139-
contains valid JSON, and has `licensedDevice: true`.
147+
## isLicensedDeviceSystemWide() ⇒ <code>Promise.&lt;boolean&gt;</code>
148+
Checks if the current machine is configured to check for system-wide device license for all users at app start.
149+
This validates that the system-wide license file exists, contains valid JSON, and has `licensedDevice: true`.
140150

141151
**Kind**: global function
142152
**Returns**: <code>Promise.&lt;boolean&gt;</code> - - Resolves with `true` if the device is licensed, `false` otherwise.
143-
**Throws**:
144-
145-
- <code>Error</code> - If called from the browser.
146-

0 commit comments

Comments
 (0)