blackberry.bbm.platform.io.Connection

Adds a user, who has already joined a connection in this application, to this connection.

Allows the user to invite contacts to join this connection.

A Contact Picker dialog appears and allows the user to select contacts to invite. Only contacts with the application will be shown in the Contact Picker.

Removes a user from the connection.

<script type="text/javascript">

// Remove the first user in a connection
var users = conn.joinedUsers;
if(users.length > 0) {
    conn.remove(conn.joinedUsers[0])
}

</script>

<script type="text/javascript">

// Remove all users in a connection
var users = conn.joinedUsers;
if(users.length > 0) {
    conn.remove(conn.joinedUsers)
}

</script>

Removes all users from the connection.

Sends data to all users on the connection or a subset. Data cannot be sent to users who have not joined.

Unreachable Users

If a user becomes unreachable, up to 50 packets (50 calls of send()) will be queued. A ContactUnreachableException will be thrown on the 51st call.

If the user later becomes reachable, blackberry.bbm.platform.io.event:onuserreachable will be invoked with the now-reachable user.

The BBM Social Platform will continue to attempt to deliver the packets to an unreachable user for 24 hours. If the user does not become reachable within this time, the packets will expire, and blackberry.bbm.platform.io.event:ondataexpired will be invoked.

<script type="text/javascript">

// Send message to all users
var replyText = ""; // Obtain reply text from user...
var msgObj = {
    id:'msg',
    value:replyText
};
try {
    connnection1.send(JSON.stringify(msgObj));
} catch(e) {
    // Error occurred while sending data
}

</script>

<script type="text/javascript">

// Ping all users
var pingObj = { id:'ping' };
try {
    connection1.send(JSON.stringify(pingObj));
} catch(e) {
    // Error occurred while sending data
}

</script>

<script type="text/javascript">

// Send high score to all users
var highScoreObj = {
    id: 'highscore',
    score: 9000,
    hits: 130,
    misses: 40
};
try {
    connection1.send(JSON.stringify(highScoreObj));
} catch(e) {
    // Error occurred while sending data
}

</script>

Invoked when data is received from a user.

<script type="text/javascript">

connection1.ondata = function(user, data) {
    var dataObj = JSON.parse(data);
    var dataID = dataObj.id;

    // Handle application-defined data types
    if(dataID == "msg") {
        // Handle msg type
    } else if(dataID == "ping") {
        // Handle ping type
    } else if(dataID == "highscore") {
        // Handle highscore type
    }
};

</script>

Invoked when a user declines an invitation.

Invoked when a user leaves the connection.

Invoked when the user invites others to join the connection. This will not be called if the user invites others to download the application.

Invoked when users join the connection by accepting an invitation.

This connection's unique ID. Automatically set on connection creation.

Users who have joined the connection.

The number of invited users who have not yet joined the connection.

The maximum number of users a connection can have, not including the current user.

Once the limit is reached, the platform will not allow the user to send more join invitations and will not allow more users to join.

The maximum length of an invitation cookie.

The maximum length of an invitation message.

The maximum length of a data payload.