Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This class provides methods that operate with the templates.
SimpleTemplate(templateName)
Use this constructor instantiates a new object of the SimpleTemplate class.
Parameter(s):
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| templateName | String | N | N |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const template = new SimpleTemplate('Standard task template'); |
applyTo(SimpleRecord)
Use this method to apply the current template to the given object.
| Note |
|---|
When applying a template and inserting a record, remember that the template should match the form of the record in terms of content and mandatory fields, as differences with the SimpleRecord table can cause the server validation to fail. As a result, an error message |
Parameter(s):
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| SimpleRecord | SimpleRecord object | Y | N |
Return:
| Type | Description |
|---|---|
| Void | This method does not return a value. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const task = new SimpleRecord('task');
const template = new SimpleTemplate('Standard task template');
template.applyTo(task);
task.subject = 'From template Task';
ss.info('Created Task ID: ' + task.insert());
ss.info(task.getErrors());
// Info: Created Task ID: 163777658710999477
// Info: [] |
applyToByTemplateField(SimpleRecord, template)
Use this method to apply the value from the Template type field to the object given.
Parameter(s):
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| SimpleRecord | SimpleRecord object | Y | N |
| template | Array/String | Y | N |
Return:
| Type | Description |
|---|---|
| Void | This method does not return a value. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const templateRecord = new SimpleRecord('some_template_dict');
templateRecord.get('156837247306928785');
const task = new SimpleRecord('task');
const template = new SimpleTemplate();
template.applyToByTemplateField(task, templateRecord.template);
ss.info(task.getAttributes());
task.insert(); |
createBySimpleRecord(SimpleRecord, templateName)
Use this method to create a template from a SimpleRecord object with a specified name. The method returns the ID of the created template.
Parameter(s):
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| SimpleRecord | SimpleRecord object | Y | N |
| templateName | String | Y | N |
| templateTableName | String | N | '' |
Return:
| Type | Description |
|---|---|
| String | This method returns the template ID. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const task = new SimpleRecord('task');
task.get('156837247306928785');
const template = new SimpleTemplate();
ss.info(JSON.stringify(template.createBySimpleRecord(task, 'New task template'))); |
createByTemplateData(templateData, tableName, templateName, templateTableName)
Use this method to create a template. To do so, specify the name and table to which the object template belongs. The attribute name of the templateData object is the system name of the column.
Parameter(s):
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| templateData | Object | Y | N |
| tableName | String | Y | N |
| templateName | String | Y | N |
| templateTableName | String | N | '' |
Return:
| Type | Description |
|---|---|
| String | This method returns the ID of the created template. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const template = new SimpleTemplate();
ss.info(JSON.stringify(template.createByTemplateData({'subject': 'New subject'}, 'task', 'new task template'))); |
createByTemplateField(template, tableName, templateName)
Use this method to create a template with the specified name and a table to which the template object belongs.
Parameter(s):
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| template | Object | Y | N |
| tableName | String | Y | N |
| templateName | String | Y | N |
| templateTableName | String | N | '' |
Return:
| Type | Description |
|---|---|
| String | This method returns the ID of the created template. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const template = new SimpleTemplate();
ss.info(JSON.stringify(template.createByTemplateField({'subject': 'New subject'}, 'task', 'New task template'))); |
get(templateName)
Use this method to get a template from the template storage by its unique name.
Parameter(s):
| Name | Type | Mandatory | Default value |
|---|---|---|---|
| templateName | String | Y | N |
Return:
| Type | Description |
|---|---|
| Void | This method does not return a value. |
Example:
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
const template = new SimpleTemplate();
template.get('Record template'); |
| Table of Contents | ||||
|---|---|---|---|---|
|