Notebook

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.

Libraries and permissions

To link against these classes, add the following line to your .pro file:

LIBS += -lbbpim

You must also specify the following permissions in your bar-descriptor.xml file:

access_pimdomain_notebooks

Additional resources

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

To download a code sample that demonstrates how to use the Notebook API, visit the Cascades Samples repository in Github.


Members

  • 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.

  • 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.

  • NotebookEntryDueDate -

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

  • NotebookEntryFilter -

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

  • 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.

  • NotebookEntryStatus -

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

  • 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.