contacts

Since: BlackBerry 10.0.0


Overview

Classes

Activity

The Activity class represents the PIM activity types that can be queried.

AttributeKind

The AttributeKind class contains the possible attribute kinds for a contact.

AttributeSubKind

The AttributeSubKind class contains the possible attribute sub-kinds for a contact.

Contact

The Contact class represents contact data, such as name, email address, and postal address.

ContactActivity

The ContactActivity class represents an interaction with a Contact object.

ContactAttribute

The ContactAttribute class represents a property of a Contact.

ContactAttributeBuilder

The ContactAttributeBuilder class lets you create, and specify properties for, a new ContactAttribute or edit an existing ContactAttribute.

ContactAutoCompleteSearchFilters

The ContactAutoCompleteSearchFilters class represents a set of search filters that are used for auto-complete searches.

ContactBuilder

The ContactBuilder class lets you create, and specify properties for, a new Contact or edit an existing Contact.

ContactListFilters

The ContactListFilters class represents a set of filters that are used for listing and sorting contacts.

ContactNews

The ContactNews class represents online news for a contact.

ContactOnlineStatus

The ContactOnlineStatus class represents the online status of a contact.

ContactPhoto

The ContactPhoto class represents a photo that's associated with a Contact.

ContactPhotoBuilder

The ContactPhotoBuilder class lets you create, and specify properties for, a new ContactPhoto or edit an existing ContactPhoto.

ContactPostalAddress

The ContactPostalAddress class represents a postal address for a contact.

ContactPostalAddressBuilder

The ContactPostalAddressBuilder class lets you create, and specify properties for, a new ContactPostalAddress or edit an existing ContactPostalAddress.

ContactRemoteSearchFilters

The ContactRemoteSearchFilters class represents a set of filters that are used for remote searches.

ContactSearchFilters

The ContactSearchFilters class represents a set of filters that are used to search for specific contacts.

ContactService

The ContactService class provides CRUD (create/read/update/delete) operations on Contact objects.

PerimeterStatus

The PerimeterStatus class represents the enterprise perimeter state.

SearchAutoCompleteField

The SearchAutoCompleteField class represents the fields that a ContactAutoCompleteSearchFilters can apply to.

SearchField

The SearchField class represents the fields that a ContactSearchFilters can apply to.

SortColumn

The SortColumn class represents the columns that can be used to sort contacts.

SortOrder

The SortOrder class represents the sort order (ascending or descending) of a contact list or search response.

VCardPhotoEncoding

The VCardPhotoEncoding class represents possible vCard photo encoding types.

Typedefs

typedef int AccountId

typedef QPair< SortSpecifier, QString > AnchorValueSpecifier

The AnchorValueSpecifier typedef represents a pair consisting of a SortSpecifier value and a QString value.

The AnchorValueSpecifier typedef is used in both the ContactListFilters and ContactSearchFilter classes, and specifies a sort column and order, and offset the response by a certain anchor value. Here's an example of how to use this typedef:

ContactService service;
QList<Contact> contacts;
ContactListFilters options;
options.setLimit(5);
AnchorValueSpecifier anchorValue;
anchorValue.first = SortSpecifier(SortColumn::FirstName, SortOrder::Ascending);
anchorValue.second = "b";
options.setSortAndAnchorBy(anchorValue);

contacts = service.contacts(options);

Since:

BlackBerry 10.0.0

typedef QList< ContactActivity > ContactActivityList

QList<ContactActivity>

typedef QList< ContactAttribute > ContactAttributeList

typedef int ContactId

typedef QList< ContactPhoto > ContactPhotoList

typedef QList< ContactPostalAddress > ContactPostalAddressList

typedef QPair< AttributeKind::Type, AttributeSubKind::Type > KindSubKindSpecifier

The KindSubKindSpecifier typedef represents a pair consisting of an AttributeKind::Type value and a AttributeSubKind::Type value.

The KindSubKindSpecifier typedef is used to specify a specific kind/sub-kind combination filter for list and search queries.

See also:

ContactListFilters::setHasKindSubKind(), ContactSearchFilters::setHasKindSubKind()

Since:

BlackBerry 10.0.0

typedef QPair< SortColumn::Type, SortOrder::Type > SortSpecifier

The SortSpecifier typedef represents a pair consisting of a SortColumn::Type value and a SortOrder::Type value.

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

Since:

BlackBerry 10.0.0

typedef QString StatusId

Last modified: 2014-03-13

comments powered by Disqus