The webmessenger is a popup instant messaging experience. It’s primary advantage as an experience lies in it’s stateless nature in that it can maintain a video session while the parent page is being reloaded or navigating from page to page. 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 an embeded Instant Messaging experience please see Presence Bar.
There is no need to enable the webmessenger as it is the default experience, simply embeding Userplane will result in
| Property | Value | Default |
|---|---|---|
| wmWindowHeight | The height of the window for Webmessenger. | |
| wmWindowWidth | The width of the window for Webmessenger. | |
| wmWindowName | The label of the window for the Webmessenger. | |
| wmWindowDecoratorURI | The path to the window decorator. See decorator below. | |
| wmWindowDecoratorContainerId | The id of the div where you want the Webmessenger rendered inside the decorator. | |
| enableNotifications | Controls whether or not the built-in notifications are used. | true |
| Property | Value | Default |
|---|---|---|
| line1Label | The label for the first line of profile data. | Age |
| line2Label | The label for the second line of profile data. | Sex |
| line3Label | The label for the third line of profile data | Location |
| line4Label | Not currently used. | |
| invitationMessage | Text display to let the user know its an incoming conversation request. | Incoming Conversation Request! |
This sample is of a locale override being added to your up.init call inside the settings object.
// this object would be added to your up.init call
settings: { locale: {
line1Label: "Age",
line2Label: "Sex",
line3Label: "Location",
line4Label: "",
invitationMessage:"Would you like to chat?"
}
}