Buddy List

Overview

The Buddy List is an application designed to help your users keep track of their friends and aid in launching new conversations with them. At this stage 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.


Launching the BuddyList

To launch BuddyList run your regular embed code and then add a call to up.api.require to load the application with whatever config you wish.

Example

<script type="text/javascript" src="http://cdn.userplane.com/release/sdk/userplane.js"></script>
<script>
   // Embed the Userplane SDK and provide the general configuration for your account.
   up.init({
      siteId:"YOUR_SITE_ID",
      key: "",
      token: "YOUR_SSO_TOKEN",
      lang: "en-us"
   });

   // Add an onReady handler to launch the Presence Bar experience once the Userplane SDK is available.
   onReady = function () {
	up.api.require("BuddyList",{});
  }
  up.api.addEventListener(up.api.events.READY,onReady);

</script>

Properties

Property Value Default
chatGroupEnabled Enable or disable the chat room group which contains a copy of the chat rooms you have interacted with in the past, providing an easy way to rejoin the room. true
recentGroupEnabled Enable or disable the recent groups which contain a copy of the users you have spoken with during your current session as a custom roster group. true