ProfileBoxItem

Since: BlackBerry 10.0.0

#include <bb/platform/bbm/ProfileBoxItem>

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

Represents an item in your app's profile box inside the user's BBM profile.

The ProfileBoxItem class provides accessor methods to the main attributes of a profile box item, including cookie, itemId, iconId, and text.

The user profile box is an area for your app that appears in the current user's BlackBerry Messenger profile. Each box contains a list of items, each composed of text and an optional icon. A profile box can contain a maximum of 3 items. As new items are added, older items are removed automatically.

This box can be viewed by the current user and their contacts. It can be modified by the current user and the app that owns it. The current user can remove items only.

The user can control whether an app's profile box appears in their profile by using the global settings application. The application is only allowed to make changes if the user enables this option. This can be checked using permissionValue(Permission::ProfileUpdatesAllowed).

The user can invoke the app from its profile box in their BBM profile or a contact's BBM profile. The app will be brought to the foreground or launched if it's not already running. Contacts who do not have the app installed will be brought to the app's page in BlackBerry World if that app version is available on BlackBerry World.


Overview

Public Functions Index

ProfileBoxItem ()
ProfileBoxItem (const ProfileBoxItem &profileBoxItem)
~ProfileBoxItem ()
QStringcookie () const
inticonId () const
QStringid () const
ProfileBoxItem &operator= (const ProfileBoxItem &profileBoxItem)
QStringtext () const

Public Functions

ProfileBoxItem ()

Creates a new profile box item object.

Since:

BlackBerry 10.0.0

ProfileBoxItem (

Copy constructor.

Parameters
profileBoxItem

The existing ProfileBoxItem object to copy.

Since:

BlackBerry 10.0.0

~ProfileBoxItem ()

Destructor.

Since:

BlackBerry 10.0.0

int iconId ()

Retrieves the iconId of the icon associated with the profile box item.

An image in a profile box is identified by a unique, non-negative numeric ID. This icon must have been registered using bool requestRegisterIcon(int iconId, bb::platform::bbm::ImageType::Type iconType, const QByteArray &iconData) in ProfileBox.

Return:

The ID of the icon associated with this profile box item or -1 if no icon is associated with this ProfileBoxItem

Since:

BlackBerry 10.0.0

QString id ()

Retrieves the id of this profile box item.

Each ProfileBoxItem is identified by a unique, non-negative numeric ID.
Return:

The ID of this profile box item.

Since:

BlackBerry 10.0.0

ProfileBoxItem & operator= (

Assignment operator.

Parameters
profileBoxItem

The existing ProfileBoxItem object to copy.

Return:

The ProfileBoxItem instance.

Since:

BlackBerry 10.0.0

QString text ()

Retrieves the text of this profile box item.

Return:

The text of this profile box item.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus