Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This class allows the client-side script to execute the code on the server-side using Script Includes. it is used to create branded notifications.
setTitle(title)
This method sets the main header of email notification.
Parameter(s):
Name | Type | Mandatory | Default value |
|---|---|---|---|
| title | String | Y | N |
Return:
Type | Description |
|---|---|
| Void | This method does not return a value. |
setBodyHeader(bodyHeader)
This method sets the header of text body of email notification.
Parameter(s):
Name | Type | Mandatory | Default value |
|---|---|---|---|
| bodyHeader | String | Y | N |
Return:
Type | Description |
|---|---|
| Void | This method does not return a value. |
setBodyText(bodyText)
This method sets the main text body of email notification notification.
Parameter(s):
Name | Type | Mandatory | Default value |
|---|---|---|---|
| bodyText | String | Y | N |
Return:
Type | Description |
|---|---|
| Void | This method does not return a value. |
setComment(comment)
This method sets the email notification comment:
- puts it in an area with a grey background
- highlights it italic.
Parameter(s):
Name | Type | Mandatory | Default value |
|---|---|---|---|
| comment | String | Y | N |
Return:
Type | Description |
|---|---|
| Void | This method does not return a value. |
getTitle(title)
This method returns the main header of notification.
Return:
Type | Description |
|---|---|
| String | The main header of notification. |
getBodyHeader(bodyHeader)
This method returns the main header of text body.
Return:
Type | Description |
|---|---|
| String | The main header of text body. |
getBodyText(bodyText)
This method returns the main text body.
Return:
Type | Description |
|---|---|
| String | The main text body. |
getComment(comment)
This method returns the comment text.
Return:
Type | Description |
|---|---|
| String | The comment text. |
getButtons(buttons)
This method returns the array of buttons.
Return:
Type | Description |
|---|---|
| Array | The array of buttons. |
addButton(button)
This methods adds a new button to array of buttons.
Parameter(s):
Name | Type | Mandatory | Default value |
|---|---|---|---|
| text | String | Y | N |
| url | String | Y | N |
| color | String | Y | N |
| buttonArray | Array | Y | N |
Return:
Type | Description |
|---|---|
| Array | The base of buttons array with the new one. |
removeButton(button)
This method removes the last added button.
removeAllButtons(buttons)
This method removes all added buttons.
setProperty(propertyName, input, propertyTitle)
This method sets internal method for input type validation.
Parameter(s):
Name | Type | Mandatory | Default value |
|---|---|---|---|
| propertyName | String | Y | N |
| input | Any | Y | N |
| propertyTitle | String | Y | N |
formEmailTemplate()
This method creates and returns HTML template based on set properties.
Return:
Type | Description |
|---|---|
| String | The HTML template. |