ContactOnlineStatus
Since: BlackBerry 10.0.0
#include <bb/pim/contacts/ContactOnlineStatus>
To link against this class, add the following line to your .pro file: LIBS += -lbbpim
The ContactOnlineStatus class represents the online status of a contact.
Overview
Public Functions Index
| ContactOnlineStatus () | |
| ContactOnlineStatus (const ContactOnlineStatus ©) | |
| ~ContactOnlineStatus () | |
| bool | canComment () const |
| bool | canDelete () const |
| bool | canLike () const |
| int | commentCount () const |
| int | id () const |
| bool | isFavorited () const |
| bool | isRetweeted () const |
| bool | isSyncing () const |
| bool | isWifiOn () const |
| int | likeCount () const |
| int | onlineStatusCode () const |
| ContactOnlineStatus & | operator= (const ContactOnlineStatus &operand) |
| AccountId | originAccountId () const |
| ContactId | originContactId () const |
| StatusId | originStatusId () const |
| QVariantMap | status () const |
| QString | statusMessage () const |
| QDateTime | statusTimeStamp () const |
| bool | userLikes () const |
Public Functions
Copy constructor.
This function constructs a ContactOnlineStatus containing exactly the same values as the provided ContactOnlineStatus.
| Parameters | |
|---|---|
| copy |
The ContactOnlineStatus to be copied. |
BlackBerry 10.0.0
Destructor.
BlackBerry 10.0.0
bool
Indicates whether the user is allowed to comment on this ContactOnlineStatus.
true if the user can comment on this ContactOnlineStatus, false otherwise.
BlackBerry 10.0.0
bool
Indicates whether the user is allowed to delete this ContactOnlineStatus.
true if the user is allowed to delete this ContactOnlineStatus, false otherwise.
BlackBerry 10.0.0
bool
Indicates whether the user is allowed to like this ContactOnlineStatus.
true if the user likes this ContactOnlineStatus, false otherwise.
BlackBerry 10.0.0
int
Retrieves the number of comments for this ContactOnlineStatus.
The number of comments for this ContactOnlineStatus.
BlackBerry 10.0.0
int
Retrieves the internal ID of this ContactOnlineStatus.
The internal ID of this ContactOnlineStatus.
BlackBerry 10.0.0
bool
Indicates whether the user has favorited this ContactOnlineStatus.
true if the user has favorited this ContactOnlineStatus, false otherwise.
BlackBerry 10.0.0
bool
Indicates whether the user has retweeted this ContactOnlineStatus.
true if the user has retweeted this ContactOnlineStatus, false otherwise.
BlackBerry 10.0.0
bool
Indicates whether the source account that's associated with this ContactOnlineStatus is currently synchronizing.
true if the source account is currently synchronizing, false otherwise.
BlackBerry 10.0.0
bool
Indicates whether a Wi-Fi connection is currently active.
true if a Wi-Fi connection is currently active, false otherwise.
BlackBerry 10.0.0
int
Retrieves the number of likes for this ContactOnlineStatus.
The number of likes for this ContactOnlineStatus.
BlackBerry 10.0.0
int
Retrieves the online status code of this ContactOnlineStatus.
0: offline
1: online
2: away
3: busy
The online status code of this ContactOnlineStatus.
BlackBerry 10.0.0
ContactOnlineStatus &
Assignment operator.
This operator copies all values from the provided ContactOnlineStatus into this ContactOnlineStatus.
| Parameters | |
|---|---|
| operand |
The ContactOnlineStatus from which to copy all values. |
A ContactOnlineStatus with all copied data
BlackBerry 10.0.0
AccountId
Retrieves the original account ID of the contact that's associated with this ContactOnlineStatus.
Contacts can be merged from multiple accounts to form a single contact. For example, contacts might be merged from a LinkedIn account, Facebook account, and Twitter account. If the same contact exists in all accounts, the contact information is merged into a single contact that includes all of the information from each account. This function returns the account ID of the specific account that this online status applies to.
You can use this value, along with the AccountService class, to determine specific information about the account.
The original account ID of the contact that's associated with this ContactOnlineStatus.
AccountService
BlackBerry 10.0.0
ContactId
Retrieves the original sourced contact ID of the contact that's associated with this ContactOnlineStatus.
Contacts can be merged from multiple accounts to form a single contact. For example, contacts might be merged from a LinkedIn account, Facebook account, and Twitter account. If the same contact exists in all accounts, the contact information is merged into a single contact that includes all of the information from each account. This function returns the contact ID of the specific contact (not the merged contact) that this online status applies to.
You can use this value, along with the originAccountId() function, to retrieve a specific contact using ContactService::contactDetails().
The original sourced contact ID of the contact that's associated with this ContactOnlineStatus.
BlackBerry 10.0.0
StatusId
Retrieves the original sourced status ID of this ContactOnlineStatus.
The original sourced status ID of this ContactOnlineStatus.
BlackBerry 10.0.0
QVariantMap
Retrieves the rich status of this ContactOnlineStatus.
This status can include, text, images, links and videos.
The complete status of this ContactOnlineStatus.
BlackBerry 10.0.0
QString
Retrieves the status message of this ContactOnlineStatus.
This message can be any text that the contact has set on their account.
The status message of this ContactOnlineStatus.
BlackBerry 10.0.0
QDateTime
Retrieves the time stamp of this ContactOnlineStatus.
This time stamp represents the last time that the contact's status was updated.
The time stamp of this ContactOnlineStatus.
BlackBerry 10.0.0
bool
Indicates whether the user likes this ContactOnlineStatus.
true if the user likes this ContactOnlineStatus, false otherwise.
BlackBerry 10.0.0