Enables scripted content fragments to use Tour Tips
Methods
List
Lists tour tips with read state for the accessing user and requested tip keys
Usage
#set($apiListResponse = $core_v2_tourTip.List($tipKeys))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tipKeys | IList<string> | Tip keys | Required |
Return Type
Mark
Marks a tour tip as read or unread for the accessing user
Usage
#set($tourTipResponse = $core_v2_tourTip.Mark($tipKey, $asRead))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
tipKey | string | Tip key | Required | ||
asRead | bool | Read state | Required |
Return Type
Render
Renders an HTML attribute string which can be embedded in any element to provide a tour tip associated with the element.
Usage
#set($stringResponse = $core_v2_tourTip.Render($message))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
message | string | Tour tip message | Required |
Return Type
string
Render
Renders an HTML attribute string which can be embedded in any element to provide a tour tip associated with the element.
Usage
#set($stringResponse = $core_v2_tourTip.Render($message, "%{CssClass = $cssClassArg, Index = $indexArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
message | string | Tour tip message | Required | ||
CssClass | string | Additional CSS class(es) to associate with the element | Optional | ||
Index | int | Requested order at which to display the tour tip | Optional |
Return Type
string