Module

RMP_Button

Methods

# inner getMessage() → {string}

Returns the message displayed to the connected user when the button is clicked.
string

# inner getOnClickAction() → {string}

Returns the "On click" action (show-message, close, redirect, load-next).
string

# inner getRedirectUrl() → {string}

Returns the redirect URL if the "On click" type is "redirect".
string

# inner getType() → {string}

Returns the type of the widget (RMP_Button).
string

# inner setExecuteScript(callBk)

Sets a callback function for a button widget's 'execute_script' action.
Parameters:
Name Type Description
callBk buttonCallback Callback to execute after the button has been clicked

# inner setMessage(msg)

Sets the message displayed to the connected user when the button is clicked.
Parameters:
Name Type Description
msg string Message value

# inner setOnClickAction(action)

Sets the "On click" action.
Parameters:
Name Type Description
action string "On click" action: show-message, close, redirect, load-next

# inner setOnPrelaunchScript(callBk)

Sets a callback function to handle pre-launch script parameters of a button widget.
Parameters:
Name Type Description
callBk buttonCallback Callback that handles the pre-launch script

# inner setRedirectUrl(url)

Sets the redirect URL if the "On click" type is "redirect".
Parameters:
Name Type Description
url string Redirect URL