Interface NoteProperties

Hierarchy

Properties

altitude: number

numeric

application_data: string

text

author: string

text

base_url: string

If body_html is provided and contains relative URLs, provide the base_url parameter too so that all the URLs can be converted to absolute ones. The base URL is basically where the HTML was fetched from, minus the query (everything after the '?'). For example if the original page was https://stackoverflow.com/search?q=%5Bjava%5D+test, the base URL is https://stackoverflow.com/search.

body: string

The note body, in Markdown. May also contain HTML.

body_html: string

Note body, in HTML format

created_time: number

When the folder was created.

crop_rect: {
    height: number;
    width: number;
    x: number;
    y: number;
}

If an image is provided, you can also specify an optional rectangle that will be used to crop the image. In format { x: x, y: y, width: width, height: height }

Type declaration

  • height: number
  • width: number
  • x: number
  • y: number
encryption_applied: number
encryption_cipher_text: string

text

id: string

text

image_data_url: string

An image to attach to the note, in Data URL format.

is_conflict: number

Tells whether the note is a conflict or not.

is_shared: number
is_todo: IntBool

Tells whether this note is a to-do or not.

latitude: number

numeric

longitude: number

numeric

markup_language: number

int

order: number

int

parent_id: string

ID of the notebook that contains this note. Change this ID to move the note to a different notebook.

source: string

text

source_application: string

text

source_url: string

The full URL where the note comes from.

title: string

The tag title.

todo_completed: IntBool

Tells whether to-do is completed or not. This is a timestamp in milliseconds.

todo_due: IntBool

When the to-do is due. An alarm will be triggered on that date.

updated_time: number

When the folder was last updated.

user_created_time: number

When the folder was created. It may differ from created_time as it can be manually set by the user.

user_updated_time: number

When the folder was last updated. It may differ from updated_time as it can be manually set by the user.

Generated using TypeDoc