Contents

Data

Essential Classes

States

Actions

Data Access

Components

Data Models

Book

A notebook data

Attributes

Details
Name Type Description Example
_id string The unique notebook ID which should start with book: and the remains are randomly generated string
pattern: 
^book:

Length: 6..128		 "book:9dc6a7a7"
_rev string This is a CouchDB specific field. The current MVCC-token/revision of this document (mandatory and immutable) "14-813af5085bb6a2648c3f0aca37fc821f"
count number It indicates the number of notes in the notebook 42.0
createdAt number The date time when the notebook was created, represented with Unix timestamps in milliseconds 42.0
name string The notebook name
Length: 1..64		 "example"
parentBookId nullable string The ID of the parent notebook null
updatedAt number The date time when the notebook was last updated, represented with Unix timestamps in milliseconds 42.0

File

An attachment file

Attributes

Details
Name Type Description Example
_attachments:index:content_type string The content type of the file
one of:"image/png" or "image/jpeg" or "image/jpg" or "image/svg+xml" or "image/gif" or "image/heic" or "image/heif"		 "image/png"
_attachments:index:data string or object The file data
_id string The unique document ID which should start with file: and the remains are randomly generated string
pattern: 
^file:

Length: 6..128		 "file:By8_nQtce"
_rev string This is a CouchDB specific field. The current MVCC-token/revision of this document (mandatory and immutable). "14-813af5085bb6a2648c3f0aca37fc821f"
contentLength number The content length of the file
Range: value <= 10485760		 42.0
contentType string The MIME type of the content
one of:"image/png" or "image/jpeg" or "image/jpg" or "image/svg+xml" or "image/gif" or "image/heic" or "image/heif"
Length: 0..128		 "image/png"
createdAt number The date time when the note was created, represented with Unix timestamps in milliseconds 42.0
name string The file name
Length: 1..128		 "example"
publicIn array An array of the note IDs where the file is included [null]

Note

A note data

Attributes

Details
Name Type Description Example
_conflicts array Conflicted revisions ["24-530ea621fb9b5b28b8ff4243e4235f01"]
_id string The unique document ID which should start with note: and the remains are randomly generated string
pattern: 
^note:

Length: 6..128		 "note:Bkl_9Vubx"
_rev string This is a CouchDB specific field. The current MVCC-token/revision of this document (mandatory and immutable). "14-813af5085bb6a2648c3f0aca37fc821f"
body string The content of the note represented with Markdown
Length: 0..1048576		 "example"
bookId string The notebook ID
pattern: 
^(book:|trash$)

Length: 5..128		 "example"
createdAt number The date time when the note was created, represented with Unix timestamps in milliseconds 42.0
doctype string The format type of the body field. It currently can take markdown only, reserved for the future
one of:"markdown"		 "markdown"
migratedBy string The type of the data migration
Length: 0..128		 "migrateAddingParentBookId"
numOfCheckedTasks number The number of checked tasks, extracted from body 42.0
numOfTasks number The number of tasks, extracted from body 42.0
pinned boolean Whether the note is pinned to top true
share string The sharing mode of the note
one of:"private" or "public"		 "private"
status string The status of the note
one of:"none" or "active" or "onHold" or "completed" or "dropped"		 "none"
tags array The list of tag IDs ["tag:a28ca207"]
title string The note title
Length: 0..128		 "example"
updatedAt number The date time when the note was last updated, represented with Unix timestamps in milliseconds 42.0

Tag

A note tag

Attributes

Details
Name Type Description Example
_id string The unique tag ID which should start with tag: and the remains are randomly generated string
pattern: 
^tag:

Length: 6..128		 "tag:0ebd717b"
_rev string This is a CouchDB specific field. The current MVCC-token/revision of this document (mandatory and immutable) "14-813af5085bb6a2648c3f0aca37fc821f"
color string The color type of the tag
one of:"default" or "red" or "orange" or "yellow" or "olive" or "green" or "teal" or "blue" or "violet" or "purple" or "pink" or "brown" or "grey" or "black"		 "default"
count number It indicates the number of notes with the tag 42.0
createdAt number The date time when the tag was created, represented with Unix timestamps in milliseconds 42.0
name string The name of the tag
Length: 0..64		 "example"
updatedAt number The date time when the tag was last updated, represented with Unix timestamps in milliseconds 42.0

Can you help us improve these docs?

The source of these docs is here on GitHub. If you see a way these docs can be improved, please fork us!