NotebookEntryId
#include <bb/pim/notebook/NotebookEntryId>
To link against this class, add the following line to your .pro file: LIBS += -lbbpim
The NotebookEntryId class represents the unique ID of a NotebookEntry.
A NotebookEntryId consists of an AccountKey and a NotebookEntryKey. A NotebookEntryKey is unique within an account, but not across accounts, and therefore an AccountKey must also be provided to ensure uniqueness across the system.
A NotebookEntry is automatically assigned a NotebookEntryId when it is committed to persistence using the NotebookService. The AccountKey is inherited from the parent Notebook of the NotebookEntry, and the NotebookEntryKey is assigned by the database at commit time.
BlackBerry 10.0.0
Public Functions Index
| NotebookEntryId () | |
| NotebookEntryId (bb::pim::account::AccountKey accountKey, NotebookEntryKey notebookEntryKey) | |
| NotebookEntryId (const QString ¬ebookEntryId) | |
| NotebookEntryId (const NotebookEntryId &other) | |
| ~NotebookEntryId () | |
| NotebookEntryId & | operator= (const NotebookEntryId &other) |
| bool | operator== (const NotebookEntryId &other) const |
| bool | operator!= (const NotebookEntryId &other) const |
| bb::pim::account::AccountKey | accountKey () const |
| NotebookEntryKey | notebookEntryKey () const |
| bool | isValid () const |
| QString | toString () const |
Public Functions
Constructs a new NotebookEntryId with default values.
A default-constructed NotebookEntryId is considered invalid.
BlackBerry 10.0.0
Constructs a new NotebookEntryId with the provided account key and notebook entry key.
The account key specifies the account that the NotebookEntry for this NotebookEntryId belongs to. The notebook entry key uniquely identifies a NotebookEntry within a particular account.
| Parameters | |
|---|---|
| accountKey |
The account key. |
| notebookEntryKey |
The notebook entry key. |
BlackBerry 10.0.0
Constructs a new NotebookEntryId from the provided QString.
The notebookEntryId as a QString contains an account key and notebook entry key separated by a ":". The account key specifies the account that the NotebookEntry for this NotebookEntryId belongs to. The notebook entry key uniquely identifies a NotebookEntry within a particular account. If a malformed notebookEntryId string is provided, the NotebookEntryId will be default-constructed and considered invalid.
| Parameters | |
|---|---|
| notebookEntryId |
The notebook entry ID as a human-readable string. |
BlackBerry 10.0.0
Copy constructor.
This function constructs a NotebookEntryId containing exactly the same values as the provided NotebookEntryId.
| Parameters | |
|---|---|
| other |
The NotebookEntryId to be copied. |
BlackBerry 10.0.0
Destructor.
BlackBerry 10.0.0
NotebookEntryId &
Assignment operator.
This operator copies all values from the provided NotebookEntryId into this NotebookEntryId.
| Parameters | |
|---|---|
| other |
The NotebookEntryId from which to copy all values. |
A reference to this NotebookEntryId.
BlackBerry 10.0.0
bool
Equality operator.
This operator determines if this NotebookEntryId has the same values as another NotebookEntryId. This operator should be used on the IDs of two NotebookEntry objects to determine whether they represent the same entity in the database.
| Parameters | |
|---|---|
| other |
The NotebookEntryId from which to compare. |
true if the values are considered equal, false otherwise.
BlackBerry 10.0.0
bool
Inequality operator.
This operator determines if this NotebookEntryId has any different values from another NotebookEntryId. This operator should be used on the IDs of two NotebookEntry objects to determine whether they represent different entities in the database.
| Parameters | |
|---|---|
| other |
The NotebookEntryId from which to compare. |
true if any of the values are not considered equal, false otherwise.
BlackBerry 10.0.0
bb::pim::account::AccountKey
Retrieves the account key for this NotebookEntryId.
The account key determines which account the NotebookEntry for this NotebookEntryId belongs to.
The account key for this NotebookEntryId.
BlackBerry 10.0.0
NotebookEntryKey
Retrieves the notebook entry key for this NotebookEntryId.
The notebook entry key uniquely identifies a NotebookEntry within a particular account.
The notebook entry key for this NotebookEntryId.
BlackBerry 10.0.0
bool
Indicates whether this NotebookEntryId is valid.
A default-constructed NotebookEntryId is considered invalid.
true if this NotebookEntryId is valid, false otherwise.
BlackBerry 10.0.0
QString
Returns the human-readable string representation of this NotebookEntryId.
The account key and notebook entry key comprising the NotebookEntryId is encoded as a string separated with a colon in the format of "<accountKey>:<notebookKey>".
The human-readable string representation of this NotebookEntryId.
BlackBerry 10.0.0