Class NSFormEntity

Definition and configuration of a Form.

Syntax

Constructors

NSFormEntity()

Initializes a new instance of the NSFormEntity class.

Declaration

NSFormEntity

Methods

GetActive()

Indicates if this form is active or not

Declaration

Bool GetActive()

Returns

Type	Description
Bool

Examples

NSFormEntity thing;
Bool active = thing.GetActive();

GetConfig()

Definition and configuration of a Form.

Declaration

String GetConfig()

Returns

Type	Description
String	The JSON-formatted config of this form.

Examples

NSFormEntity thing;
String config = thing.GetConfig();

GetDescription()

Definition and configuration of a Form.

Declaration

String GetDescription()

Returns

Type	Description
String	Detailed description.

Examples

NSFormEntity thing;
String description = thing.GetDescription();

GetExpires()

Definition and configuration of a Form.

Declaration

DateTime GetExpires()

Returns

Type	Description
DateTime	After this, the form will become inactive.

Examples

NSFormEntity thing;
DateTime expires = thing.GetExpires();

GetFolderId()

Definition and configuration of a Form.

Declaration

Integer GetFolderId()

Returns

Type	Description
Integer	The folder which this form belongs to. -1 indicates that the shipment is on the root.

Examples

NSFormEntity thing;
Integer folderId = thing.GetFolderId();

GetFolderName()

Definition and configuration of a Form.

Declaration

String GetFolderName()

Returns

Type	Description
String	The name of the folder for this form.

Examples

NSFormEntity thing;
String folderName = thing.GetFolderName();

GetFormId()

Definition and configuration of a Form.

Declaration

Integer GetFormId()

Returns

Type	Description
Integer	Primary key.

Examples

NSFormEntity thing;
Integer formId = thing.GetFormId();

GetFormKey()

Definition and configuration of a Form.

Declaration

String GetFormKey()

Returns

Type	Description
String	A short string used as unique ID to access this form.

Examples

NSFormEntity thing;
String formKey = thing.GetFormKey();

GetGroupId()

Definition and configuration of a Form.

Declaration

Integer GetGroupId()

Returns

Type	Description
Integer	The group which this form belongs to.

Examples

NSFormEntity thing;
Integer groupId = thing.GetGroupId();

GetMaxSubmits()

Definition and configuration of a Form.

Declaration

Integer GetMaxSubmits()

Returns

Type	Description
Integer	After this number of submits, the form will become inactive.

Examples

NSFormEntity thing;
Integer maxSubmits = thing.GetMaxSubmits();

GetName()

Definition and configuration of a Form.

Declaration

String GetName()

Returns

Type	Description
String	The name of this form.

Examples

NSFormEntity thing;
String name = thing.GetName();

GetNewTicket()

Definition and configuration of a Form.

Declaration

Bool GetNewTicket()

Returns

Type	Description
Bool	Indicates if this form creates a ticket or not.

Examples

NSFormEntity thing;
Bool newTicket = thing.GetNewTicket();

GetRecaptchaMode()

Definition and configuration of a Form.

Declaration

Integer GetRecaptchaMode()

Returns

Type	Description
Integer	What is the state of the reCAPTCHA configuration? This is a read-only member. See FormsRecaptchaMode

Examples

NSFormEntity thing;
Integer recaptchaMode = thing.GetRecaptchaMode();

GetRecipe()

Definition and configuration of a Form.

Declaration

String GetRecipe()

Returns

Type	Description
String	The JSON-formatted recipe of this form.

Examples

NSFormEntity thing;
String recipe = thing.GetRecipe();

GetRegistered()

Definition and configuration of a Form.

Declaration

DateTime GetRegistered()

Returns

Type	Description
DateTime	Registered when.

Examples

NSFormEntity thing;
DateTime registered = thing.GetRegistered();

GetRegisteredAssociateId()

Definition and configuration of a Form.

Declaration

Integer GetRegisteredAssociateId()

Returns

Type	Description
Integer	Registered by whom.

Examples

NSFormEntity thing;
Integer registeredAssociateId = thing.GetRegisteredAssociateId();

GetResponseShipmentId()

Definition and configuration of a Form.

Declaration

Integer GetResponseShipmentId()

Returns

Type	Description
Integer	The ID of the s_shipment that is used to send the response mails.

Examples

NSFormEntity thing;
Integer responseShipmentId = thing.GetResponseShipmentId();

GetScriptId()

Definition and configuration of a Form.

Declaration

Integer GetScriptId()

Returns

Type	Description
Integer	The CRMScript Macro that will be run when the form is submitted.

Examples

NSFormEntity thing;
Integer scriptId = thing.GetScriptId();

GetType()

Definition and configuration of a Form.

Declaration

Integer GetType()

Returns

Type	Description
Integer	What kind of form is this? Indicates if this is a normal form or a template. See FormType.

Examples

NSFormEntity thing;
Integer type = thing.GetType();

GetUpdated()

Definition and configuration of a Form.

Declaration

DateTime GetUpdated()

Returns

Type	Description
DateTime	Last updated when.

Examples

NSFormEntity thing;
DateTime updated = thing.GetUpdated();

GetUpdatedAssociateId()

Definition and configuration of a Form.

Declaration

Integer GetUpdatedAssociateId()

Returns

Type	Description
Integer	Last updated by whom.

Examples

NSFormEntity thing;
Integer updatedAssociateId = thing.GetUpdatedAssociateId();

GetUpdatedCount()

Definition and configuration of a Form.

Declaration

Integer GetUpdatedCount()

Returns

Type	Description
Integer	Number of updates made to this record.

Examples

NSFormEntity thing;
Integer updatedCount = thing.GetUpdatedCount();

SetActive(Bool)

Definition and configuration of a Form.

Declaration

Void SetActive(Bool active)

Parameters

Type	Name	Description
Bool	active	Indicates if this form is active or not.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Bool active;
thing.SetActive(active);

SetConfig(String)

Definition and configuration of a Form.

Declaration

Void SetConfig(String config)

Parameters

Type	Name	Description
String	config	The JSON-formatted config of this form.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
String config;
thing.SetConfig(config);

SetDescription(String)

Definition and configuration of a Form.

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	Detailed description.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
String description;
thing.SetDescription(description);

SetExpires(DateTime)

Definition and configuration of a Form.

Declaration

Void SetExpires(DateTime expires)

Parameters

Type	Name	Description
DateTime	expires	After this, the form will become inactive.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
DateTime expires;
thing.SetExpires(expires);

SetFolderId(Integer)

Definition and configuration of a Form.

Declaration

Void SetFolderId(Integer 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

Examples

NSFormEntity thing;
Integer folderId;
thing.SetFolderId(folderId);

SetFolderName(String)

Definition and configuration of a Form.

Declaration

Void SetFolderName(String folderName)

Parameters

Type	Name	Description
String	folderName	The name of the folder for this form.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
String folderName;
thing.SetFolderName(folderName);

SetFormId(Integer)

Definition and configuration of a Form.

Declaration

Void SetFormId(Integer formId)

Parameters

Type	Name	Description
Integer	formId	Primary key.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer formId;
thing.SetFormId(formId);

SetFormKey(String)

Definition and configuration of a Form.

Declaration

Void SetFormKey(String formKey)

Parameters

Type	Name	Description
String	formKey	A short string used as unique id to access this form.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
String formKey;
thing.SetFormKey(formKey);

SetGroupId(Integer)

Definition and configuration of a Form.

Declaration

Void SetGroupId(Integer groupId)

Parameters

Type	Name	Description
Integer	groupId	The group which this form belongs to.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer groupId;
thing.SetGroupId(groupId);

SetMaxSubmits(Integer)

Definition and configuration of a Form.

Declaration

Void SetMaxSubmits(Integer maxSubmits)

Parameters

Type	Name	Description
Integer	maxSubmits	After this number of submits, the form will become inactive.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer maxSubmits;
thing.SetMaxSubmits(maxSubmits);

SetName(String)

Definition and configuration of a Form.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The name of this form.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
String name;
thing.SetName(name);

SetNewTicket(Bool)

Definition and configuration of a Form.

Declaration

Void SetNewTicket(Bool newTicket)

Parameters

Type	Name	Description
Bool	newTicket	Indicates if this form creates a ticket or not.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Bool newTicket;
thing.SetNewTicket(newTicket);

SetRecaptchaMode(Integer)

Definition and configuration of a Form.

Declaration

Void SetRecaptchaMode(Integer recaptchaMode)

Parameters

Type	Name	Description
Integer	recaptchaMode	What is the state of the reCAPTCHA configuration? This is a read-only member. See FormsRecaptchaMode.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer recaptchaMode;
thing.SetRecaptchaMode(recaptchaMode);

SetRecipe(String)

Definition and configuration of a Form.

Declaration

Void SetRecipe(String recipe)

Parameters

Type	Name	Description
String	recipe	The JSON-formatted recipe of this form.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
String recipe;
thing.SetRecipe(recipe);

SetRegistered(DateTime)

Definition and configuration of a Form.

Declaration

Void SetRegistered(DateTime registered)

Parameters

Type	Name	Description
DateTime	registered	Registered when.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
DateTime registered;
thing.SetRegistered(registered);

SetRegisteredAssociateId(Integer)

Definition and configuration of a Form.

Declaration

Void SetRegisteredAssociateId(Integer registeredAssociateId)

Parameters

Type	Name	Description
Integer	registeredAssociateId	Registered by whom.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer registeredAssociateId;
thing.SetRegisteredAssociateId(registeredAssociateId);

SetResponseShipmentId(Integer)

Definition and configuration of a Form.

Declaration

Void SetResponseShipmentId(Integer 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

Examples

NSFormEntity thing;
Integer responseShipmentId;
thing.SetResponseShipmentId(responseShipmentId);

SetScriptId(Integer)

Definition and configuration of a Form.

Declaration

Void SetScriptId(Integer scriptId)

Parameters

Type	Name	Description
Integer	scriptId	The CRMScript Macro that will be run when the form is submitted.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer scriptId;
thing.SetScriptId(scriptId);

SetType(Integer)

Definition and configuration of a Form.

Declaration

Void SetType(Integer type)

Parameters

Type	Name	Description
Integer	type	What kind of form is this? Indicates if this is a normal form or a template. See FormType.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer type = 0;
thing.SetType(type);

SetUpdated(DateTime)

Definition and configuration of a Form.

Declaration

Void SetUpdated(DateTime updated)

Parameters

Type	Name	Description
DateTime	updated	Last updated when.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
DateTime updated;
thing.SetUpdated(updated);

SetUpdatedAssociateId(Integer)

Definition and configuration of a Form.

Declaration

Void SetUpdatedAssociateId(Integer updatedAssociateId)

Parameters

Type	Name	Description
Integer	updatedAssociateId	Last updated by whom.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer updatedAssociateId;
thing.SetUpdatedAssociateId(updatedAssociateId);

SetUpdatedCount(Integer)

Definition and configuration of a Form.

Declaration

Void SetUpdatedCount(Integer updatedCount)

Parameters

Type	Name	Description
Integer	updatedCount	Number of updates made to this record.

Returns

Type	Description
Void

Examples

NSFormEntity thing;
Integer updatedCount;
thing.SetUpdatedCount(updatedCount);