Class NSFormEntity
Definition and configuration of a Form.
Constructors
NSFormEntity()
Initializes a new instance of the NSFormEntity class.
Declaration
NSFormEntityMethods
GetActive()
Indicates if this form is active or not
Declaration
Bool GetActive()Examples
NSFormEntity thing;
Bool active = thing.GetActive();Returns
| Type | Description |
| Bool |
GetConfig()
Declaration
String GetConfig()Examples
NSFormEntity thing;
String config = thing.GetConfig();Returns
| Type | Description |
| String | The JSON-formatted config of this form. |
GetDescription()
Declaration
String GetDescription()Examples
NSFormEntity thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | Detailed description. |
GetExpires()
Declaration
DateTime GetExpires()Examples
NSFormEntity thing;
DateTime expires = thing.GetExpires();Returns
| Type | Description |
| DateTime | After this, the form will become inactive. |
GetFolderId()
Declaration
Integer GetFolderId()Examples
NSFormEntity thing;
Integer folderId = thing.GetFolderId();Returns
| Type | Description |
| Integer | The folder which this form belongs to. -1 indicates that the shipment is on the root. |
GetFolderName()
Declaration
String GetFolderName()Examples
NSFormEntity thing;
String folderName = thing.GetFolderName();Returns
| Type | Description |
| String | The name of the folder for this form. |
GetFormId()
Declaration
Integer GetFormId()Examples
NSFormEntity thing;
Integer formId = thing.GetFormId();Returns
| Type | Description |
| Integer | Primary key. |
GetFormKey()
Declaration
String GetFormKey()Examples
NSFormEntity thing;
String formKey = thing.GetFormKey();Returns
| Type | Description |
| String | A short string used as unique ID to access this form. |
GetGroupId()
Declaration
Integer GetGroupId()Examples
NSFormEntity thing;
Integer groupId = thing.GetGroupId();Returns
| Type | Description |
| Integer | The group which this form belongs to. |
GetMaxSubmits()
Declaration
Integer GetMaxSubmits()Examples
NSFormEntity thing;
Integer maxSubmits = thing.GetMaxSubmits();Returns
| Type | Description |
| Integer | After this number of submits, the form will become inactive. |
GetName()
Declaration
String GetName()Examples
NSFormEntity thing;
String name = thing.GetName();Returns
| Type | Description |
| String | The name of this form. |
GetNewTicket()
Declaration
Bool GetNewTicket()Examples
NSFormEntity thing;
Bool newTicket = thing.GetNewTicket();Returns
| Type | Description |
| Bool | Indicates if this form creates a ticket or not. |
GetRecaptchaMode()
Declaration
Integer GetRecaptchaMode()Examples
NSFormEntity thing;
Integer recaptchaMode = thing.GetRecaptchaMode();Returns
| Type | Description |
| Integer | What is the state of the reCAPTCHA configuration? This is a read-only member. See <xref href="CRMScript.NetServer.FormsRecaptchaMode" data-throw-if-not-resolved="false"></xref> |
GetRecipe()
Declaration
String GetRecipe()Examples
NSFormEntity thing;
String recipe = thing.GetRecipe();Returns
| Type | Description |
| String | The JSON-formatted recipe of this form. |
GetRegistered()
Declaration
DateTime GetRegistered()Examples
NSFormEntity thing;
DateTime registered = thing.GetRegistered();Returns
| Type | Description |
| DateTime | Registered when. |
GetRegisteredAssociateId()
Declaration
Integer GetRegisteredAssociateId()Examples
NSFormEntity thing;
Integer registeredAssociateId = thing.GetRegisteredAssociateId();Returns
| Type | Description |
| Integer | Registered by whom. |
GetResponseShipmentId()
Declaration
Integer GetResponseShipmentId()Examples
NSFormEntity thing;
Integer responseShipmentId = thing.GetResponseShipmentId();Returns
| Type | Description |
| Integer | The ID of the s_shipment that is used to send the response mails. |
GetScriptId()
Declaration
Integer GetScriptId()Examples
NSFormEntity thing;
Integer scriptId = thing.GetScriptId();Returns
| Type | Description |
| Integer | The CRMScript Macro that will be run when the form is submitted. |
GetType()
Declaration
Integer GetType()Examples
NSFormEntity thing;
Integer type = thing.GetType();Returns
| Type | Description |
| Integer | What kind of form is this? Indicates if this is a normal form or a template. See <xref href="CRMScript.NetServer.FormType" data-throw-if-not-resolved="false"></xref>. |
GetUpdated()
Declaration
DateTime GetUpdated()Examples
NSFormEntity thing;
DateTime updated = thing.GetUpdated();Returns
| Type | Description |
| DateTime | Last updated when. |
GetUpdatedAssociateId()
Declaration
Integer GetUpdatedAssociateId()Examples
NSFormEntity thing;
Integer updatedAssociateId = thing.GetUpdatedAssociateId();Returns
| Type | Description |
| Integer | Last updated by whom. |
GetUpdatedCount()
Declaration
Integer GetUpdatedCount()Examples
NSFormEntity thing;
Integer updatedCount = thing.GetUpdatedCount();Returns
| Type | Description |
| Integer | Number of updates made to this record. |
SetActive(Bool)
Declaration
Void SetActive(Bool active)Examples
NSFormEntity thing;
Bool active;
thing.SetActive(active);Parameters
| Type | Name | Description |
| Bool | active | Indicates if this form is active or not. |
Returns
| Type | Description |
| Void |
SetConfig(String)
Declaration
Void SetConfig(String config)Examples
NSFormEntity thing;
String config;
thing.SetConfig(config);Parameters
| Type | Name | Description |
| String | config | The JSON-formatted config of this form. |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSFormEntity thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | Detailed description. |
Returns
| Type | Description |
| Void |
SetExpires(DateTime)
Declaration
Void SetExpires(DateTime expires)Examples
NSFormEntity thing;
DateTime expires;
thing.SetExpires(expires);Parameters
| Type | Name | Description |
| DateTime | expires | After this, the form will become inactive. |
Returns
| Type | Description |
| Void |
SetFolderId(Integer)
Declaration
Void SetFolderId(Integer folderId)Examples
NSFormEntity thing;
Integer folderId;
thing.SetFolderId(folderId);Parameters
| Type | Name | Description |
| Integer | folderId | The folder which this form belongs to. -1 indicates that the shipment is on the root. |
Returns
| Type | Description |
| Void |
SetFolderName(String)
Declaration
Void SetFolderName(String folderName)Examples
NSFormEntity thing;
String folderName;
thing.SetFolderName(folderName);Parameters
| Type | Name | Description |
| String | folderName | The name of the folder for this form. |
Returns
| Type | Description |
| Void |
SetFormId(Integer)
Declaration
Void SetFormId(Integer formId)Examples
NSFormEntity thing;
Integer formId;
thing.SetFormId(formId);Parameters
| Type | Name | Description |
| Integer | formId | Primary key. |
Returns
| Type | Description |
| Void |
SetFormKey(String)
Declaration
Void SetFormKey(String formKey)Examples
NSFormEntity thing;
String formKey;
thing.SetFormKey(formKey);Parameters
| Type | Name | Description |
| String | formKey | A short string used as unique id to access this form. |
Returns
| Type | Description |
| Void |
SetGroupId(Integer)
Declaration
Void SetGroupId(Integer groupId)Examples
NSFormEntity thing;
Integer groupId;
thing.SetGroupId(groupId);Parameters
| Type | Name | Description |
| Integer | groupId | The group which this form belongs to. |
Returns
| Type | Description |
| Void |
SetMaxSubmits(Integer)
Declaration
Void SetMaxSubmits(Integer maxSubmits)Examples
NSFormEntity thing;
Integer maxSubmits;
thing.SetMaxSubmits(maxSubmits);Parameters
| Type | Name | Description |
| Integer | maxSubmits | After this number of submits, the form will become inactive. |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSFormEntity thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | The name of this form. |
Returns
| Type | Description |
| Void |
SetNewTicket(Bool)
Declaration
Void SetNewTicket(Bool newTicket)Examples
NSFormEntity thing;
Bool newTicket;
thing.SetNewTicket(newTicket);Parameters
| Type | Name | Description |
| Bool | newTicket | Indicates if this form creates a ticket or not. |
Returns
| Type | Description |
| Void |
SetRecaptchaMode(Integer)
Declaration
Void SetRecaptchaMode(Integer recaptchaMode)Examples
NSFormEntity thing;
Integer recaptchaMode;
thing.SetRecaptchaMode(recaptchaMode);Parameters
| Type | Name | Description |
| Integer | recaptchaMode | What is the state of the reCAPTCHA configuration? This is a read-only member. See <xref href="CRMScript.NetServer.FormsRecaptchaMode" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetRecipe(String)
Declaration
Void SetRecipe(String recipe)Examples
NSFormEntity thing;
String recipe;
thing.SetRecipe(recipe);Parameters
| Type | Name | Description |
| String | recipe | The JSON-formatted recipe of this form. |
Returns
| Type | Description |
| Void |
SetRegistered(DateTime)
Declaration
Void SetRegistered(DateTime registered)Examples
NSFormEntity thing;
DateTime registered;
thing.SetRegistered(registered);Parameters
| Type | Name | Description |
| DateTime | registered | Registered when. |
Returns
| Type | Description |
| Void |
SetRegisteredAssociateId(Integer)
Declaration
Void SetRegisteredAssociateId(Integer registeredAssociateId)Examples
NSFormEntity thing;
Integer registeredAssociateId;
thing.SetRegisteredAssociateId(registeredAssociateId);Parameters
| Type | Name | Description |
| Integer | registeredAssociateId | Registered by whom. |
Returns
| Type | Description |
| Void |
SetResponseShipmentId(Integer)
Declaration
Void SetResponseShipmentId(Integer responseShipmentId)Examples
NSFormEntity thing;
Integer responseShipmentId;
thing.SetResponseShipmentId(responseShipmentId);Parameters
| Type | Name | Description |
| Integer | responseShipmentId | The ID of the s_shipment that is used to send the response mails. |
Returns
| Type | Description |
| Void |
SetScriptId(Integer)
Declaration
Void SetScriptId(Integer scriptId)Examples
NSFormEntity thing;
Integer scriptId;
thing.SetScriptId(scriptId);Parameters
| Type | Name | Description |
| Integer | scriptId | The CRMScript Macro that will be run when the form is submitted. |
Returns
| Type | Description |
| Void |
SetType(Integer)
Declaration
Void SetType(Integer type)Examples
NSFormEntity thing;
Integer type = 0;
thing.SetType(type);Parameters
| Type | Name | Description |
| Integer | type | What kind of form is this? Indicates if this is a normal form or a template. See <xref href="CRMScript.NetServer.FormType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetUpdated(DateTime)
Declaration
Void SetUpdated(DateTime updated)Examples
NSFormEntity thing;
DateTime updated;
thing.SetUpdated(updated);Parameters
| Type | Name | Description |
| DateTime | updated | Last updated when. |
Returns
| Type | Description |
| Void |
SetUpdatedAssociateId(Integer)
Declaration
Void SetUpdatedAssociateId(Integer updatedAssociateId)Examples
NSFormEntity thing;
Integer updatedAssociateId;
thing.SetUpdatedAssociateId(updatedAssociateId);Parameters
| Type | Name | Description |
| Integer | updatedAssociateId | Last updated by whom. |
Returns
| Type | Description |
| Void |