Class finesse.containerservices.PopoverSchema

Finesse Voice component and Gadget(s) hosting digital services require the finesse.containerservices.PopoverService to display a popup for incoming call and chat events.
This API provides the schema that is used in finesse.containerservices.PopoverService for managing various operations in the popup. This schema has been defined as per http://json-schema.org/
Defined in: finesse.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	finesse.containerservices.PopoverSchema()

Method Summary
Method Attributes	Method Name and Description
	getActionDataSchema()
	getBannerDataSchema()
	getTimerDataSchema()

Class Detail

finesse.containerservices.PopoverSchema()

Method Detail

getActionDataSchema()



Example JSON for ActionData:
{ 
    "dismissible": true, // or "false"
    "clientIdentifier" : 'popup1', // A string to uniquely identify a specific popover
    "requiredActionText": "Please answer the call from your phone",
    "buttons": // Optional. Max 2  
    [
        {
            "id": "No",
            "label": "Decline",
            "type": "Decline",
            "hoverText": "",
            "confirmButtons": [ // confirmButtons is an optional property in actionData
                {
                    "id": "Yes",
                    "label": "Reject - Return to campaign",
                    "hoverText": ""
                },
                {
                    "id": "No",
                    "label": "Close - Remove from campaign",
                    "hoverText": ""
                }
            ]
        }
    ]
}

Returns:

Schema for the validation of the below JSON definition

Key	Type	Example	Description
dismissible	boolean	true	True if button definition is optional. Flase if button definition is mandatory.
clientIdentifier	string	popover1	A unique identifier across all popovers. This is used in the callback for popover events
requiredActionText [Optional]	String	Please answer the call from your phone	This text is at the bottom of the popover to inform what action the user has to take.
buttons [Optional]	Array		Buttons displayed in the popover. Maximum 2 buttons. It can be defined as below:
id	string	ok1	A unique ID that represents a button
label	string	Accept	The display text of the action button
type	enum	Affirm	Affirm for green button. Decline for red button
hoverText [Optional]	String	Click here to accept chat	The tooltip that is displayed on mouse hover
confirmButtons [Optional]	Object		An additional confirmation message with the buttons to be displayed when the user clicks on the above action button. It can be defined as below:
id	string	id	Id of the confirmation button
label	string	Reject - Return to campaign	Label to displayed on the button
hoverText	string	Click here to reject	Tooltip message on the button

getBannerDataSchema()



Example JSON for BannerData:
{
    "icon": { // Mandatory
        "type": "collab-icon",
        "value": "chat"
    },
    "content": [ // Optional. first 6 name/value pairs is shown in popover
        {
            "name": "Customer Name",
            "value": "Michael Littlefoot"
        },
        {
            "name": "Phone Number",
            "value": "+1-408-567-789"
        },
        {
            "name": "Account Number",
            "value": "23874567923"
        },
        {
            "name": "Issue", // For the below one, tool tip is displayed
            "value": "a very long text. a very long text.a very long text.a very long text.a very long text."
        }
    ]
    "headerContent" : {
        "maxHeaderTitle" : "Popover maximised title",
        "minHeaderTitle" : "Popover minimized title"
    }
}

Returns:

Schema for the validation of the below JSON definition

Key	Type	Example	Description
icon	Object		A icon that should be displayed in the Popover. It should be defined as below:
type	Enum	collab-icon	Takes either collab-icon or url as a value. collab-icon applies a stock icon url applies a custom icon supplied by gadget. The icon could be located as part of gadget files in Finesse.
value	String	Chat	The name of the stock icon or the url of the custom icon
content [Optional]	Array		First six name/value pairs is shown in popover. A single property should be defined as below:
name	String	Customer Name	The property name that is displayed on the left
value	String	Michael Littlefoot	The corresponding property value that is displayed on the right. Note: For long property values, a tooltip is displayed.
headerContent	Object		The title of popover when it is shown or minimized. It should be defined as below
maxHeaderTitle	String	Chat from firstName lastName	Popover title when it is not minimized
minHeaderTitle	String	firstName	Popover title when it is minimized

getTimerDataSchema()



Example JSON for TimerData:
{
    "displayTimeoutInSecs": 30, // mandatory. minimum is 3 and maximum is 3600. -1 indicates no upper limit
    "display": true, // false means no displayable UI for timer
    "counterType": COUNT_UP or COUNT_DOWN,
}

Returns:

Key	Type	Example	Description
displayTimeoutInSecs [Mandatory]	Integer	30	Minimum is 3 and maximum is 3600. -1 indicates no upper limit
display	boolean	true	false indicates not to display any timer
counterType	enum	COUNT_UP	Takes value COUNT_UP or COUNT_DOWN. For scenarios like how long the chat has been active would require a COUNT_UP timer. On the other hand before chat is autoclosed for a agent RONA, it would be apt to use a COUNT_DOWN timer.

Classes

Class finesse.containerservices.PopoverSchema