Use these APIs to integrate Notebook application features in your app.

Notebooks let you create, store, and manipulate lists of actionable or non-actionable items. For example, you might create a notebook that represents a grocery list, which contains items to purchase. Or, you could create a notebook consisting of gifts you'd like for your birthday. You can use the Notebook APIs to add, remove, or update items in notebooks, create new notebooks, and so on.

To use the Notebook API, you must set the access_pimdomain_notebooks permission in the bar-descriptor.xml file of your project.

Additional resources

To learn more about the Notebook API and how to use it in your apps, visit the Personal information management documentation.


  • Notebook -

    The Notebook class represents a folder-like object that contains notebook entries.

  • NotebookConstraint -

    The NotebookConstraint class represents a constraint on the contents of a Notebook.

  • NotebookDomain -

    The NotebookDomain class provides the available Notebook Domains that a Notebook can contain.

  • NotebookEntry -

    The NotebookEntry class represents an entry that is contained within a Notebook.

  • NotebookEntryAttachment -

    The NotebookEntryAttachment class represents an attachment to a NotebookEntry.

  • NotebookEntryConstraint -

    The NotebookEntryConstraint class represents a constraint on the contents of a NotebookEntry, imposed by the parent Notebook that the NotebookEntry belongs to.

  • NotebookEntryDescription -

    A NotebookEntryDescription is the text content of a NotebookEntry along with its respective type.

  • NotebookEntryDetailLevel -

    The NotebookEntryDetailLevel class represents the detail level of a notebook entry list or search response.

  • NotebookEntryDueDate -

    The NotebookEntryDueDate class provides a set of options for filtering notebook entries by due date or reminder date.

  • NotebookEntryFilter -

    The NotebookEntryFilter class represents a filter that can be used to search and count notebook entries.

  • NotebookEntryHeader -

    The NotebookEntryHeader class represents a header to be shown in a list of NotebookEntry objects.

  • NotebookEntryId -

    The NotebookEntryId class represents the unique ID of a NotebookEntry.

  • NotebookEntrySearchField -

    The NotebookEntrySearchField class provides a set of flags that determine which NotebookEntry fields to search when specified with a NotebookEntryFilter.

  • NotebookEntrySortColumn -

    The NotebookEntrySortColumn class represents the columns that can be used to sort notebook entries.

  • NotebookEntrySortOrder -

    The NotebookEntrySortOrder class represents the sort order (ascending or descending) of a notebook entry list or search response.

  • NotebookEntryStatus -

    The NotebookEntryStatus class provides the available statuses that can be set on a NotebookEntry.

  • NotebookFilter -

    The NotebookFilter class represents a filter that can be used to search and count notebook entries.

  • NotebookId -

    The NotebookId class represents the unique ID of a Notebook.

  • NotebookService -

    The NotebookService class provides CRUD (create/read/update/delete) operations on Notebook objects and their NotebookEntry objects.

  • NotebookServiceResult -

    The NotebookServiceResult class provides status codes that are returned from add, update, and delete functions in NotebookService.

Last modified: 2014-06-24

Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus