core_v2_tourTip Script API

Enables scripted content fragments to use Tour Tips

Methods

Lists tour tips with read state for the accessing user and requested tip keys

#set($apiListResponse = $core_v2_tourTip.List($tipKeys))

var apiListResponse = core_v2_tourTip.List(tipKeys);

Name	Type	Description	Required	Default	Options
tipKeys	`IList of String`	Tip keys	Required

ApiList of TourTip

Marks a tour tip as read or unread for the accessing user

#set($tourTipResponse = $core_v2_tourTip.Mark($tipKey, $asRead))

var tourTipResponse = core_v2_tourTip.Mark(tipKey, asRead);

Name	Type	Description	Required	Default	Options
tipKey	`String`	Tip key	Required
asRead	`Boolean`	Read state	Required

TourTip

Renders an HTML attribute string which can be embedded in any element to provide a tour tip associated with the element.

#set($stringResponse = $core_v2_tourTip.Render($message))

var stringResponse = core_v2_tourTip.Render(message);

Name	Type	Description	Required	Default	Options
message	`String`	Tour tip message	Required

Renders an HTML attribute string which can be embedded in any element to provide a tour tip associated with the element.

#set($stringResponse = $core_v2_tourTip.Render($message, "%{ CssClass = $cssClassArg, Index = $indexArg }"))

var stringResponse = core_v2_tourTip.Render(message, { CssClass: cssClassArg, Index: indexArg });

Name	Type	Description	Required
message	`String`	Tour tip message	Required
options	Options	Set of optional parameters including:	Required
CssClass	`String`	Additional CSS class(es) to associate with the element	Optional
Index	`Int32`	Requested order at which to display the tour tip	Optional

String

Recommended