Deluge script executions | Zoho Creator Help

Deluge script executions


This API service lets you manage the different functionalities in a form.

Deluge script executions

Methods
This should be called to execute the "on user input" deluge script of a field in a form. It should be called after a user has completed giving input for the field.
Use  "FieldProtocol.onUserInputExists"  to find out if the field has an "on user input" script.
 
This should be called to execute the "on user input" deluge script of a field while editing a record in the report. It should be called after a user has completed giving input for the field.
use  "FieldProtocol.onUserInputExists"  to find out if the field has an "on user input" script.
 
This should be called to execute the "on add row" deluge script in a subform every time a new entry has to be added. It should be called before showing the subform.
Use  "SubFormField.onAddRowExists"  to find out if the subform field has an "on add row" script.
 
This should be called to execute the "on add row" deluge script in a subform every time a new entry has to be added. It should be called before showing the subform. This method is applicable while adding a record from report.
Use  "SubFormField.onAddRowExists"  to find out if the subform field has an "on add row" script.
 
This should be called to execute the "on add row" deluge script in a subform every time a new entry has to be added. It should be called before showing the subform. This method is applicable while editing a record in a report.
Use  "SubFormField.onAddRowExists"  to find out if the subform field has an "on add row" script.
 
This should be called to execute the "on delete row" deluge script in a subform every time an entry is deleted.
Use  "SubFormField.onDeleteRowExists"  to find out if the subform field has an "on delete row" script.
 
This should be called to execute the "on delete row" deluge script in a subform every time an entry is deleted. This API is applicable while adding a record from report.
Use  "SubFormField.onDeleteRowExists"  to find out if the subform field has an "on delete row" script.
 
This should be called to execute the "on delete row" deluge script in a subform every time an entry is deleted. This API is applicable while editing a record in a report.
Use  "SubFormField.onDeleteRowExists"  to find out if the subform field has an "on delete row" script.
 
This should be called to execute the "button click" workflow when a button is clicked in a form where data is not stored in Zoho Creator.
Use  "Button.onClickExists"  to find out if the button field has an "button click" script.
 
executeOnUserInput(for:withDelegate:form:)

Parameters

fieldAccessPath The access path of field for which on user input is to be triggered.
delegate A delegate to get the Form object of the on user input actions.
form A Form object in which the actions are to be executed.
 
executeOnUserInput(forRecordID:reportLinkName:and:withDelegate:form:tagId:)

Parameters

recordID The ID of the record that needs to be updated.
reportLinkName The report link name.
fieldAccessPath The access path of field for which on user input is to be triggered.
delegate A delegate to get the Form object of the on user input actions.
form A Form object in which the actions are to be executed.
 
executeOnAddRow(forSubFormField subFormField:FieldProtocol, form:Form, delegate: FormOnUserInputResponseProtocol?, completionHandler:@escaping (Result<WorkFlowChangeSet>) -> Void)

Parameters

subFormField A sub-form field for which the deluge script has to be executed.
form A Form object in which the actions are to be executed.

         delegate

   A delegate to get the Form object of the on        user input actions.
completionHandler The Form object and Error will be returned to the completionHandler.
 
executeOnAddRow(forReportLinkName reportLinkName:String,forSubFormField subFormField:FieldProtocol, form:Form, delegate: FormOnUserInputResponseProtocol?, completionHandler:@escaping (Result<WorkFlowChangeSet>) -> Void)

Parameters

reportLinkName The report link name.
subFormField A sub-form field for which the deluge script has to be executed.
form A Form object in which the actions are to be executed.

         delegate

  A delegate to get the Form object of the on        user input actions.
completionHandler The Form object and Error will be returned to the completionHandler.
 
executeOnAddRow(withRecordID:forReportLinkName:forSubFormField:form:completionHandler:)

Parameters

recordID The ID of the record that needs to be updated.
reportLinkName The report link name.
subFormField A sub-form field for which the deluge script has to be executed.
form A Form object in which the actions are to be executed.
completionHandler The Form object and Error will be returned to the completionHandler.
 
executeOnDeleteRow(forRowNumber rowNumber:Int, inSubFormField subFormField:FieldProtocol, form: Form, delegate: FormOnUserInputResponseProtocol?, completionHandler:@escaping (Result<WorkFlowChangeSet>) -> Void

Parameters

rowNumber Index for which the deluge script should get executed.
subFormField A sub-form field for which the deluge script has to be executed.

         delegate

    A delegate to get the Form object of the on       user input actions.
form A Form object in which the actions are to be executed.
completionHandler The Form object and Error will be returned to the completionHandler.
executeOnDeleteRow(forReportLinkName reportLinkName:String,forRowNumber rowNumber:Int, inSubFormField subFormField:FieldProtocol, form: Form, delegate: FormOnUserInputResponseProtocol?,completionHandler:@escaping (Result<WorkFlowChangeSet>) -> Void)

Parameters

reportLinkName The report link name.
rowNumber Index for which the deluge script should get executed.
subFormField A sub-form field for which the deluge script has to be executed.
form A Form object in which the actions are to be executed.

          delegate

  A delegate to get the Form object of the on        user input actions.
completionHandler The Form object and Error will be returned to the completionHandler.
executeOnDeleteRow(withRecordID recordID:String,forReportLinkName reportLinkName:String,forRowNumber rowNumber:Int, inSubFormField subFormField:FieldProtocol, form: Form, delegate: FormOnUserInputResponseProtocol?, completionHandler:@escaping (Result<WorkFlowChangeSet>) -> Void)

Parameters

recordID The ID of the record that needs to be updated.
reportLinkName The report link name.
rowNumber Index for which the deluge script should get executed.
subFormField A sub-form field for which the deluge script has to be executed.
form A Form object in which the actions are to be executed.

          delegate

   A delegate to get the Form object of the on        user input actions.
completionHandler The Form object and Error will be returned to the completionHandler.
executeOnClick(for:form:completionHandler:)

Parameters

button A button for which the event is triggered.
form A Form object in which the actions are to be executed.
completionHandler The Form object and Error will be returned to the completionHandler.

Related Topics

  1. Adding a record from a report
  2. Adding a record in a form
  3. Adding an entry in a Lookup field
  4. Editing a record in a report
  5. Bulking editing records
  6. Fetch choices
  7. Upload media
  8. Formula calculations
  9. Field actions