Presence Bar


Overview

Presencebar is an integrated, in-window experience that allows you users to chat with each other. Being a popup experience provides a whole host of specific use cases along with configurable options that pertain specifically to the pop-out experience. If you are interested in a pop-out Instant Messaging experience please see Webmessenger.

Launching Presencebar

To launch Presencebar 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("PresenceBar",{});
  }
  up.api.addEventListener(up.api.events.READY,onReady);

</script>

Properties

 

Property Value Default
customContainers Embed custom containers into your Presencebar using this array property. See Custom Containers for more information
minimized Determines whether the bar is minimized by default. If a user chooses to maximize it will stay maximized as their choice will override this embed. false
minimizeLocation The location of where Presencebar should minimize to. Options are “left” and “right”.
showOfflineUsers Whether or not to show the users who are currently offline in the buddy list.

Example

<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("PresenceBar",{
          minimizeLocation:"left",
          customContainers: [
            {label:"image",id: "branding", className:"publisher-branding",config: {
type:"image",url:'http://pathToYourLogo.png',width:259,height:30}
            }]
	});
  }
  up.api.addEventListener(up.api.events.READY,onReady);

</script>