notebook

Since: BlackBerry 10.2.0


Overview

Classes

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.

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.

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.

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.

Functions Index

BB_PIM_EXPORT QDebug &operator<< (QDebug &stream, const NotebookId &id)
BB_PIM_EXPORT QDebug &operator<< (QDebug &stream, const NotebookEntryId &id)

Typedefs

typedef unsigned int NotebookEntryKey

typedef QPair< NotebookEntrySortColumn::Type, NotebookEntrySortOrder::Type > NotebookEntrySortSpecifier

The NotebookEntrySortSpecifier typedef represents a pair consisting of a NotebookEntrySortColumn::Type value and a NotebookEntrySortOrder::Type value.

Sort order and sort column are strongly related, and the NotebookEntrySortSpecifier typedef represents this relationship.

Since:

BlackBerry 10.2.0

typedef unsigned int NotebookKey

typedef quint64 SourceRevision

This represents the revision of the Notebooks database.

The revision gets incremented anytime an add, update, or delete occurs on a NotebookEntry

Since:

BlackBerry 10.2.0

Functions

BB_PIM_EXPORT QDebug & operator<< (

Stream operator.

This operator writes a NotebookId to a QDebug stream.

Parameters
stream

The QDebug stream to write to.

id

The NotebookId to write.

Return:

A reference to the stream.

BB_PIM_EXPORT QDebug & operator<< (

Stream operator.

This operator writes a NotebookEntryId to a QDebug stream.

Parameters
stream

The QDebug stream to write to.

id

The NotebookEntryId to write.

Return:

A reference to the stream.

Last modified: 2014-03-13

comments powered by Disqus