Overview
The Buddy List is an application designed to help your users keep track of their friends, and to aid in the launching of new conversations with them. On its own, outside of the Presencebar application, the Buddy List is considered an Alpha product and is only available by request. If you are interested in working with the Buddy List please contact support.
Adding BuddyList
To launch the Buddy List, a valid Embed Code with Token should already be on your page. Following the Embed Code, add a call to up.api.require to load the Buddy List application, with any optional config object you might require.
Example
// Add an onReady handler to launch the Presence Bar experience once the Userplane SDK is available
up.api.addEventListener(up.api.events.READY,function () {
up.api.require("BuddyList",{});
});
</script>
Properties
| Property | Value | Default |
|---|---|---|
| chatGroupEnabled | Enables or disables the Chat Room grouping, which contains copies of the chat rooms a user has interacted with in the past, providing them with an easy means for rejoining those rooms. | true |
| recentGroupEnabled | Enables or disables the Recent Conversations grouping, which contain copies of the users a user has spoken with during the current session, providing them with an easy means for rejoining those conversations. | true |
FAQ
Can I embed BuddyList without Presence Bar?
Yes BuddyList is a standalone application in the same way that Presence Bar is. You can embed it anywhere on your page and take advantage of the buddylist functionality without using the Presence Bar.