Our API enables you to control the manner in which content is displayed on various pages in your application using simple Open and Close directives.
The API provides multiple customization options, from selecting content sets to controlling the display methods.
Open widget API
guidde.open(customizationParams) - manually open the widget
guidde.openVideo(videoId, customizationParams) - open a specific video
guidde.openPlaylist(playlistId, customizationParams) - open a specific playlist
videoId | playlistId = the identifier of the playlist or video may be copied from the Guidde URL once you click on either the video or the playlist.
guidde.openQuerySearch(querySearchString, customizationParams) - open the widget with content provided by running search on Space configured for widget
When seeking to open the widget on a page, you may use the open command with the relevant settings for your use case
widgetSize= ‘mini’ | ‘medium’ | ‘theater’
Controls the widget open form factor. The default value is ‘mini’ as can be seen in the following example on a Salesforce page
isExpandedView= true | false
Controls whether the widget be opened in the expanded form(playlist content displayed) or only single video display initially. Works only in ‘mini’ or ‘medium’ widgetSize
playState= ‘play’ | ‘pause’
Controls whether a video will played immediately after the open function call. The default value is ‘pause’
Note: content that you want to open on-demand should be added to the configured Spaces under the widget settings
Close widget API
guidde.close(controlButtonCustomizationParams) - manually close the widget
guidde.setControlButtonView(controlButtonCustomizationParams) - set the preferred control button view. This is useful in cases when a user changes a page and the previous position doesn’t fit well in the new layout
guidde.toggleOpen(customizationParams) - automatically detects the current widget state and calls guidde.open or guidde.close. This is useful if you want to have general button on your website, such as “Knowledge center”
Customization params
controlButtonCustomizationParams = {
controlButtonForm = ‘bottom’ | ‘right’ | ‘none’, //optional
controlButtonBottomPosition = string: ‘Ypx’ | ‘Yvh’ |number //optional
}
Select the control button view that will be displayed if a user closes the widget.
controlButtonForm = ‘bottom’ | ‘right’ | ‘none’
bottom
The widget is displayed at the bottom right corner of your page with your predefined logo and button text copy that were configured under settings
right
The widget is displayed on the right side of the screen with the logo configured in settings.
The widget position can also be customized by selecting the property
controlButtonBottomPosition.
controlButtonBottomPosition= string: ‘Ypx’ | ‘Yvh’ | number
Set the position from screen bottom to control placement on the screen. It can be an absolute value, like ‘Yvh’(vh stands for viewport height, which is the percentage of the screen height) or a direct value: ‘Ypx’ | number - position in pixels
none
The Widget will be hidden after a user clicks on the close button.