NotebookEntryConstraint

Since: BlackBerry 10.0.0

#include <bb/pim/notebook/NotebookEntryConstraint>

To link against this class, add the following line to your .pro file: LIBS += -lbbpim

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

Notebook entry constraints define constraints on the contents of a NotebookEntry. These constraints are imposed upon a NotebookEntry by the parent Notebook that it belongs to, and so they may change as a NotebookEntry is moved between Notebooks.

Notebook entry constraints are silently enforced by the NotebookService, meaning that add and update operations that violate the constraints are not rejected. Instead, any such violations are simply disregarded as part of the NotebookService commit operation. For example, adding attachments to a NotebookEntry that does not support attachments will result in those attachments being dropped during the NotebookService add or update operation. For more information, see the documentation for individual constraints.


Overview

Public Types Index

Public Types

Type

An enumeration of possible constraints.

Since:

BlackBerry 10.0.0

AttachmentsNotSupported = 0x01

Indicates that attachments are not supported.

Attachments will be silently dropped when updating using the NotebookService.

Since:

BlackBerry 10.0.0

MustNotBeActionable = 0x02

Indicates that the NotebookEntry must not be actionable.

The status will be set to NotebookEntryStatus::NotActionable when updating using the NotebookService.

Since:

BlackBerry 10.0.0

MustBeActionable = 0x04

Indicates that the NotebookEntry must be actionable.

A status of NotebookEntryStatus::NotActionable will be changed to NotebookEntryStatus::NotCompleted when updating using the NotebookService. Other status values will not be changed.

Since:

BlackBerry 10.0.0

TitleNotEditable = 0x08

Indicates that title changes to the NotebookEntry are not supported.

Title changes will be silently dropped when updating the NotebookEntry using NotebookService::updateNotebookEntry().

Since:

BlackBerry 10.0.0

DescriptionNotEditable = 0x10

Indicates that description changes to the NotebookEntry are not supported.

Description changes will be silently dropped when updating the NotebookEntry using NotebookService::updateNotebookEntry().

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus