Type Definitions
CreateNewNoteParams
Type:
- object
Properties:
| Name | Type | Description |
|---|---|---|
parentNoteId |
string | MANDATORY |
title |
string | MANDATORY |
content |
string | buffer | MANDATORY |
type |
string | text, code, file, image, search, book, relationMap, canvas - MANDATORY |
mime |
string | value is derived from default mimes for type |
isProtected |
boolean | default is false |
isExpanded |
boolean | default is false |
prefix |
string | default is empty string |
notePosition |
int | default is last existing notePosition in a parent + 10 |
- Source:
CreateNoteAttribute
Type:
- object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
string | attribute type - label, relation etc. | |
name |
string | attribute name | |
value |
string |
<optional> |
attribute value |
- Source:
CreateNoteAttribute
Type:
- object
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
type |
string | attribute type - label, relation etc. | |
name |
string | attribute name | |
value |
string |
<optional> |
attribute value |
- Source:
CreateNoteExtraOptions
Type:
- object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
json |
boolean |
<optional> |
false | should the note be JSON |
isProtected |
boolean |
<optional> |
false | should the note be protected |
type |
string |
<optional> |
'text' | note type |
mime |
string |
<optional> |
'text/html' | MIME type of the note |
attributes |
Array.<CreateNoteAttribute> |
<optional> |
[] | attributes to be created for this note |
- Source:
CreateOrUpdateLauncher
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
id |
string | id of the launcher, only alphanumeric at least 6 characters long | ||
type |
string | one of * "note" - activating the launcher will navigate to the target note (specified in targetNoteId param) * "script" - activating the launcher will execute the script (specified in scriptNoteId param) * "customWidget" - the launcher will be rendered with a custom widget (specified in widgetNoteId param) | ||
title |
string | |||
isVisible |
boolean |
<optional> |
false | if true, will be created in the "Visible launchers", otherwise in "Available launchers" |
icon |
string |
<optional> |
name of the boxicon to be used (e.g. "bx-time") | |
keyboardShortcut |
string |
<optional> |
will activate the target note/script upon pressing, e.g. "ctrl+e" | |
targetNoteId |
string |
<optional> |
for type "note" | |
scriptNoteId |
string |
<optional> |
for type "script" | |
widgetNoteId |
string |
<optional> |
for type "customWidget" |
- Source: