menu_sub_item_type_t

This enumeration defines the possible types of menu sub-items.

Synopsis:

#include "bps/menu.h"
 
typedef enum {
      MENU_SUB_ITEM_TYPE_UNSPECIFIED = 0   
      MENU_SUB_ITEM_TYPE_CHANNEL = 1   
      MENU_SUB_ITEM_TYPE_SHORTCUT_CONTACT = 2   
      MENU_SUB_ITEM_TYPE_SHORTCUT_ACCOUNT = 3   
      MENU_SUB_ITEM_TYPE_SHORTCUT_EVENT = 4   
} menu_sub_item_type_t;

Since:

BlackBerry 10.2.0

Data:

MENU_SUB_ITEM_TYPE_UNSPECIFIED
The menu sub-item type is not specified.
MENU_SUB_ITEM_TYPE_CHANNEL
The menu sub-item represents a menu entry that includes target-related display information, such as the label and icon.
MENU_SUB_ITEM_TYPE_SHORTCUT_CONTACT
The menu sub-item represents a menu entry that includes contact-related display information, such as the label, icon and secondary icon.

It is intended to be displayed apart from any MENU_SUB_ITEM_TYPE_CHANNEL items, possibly in a more prominent position within the displayed menu, based on the menu sub-item's frecency.

MENU_SUB_ITEM_TYPE_SHORTCUT_ACCOUNT
The menu sub-item represents a menu entry that includes account-related display information, such as the label, icon and secondary icon.

It is intended to be displayed apart from any MENU_SUB_ITEM_TYPE_CHANNEL items, possibly in a more prominent position within the displayed menu, based on the menu sub-item's frecency.

MENU_SUB_ITEM_TYPE_SHORTCUT_EVENT
The menu sub-item represents a menu entry that includes calendar event-related display information, such as the label, icon and secondary icon.

It is intended to be displayed apart from any MENU_SUB_ITEM_TYPE_CHANNEL items, possibly in a more prominent position within the displayed menu, based on the menu sub-item's frecency.

Library:

libbps (For the qcc command, use the -l bps option to link against this library)

Description:

Menu sub-items can be grouped into two general categories: channels or shortcuts.

Shortcut sub-items are formed based on user preferences and usage. For example, a device user might share pictures more frequently with a small set of contacts using specific targets to share the content, such as email or BBM. In order to tailor the sharing experience to the user's activity, the menu will include menu sub-items that include display information and the menu invocation that represent the user's preferences. For example, the menu sub-item might include a contact's display name as the label, the invocation target icon as the primary icon, and the contact's icon or avatar as the secondary icon. The menu invocation would include the information necessary for the invocation target to preselect that contact as the recipient of the shared content. Shortcut sub-items also include a frecency (frequent/recent) score that can be used to display the sub-item in a prominent position in the menu.

Channel sub-items represent invocation targets that do not include user preference specific information. Channel sub-items include display information such as the label and icon that represent the target to be invoked. Channel sub-items also carry a frecency score that can be used to display the sub-item in a more prominent position in the menu.