Note editor

The app is displayed as an icon in the toolbar of the note editor. Clicking the icon opens the app. A note editor app typically adds functionality to the editor.

Example manifest

"location": {
  "sell": {
    "note_editor": "assets/iframe.html"
  }
},

The following object is available in this location:

Note object

note

Retrieves the note object with some of its properties.

get
client.get('note')
returns
{
  "note": {
    "id": 4,
    "resourceType": "contact",
    "resourceId": 12345,
    "content": "This is my note.",
    "createdAt": "2014-09-27T16:32:56Z",
    "updatedAt": "2014-09-28T16:32:56Z"
  }
}

Properties

note.id

The unique identifier of the note.

get
client.get('note.id')
returns
{
  "note.id": 4
}
note.resourceType

Type of an entity the note was created by.

get
client.get('note.resourceType')
returns
{
  "note.resourceType": "contact"
}
note.resourceId

The unique identifier of an entity the note was created by.

get
client.get('note.resourceId')
returns
{
  "note.resourceId": 12345
}
note.content

Content of the note.

get
client.get('note.content')
returns
{
  "note.content": "This is my note."
}
note.createdAt

Note's creation date and time (UTC, ISO8601 format).

get
client.get('note.createdAt')
returns
{
  "note.createdAt": "2014-09-27T16:32:56Z"
}
note.updatedAt

Note's last update date and time (UTC, ISO8601 format).

get
client.get('note.updatedAt')
returns
{
  "note.updatedAt": "2014-09-28T16:32:56Z"
}