Class NSFormSubmissionEntity
Content of a Form submission.
Syntax
Constructors
NSFormSubmissionEntity()
Initializes a new instance of the NSFormSubmissionEntity class.
Declaration
NSFormSubmissionEntity
Methods
GetContactId()
Content of a Form submission.
Declaration
Integer GetContactId()
Returns
Type | Description |
---|---|
Integer | The optional ID of the contact of the person who submitted. |
Examples
NSFormSubmissionEntity thing;
Integer contactId = thing.GetContactId();
GetEmailAddress()
Content of a Form submission.
Declaration
String GetEmailAddress()
Returns
Type | Description |
---|---|
String | The email address of the person who submitted. |
Examples
NSFormSubmissionEntity thing;
String emailAddress = thing.GetEmailAddress();
GetFormId()
Content of a Form submission.
Declaration
Integer GetFormId()
Returns
Type | Description |
---|---|
Integer | The ID of the parent form. |
Examples
NSFormSubmissionEntity thing;
Integer formId = thing.GetFormId();
GetFormSubmissionId()
Content of a Form submission.
Declaration
Integer GetFormSubmissionId()
Returns
Type | Description |
---|---|
Integer | Primary key. |
Examples
NSFormSubmissionEntity thing;
Integer formSubmissionId = thing.GetFormSubmissionId();
GetPersonId()
Content of a Form submission.
Declaration
Integer GetPersonId()
Returns
Type | Description |
---|---|
Integer | The optional ID of the person who submitted. |
Examples
NSFormSubmissionEntity thing;
Integer personId = thing.GetPersonId();
GetProcessingLog()
Content of a Form submission.
Declaration
String GetProcessingLog()
Returns
Type | Description |
---|---|
String | A log of what happened during processing. |
Examples
NSFormSubmissionEntity thing;
String processingLog = thing.GetProcessingLog();
GetResponse()
Content of a Form submission.
Declaration
String GetResponse()
Returns
Type | Description |
---|---|
String | The JSON-formatted response from this form. |
Examples
NSFormSubmissionEntity thing;
String response = thing.GetResponse();
GetResponseShipmentAddrId()
Content of a Form submission.
Declaration
Integer GetResponseShipmentAddrId()
Returns
Type | Description |
---|---|
Integer | The ID of the s_shipment_addr that is the response mail. |
Examples
NSFormSubmissionEntity thing;
Integer responseShipmentAddrId = thing.GetResponseShipmentAddrId();
GetStatus()
Content of a Form submission.
Declaration
Integer GetStatus()
Returns
Type | Description |
---|---|
Integer | The status of this submission. See FormSubmissionStatus |
Examples
NSFormSubmissionEntity thing;
Integer status = thing.GetStatus();
GetWhenSubmitted()
Content of a Form submission.
Declaration
DateTime GetWhenSubmitted()
Returns
Type | Description |
---|---|
DateTime | The time of the submit. |
Examples
NSFormSubmissionEntity thing;
DateTime whenSubmitted = thing.GetWhenSubmitted();
SetContactId(Integer)
Content of a Form submission.
Declaration
Void SetContactId(Integer contactId)
Parameters
Type | Name | Description |
---|---|---|
Integer | contactId | The optional ID of the contact of the person who submitted. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
Integer contactId;
thing.SetContactId(contactId);
SetEmailAddress(String)
Content of a Form submission.
Declaration
Void SetEmailAddress(String emailAddress)
Parameters
Type | Name | Description |
---|---|---|
String | emailAddress | The email address of the person who submitted. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
String emailAddress;
thing.SetEmailAddress(emailAddress);
SetFormId(Integer)
Content of a Form submission.
Declaration
Void SetFormId(Integer formId)
Parameters
Type | Name | Description |
---|---|---|
Integer | formId | The ID of the parent form. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
Integer formId;
thing.SetFormId(formId);
SetFormSubmissionId(Integer)
Content of a Form submission.
Declaration
Void SetFormSubmissionId(Integer formSubmissionId)
Parameters
Type | Name | Description |
---|---|---|
Integer | formSubmissionId | Primary key. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
Integer formSubmissionId;
thing.SetFormSubmissionId(formSubmissionId);
SetPersonId(Integer)
Content of a Form submission.
Declaration
Void SetPersonId(Integer personId)
Parameters
Type | Name | Description |
---|---|---|
Integer | personId | The optional ID of the person who submitted. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
Integer personId;
thing.SetPersonId(personId);
SetProcessingLog(String)
Content of a Form submission.
Declaration
Void SetProcessingLog(String processingLog)
Parameters
Type | Name | Description |
---|---|---|
String | processingLog | A log of what happened during processing. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
String processingLog;
thing.SetProcessingLog(processingLog);
SetResponse(String)
Content of a Form submission.
Declaration
Void SetResponse(String response)
Parameters
Type | Name | Description |
---|---|---|
String | response | The JSON-formatted response from this form. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
String response;
thing.SetResponse(response);
SetResponseShipmentAddrId(Integer)
Content of a Form submission.
Declaration
Void SetResponseShipmentAddrId(Integer responseShipmentAddrId)
Parameters
Type | Name | Description |
---|---|---|
Integer | responseShipmentAddrId | The ID of the s_shipment_addr that is the response mail. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
Integer responseShipmentAddrId;
thing.SetResponseShipmentAddrId(responseShipmentAddrId);
SetStatus(Integer)
Content of a Form submission.
Declaration
Void SetStatus(Integer status)
Parameters
Type | Name | Description |
---|---|---|
Integer | status | What is the status of this submission. See FormSubmissionStatus. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
Integer status;
thing.SetStatus(status);
SetUpdSetWhenSubmitted(DateTime)
Content of a Form submission.
Declaration
Void SetWhenSubmitted(DateTime whenSubmitted)
Parameters
Type | Name | Description |
---|---|---|
DateTime | whenSubmitted | The time of the submit. |
Returns
Type | Description |
---|---|
Void |
Examples
NSFormSubmissionEntity thing;
DateTime whenSubmitted;
thing.SetWhenSubmitted(whenSubmitted);