BBM

The following information shows you how to use the invocation framework with BBM. If you are developing a C++ or QML app, see BBM for information on the BBM API.

Sharing a file with BBM

Here are the invocation attributes you use to share a file with BBM:

Attribute Value
Target ID

sys.bbm.sharehandler

Action

bb.action.SHARE

URI

file:///path/to/my/content.doc

Opening the BBM app

Here are the invocation attributes you use to open the BBM app:

Attribute Value
Target ID

sys.bbm

Action

bb.action.OPEN

Setting a BBM display picture

Here are the invocation attributes you use to set a picture as a BBM display picture:

Attribute Value
Target ID

sys.bbm.imagehandler

Action

bb.action.SET

URI

file:///path/to/my/content.jpg

Sharing text with BBM

Here are the invocation attributes you use to share text with BBM:

Attribute Value
Target ID

sys.bbm.sharehandler

Action

bb.action.SHARE

MIME type

text/plain

Data

Text string to be shared

Sharing text or an image with BBM Groups

Here are the invocation attributes you use to share text or an image with BBM Groups:

Attribute Value
Target ID

sys.bbgroups.sharehandler

Action

bb.action.SHARE

URI

file:///path/to/my/content.txt or file:///path/to/my/image.png

Inviting a user to BBM or starting a BBM chat

Here are the invocation attributes you use to invite a user to BBM or to start a BBM chat:

Attribute Value
Target ID

sys.bbm.sharehandler

Action

bb.action.BBMCHAT

URI

pin:<pin>

This invocation action displays either an Invite to BBM screen or the BBM chat composer screen depending on whether the specified PIN is already a BBM contact.

Inviting a user to BBM

Here are the invocation attributes you use to invite a user to BBM:

Attribute Value
Target ID

sys.bbm.sharehandler

Action

bb.action.INVITEBBM

URI

pin:<pin>

Starting a BBM audio or video chat

Here are the invocation attributes you use to start a BBM audio or video chat with a contact:

Attribute Value
Target ID

sys.service.videochat

Action

bb.action.OPEN

Data

dest=<BlackBerry ID or PIN of contact>&video=<0 or 1>

The value 0 is specified for an audio call and 1 is specified for a video call (for example, dest=user01@example.com&video=1).

Invoking your BBM Channel

Here are the invocation attributes you use to invoke your BBM Channel from within your app:

Attribute Value
Target ID

sys.bbm.channels.card.previewer

Action

bb.action.OPENBBMCHANNEL

URI

bbmc:<my BBM channel PIN>

Sharing text or an image with BBM Channels

Here are the invocation attributes you use to share a text or an image with BBM Channels:

Attribute Value
Target ID

sys.bbm.channels.sharehandler

Action

bb.action.SHARE

URI

file:///path/to/my/content.doc, file:///path/to/my/image.jpg

Starting a multi-person chat

Here are the invocation attributes you use to start a multi-person chat in BBM:

Attribute Value
Target ID

sys.bbm.sharehandler

Action

bb.action.BBMCONF

MIME type

vnd.bb.bbm/contactlist

Data must be sent in JSON format, as follows:

"conference": {   
    "contacts" : [ 
    { "pin" : "1234ABCD" },
    { "pin" : "1234567A" },
    ]
}

When sending data, you must specify the contact's PIN in the pin field.

API support for starting a group chat in BBM is available in API level 10.1 and later of the BlackBerry 10 Native SDK.

Last modified: 2014-11-17



Got questions about leaving a comment? Get answers from our Disqus FAQ.

comments powered by Disqus