core_v2_editableGroup Script API

Ben Tiedt — Fri, 15 Jan 2021 19:34:10 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 19:34:10

Enables scripted content fragments to be edited in groups.

GetEditUrl
GetRegistrationScript
GetSaveScript
GetValidationScript
GetViewUrl
IsEditable

Methods

GetEditUrl

GetEditUrl Overload 1

Gets a URL that can be accessed to enable editing of an editable group

Velocity

#set($stringResponse = $core_v2_editableGroup.GetEditUrl($groupName))

JavaScript

var stringResponse = core_v2_editableGroup.GetEditUrl(groupName);

Parameters

Name	Type	Description	Required	Default	Options
groupName	`String`	Name of the editable group	Required

GetEditUrl Overload 2

Gets a URL that can be accessed to enable editing of an editable group

Velocity

#set($stringResponse = $core_v2_editableGroup.GetEditUrl($groupName, $url))

JavaScript

var stringResponse = core_v2_editableGroup.GetEditUrl(groupName, url);

Parameters

Name	Type	Description	Required	Default	Options
groupName	`String`	Name of the editable group	Required
url	`String`	Base URL to modify to enable editing of the editable group	Required

Returns

String

GetRegistrationScript

GetRegistrationScript Overload 1

Gets a Javascript script that can be executed to register a widget to participate in an editable group

Velocity

#set($stringResponse = $core_v2_editableGroup.GetRegistrationScript($groupName, $saveClientFunction))

JavaScript

var stringResponse = core_v2_editableGroup.GetRegistrationScript(groupName, saveClientFunction);

Parameters

Name	Type	Description	Required	Default	Options
groupName	`String`	Name of the editable group	Required
saveClientFunction	`String`	Javascript function to execute when the editable group is being saved. The function is given two parameters: a save function to be called when saving is successful and a failure function to be called when saving is unsuccessful. The save function can also return true/false to identify in-process save state in leiu of the success/failure functions.	Required

GetRegistrationScript Overload 2

Gets a Javascript script that can be executed to register a widget to participate in an editable group

Velocity

#set($stringResponse = $core_v2_editableGroup.GetRegistrationScript($groupName, $saveClientFunction, $validationClientFunction))

JavaScript

var stringResponse = core_v2_editableGroup.GetRegistrationScript(groupName, saveClientFunction, validationClientFunction);

Parameters

Name	Type	Description	Required
groupName	`String`	Name of the editable group	Required
saveClientFunction	`String`	Javascript function to execute when the editable group is being saved. The function is given two parameters: a success function to be called when saving is successful and a failure function to be called when saving is unsuccessful. The save function can also return true/false to identify in-process save state in leiu of the success/failure functions.	Required
validationClientFunction	`String`	Javascript function to execute when the editable group is being validated. The function is given two parameters: a success function to be called when validation is successful and a failure function to be called when validation is unsuccessful. The validation function can also return true/false to identify in-process validation state in leiu of the success/failure functions.	Required

Returns

String

GetSaveScript

Gets a Javascript script that can be executed to save all registered widgets in an editable group

Velocity

#set($stringResponse = $core_v2_editableGroup.GetSaveScript($groupName, $successClientFunction, $failureClientFunction))

JavaScript

var stringResponse = core_v2_editableGroup.GetSaveScript(groupName, successClientFunction, failureClientFunction);

Parameters

Name	Type	Description	Required
groupName	`String`	Name of the editable group	Required
successClientFunction	`String`	Javascript function that is called when the saving of all registered widgets is successful	Required
failureClientFunction	`String`	Javascript function that is called when any registered widget fails to save	Required

Returns

String

GetValidationScript

Gets a Javascript script that can be executed to validate all registered widgets in an editable group

Velocity

#set($stringResponse = $core_v2_editableGroup.GetValidationScript($groupName, $successClientFunction, $failureClientFunction))

JavaScript

var stringResponse = core_v2_editableGroup.GetValidationScript(groupName, successClientFunction, failureClientFunction);

Parameters

Name	Type	Description	Required
groupName	`String`	Name of the editable group	Required
successClientFunction	`String`	Javascript function that is called when the validation of all registered widgets is successful	Required
failureClientFunction	`String`	Javascript function that is called when any registered widget fails to validate	Required

Returns

String

GetViewUrl

Gets a URL that can be accessed to disable editing of an editable group

Velocity

#set($stringResponse = $core_v2_editableGroup.GetViewUrl($groupName))

JavaScript

var stringResponse = core_v2_editableGroup.GetViewUrl(groupName);

Parameters

Name	Type	Description	Required	Default	Options
groupName	`String`	Name of the editable group	Required

Returns

String

IsEditable

Identify if a group is currently in its edit state

Velocity

#set($booleanResponse = $core_v2_editableGroup.IsEditable($groupName))

JavaScript

var booleanResponse = core_v2_editableGroup.IsEditable(groupName);

Parameters

Name	Type	Description	Required	Default	Options
groupName	`String`	Name of the editable group	Required

Returns

Boolean