Class NSMarketingAgent

Agent used for Marketing functions, such as Forms.

Syntax

Examples

NSMarketingAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSMarketingAgent()

Agent used for Marketing functions, such as Forms.

Declaration

NSMarketingAgent

Examples

NSMarketingAgent agent;
agent.callMethod(arg1, arg2);

Methods

CreateDefaultFormEntity()

Sets default values into a new NSFormEntity.

Declaration

NSFormEntity CreateDefaultFormEntity()

Returns

Type	Description
NSFormEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSMarketingAgent agent;
NSFormEntity thing = agent.CreateDefaultFormEntity();
thing = agent.SaveFormEntity(thing);

CreateDefaultFormSubmissionEntity()

Sets default values into a new NSFormSubmissionEntity.

Declaration

NSFormSubmissionEntity CreateDefaultFormSubmissionEntity()

Returns

Type	Description
NSFormSubmissionEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSMarketingAgent agent;
NSFormSubmissionEntity thing = agent.CreateDefaultFormSubmissionEntity();
thing = agent.SaveFormSubmissionEntity(thing);

CreateDefaultShipmentMessageBlockEntity()

Sets default values into a new NSShipmentMessageBlockEntity.

Declaration

NSShipmentMessageBlockEntity CreateDefaultShipmentMessageBlockEntity()

Returns

Type	Description
NSShipmentMessageBlockEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSMarketingAgent agent;
NSShipmentMessageBlockEntity thing = agent.CreateDefaultShipmentMessageBlockEntity();
thing = agent.SaveShipmentMessageBlockEntity(thing);

CreateDefaultShipmentMessageEntity()

Sets default values into a new NSShipmentMessageEntity.

Declaration

NSShipmentMessageEntity CreateDefaultShipmentMessageEntity()

Returns

Type	Description
NSShipmentMessageEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSMarketingAgent agent;
NSShipmentMessageEntity thing = agent.CreateDefaultShipmentMessageEntity();
thing = agent.SaveShipmentMessageEntity(thing);

DeleteFormEntity(Integer)

Deletes the NSFormEntity

Declaration

DeleteFormEntity(Integer formEntity)

Parameters

Type	Name	Description
Integer	formEntity

Returns

Type	Description
Void

Examples

NSMarketingAgent agent;
agent.DeleteFormEntity(123);

DeleteFormSubmissionEntity(Integer)

Deletes the NSFormSubmissionEntity

Declaration

DeleteFormSubmissionEntity(Integer formSubmissionEntity)

Parameters

Type	Name	Description
Integer	formSubmissionEntity

Returns

Type	Description
Void

Examples

NSMarketingAgent agent;
agent.DeleteFormSubmissionEntity(123);

DeleteShipmentMessageBlockEntity(Integer)

Deletes the NSShipmentMessageBlockEntity

Declaration

DeleteShipmentMessageBlockEntity(Integer shipmentMessageBlockEntity)

Parameters

Type	Name	Description
Integer	shipmentMessageBlockEntity

Returns

Type	Description
Void

Examples

NSMarketingAgent agent;
agent.DeleteShipmentMessageBlockEntity(123);

DeleteShipmentMessageEntity(Integer)

Deletes the NSShipmentMessageEntity

Declaration

DeleteShipmentMessageEntity(Integer shipmentMessageEntity)

Parameters

Type	Name	Description
Integer	shipmentMessageEntity

Returns

Type	Description
Void

Examples

NSMarketingAgent agent;
agent.DeleteShipmentMessageEntity(123);

GetFormEntity(Integer)

Gets an NSFormEntity object.

Declaration

NSFormEntity GetFormEntity(Integer formEntityId)

Parameters

Type	Name	Description
Integer	formEntityId

Returns

Type	Description
NSFormEntity

Examples

NSMarketingAgent agent;
NSFormEntity thing = agent.GetFormEntity(123);

GetFormSubmissionEntity(Integer)

Gets an NSFormSubmissionEntity object.

Declaration

NSFormSubmissionEntity GetFormSubmissionEntity(Integer formSubmissionEntityId)

Parameters

Type	Name	Description
Integer	formSubmissionEntityId

Returns

Type	Description
NSFormSubmissionEntity

Examples

NSMarketingAgent agent;
NSFormSubmissionEntity thing = agent.GetFormSubmissionEntity(123);

GetPreviewMailing(Integer)

Gets a shipment message from its shipment address ID

Declaration

NSPreviewMailing GetPreviewMailing(Integer shipmentAddrId)

Parameters

Type	Name	Description
Integer	shipmentAddrId

Returns

Type	Description
NSPreviewMailing

Examples

NSMarketingAgent agent;
Integer shipmentAddrId;
NSPreviewMailing res = agent.GetPreviewMailing(shipmentAddrId);

GetPreviewMailingHeader(Integer)

Gets a shipment from its shipment ID

Declaration

NSPreviewMailingHeader GetPreviewMailingHeader(Integer shipmentId)

Parameters

Type	Name	Description
Integer	shipmentId

Returns

Type	Description
NSPreviewMailingHeader

Examples

NSMarketingAgent agent;
Integer shipmentId;
NSPreviewMailingHeader res = agent.GetPreviewMailingHeader(shipmentId);

GetShipmentMessageBlockEntity(Integer)

Gets an NSShipmentMessageBlockEntity object.

Declaration

NSShipmentMessageBlockEntity GetShipmentMessageBlockEntity(Integer shipmentMessageBlockEntityId)

Parameters

Type	Name	Description
Integer	shipmentMessageBlockEntityId

Returns

Type	Description
NSShipmentMessageBlockEntity

Examples

NSMarketingAgent agent;
NSShipmentMessageBlockEntity thing = agent.GetShipmentMessageBlockEntity(123);

GetShipmentMessageEntity(Integer)

Gets an NSShipmentMessageEntity object.

Declaration

NSShipmentMessageEntity GetShipmentMessageEntity(Integer shipmentMessageEntityId)

Parameters

Type	Name	Description
Integer	shipmentMessageEntityId

Returns

Type	Description
NSShipmentMessageEntity

Examples

NSMarketingAgent agent;
NSShipmentMessageEntity thing = agent.GetShipmentMessageEntity(123);

GetUserBlocks(Integer)

Gets the saved user blocks to be used in a shipment/mailing message

Declaration

NSShipmentMessageBlockEntity[] GetUserBlocks(Integer associateId)

Parameters

Type	Name	Description
Integer	associateId

Returns

Type	Description
NSShipmentMessageBlockEntity[]

Examples

NSMarketingAgent agent;
Integer associateId;
NSShipmentMessageBlockEntity[] res = agent.GetUserBlocks(associateId);

SaveFormEntity(NSFormEntity)

Updates the existing NSFormEntity or creates a new NSFormEntity if the id parameter is 0

Declaration

NSFormEntity SaveFormEntity(NSFormEntity formEntity)

Parameters

Type	Name	Description
NSFormEntity	formEntity	The NSFormEntity to save.

Returns

Type	Description
NSFormEntity

Examples

NSMarketing  agent;
NSFormEntity thing = agent.CreateDefaultFormEntity();
thing = agent.SaveFormEntity(thing);

SaveFormSubmissionEntity(NSFormSubmissionEntity)

Updates the existing NSFormSubmissionEntity or creates a new NSFormSubmissionEntity if the id parameter is 0

Declaration

NSFormSubmissionEntity SaveFormSubmissionEntity(NSFormSubmissionEntity formSubmissionEntity)

Parameters

Type	Name	Description
NSFormSubmissionEntity	formSubmissionEntity	The NSFormSubmissionEntity to save.

Returns

Type	Description
NSFormSubmissionEntity

Examples

NSMarketing  agent;
NSFormSubmissionEntity thing = agent.CreateDefaultFormSubmissionEntity();
thing = agent.SaveFormSubmissionEntity(thing);

SaveShipmentMessageBlockEntity(NSShipmentMessageBlockEntity)

Updates the existing NSShipmentMessageBlockEntity or creates a new NSShipmentMessageBlockEntity if the id parameter is 0

Declaration

NSShipmentMessageBlockEntity SaveShipmentMessageBlockEntity(NSShipmentMessageBlockEntity shipmentMessageBlockEntity)

Parameters

Type	Name	Description
NSShipmentMessageBlockEntity	shipmentMessageBlockEntity	The NSShipmentMessageBlockEntity to save.

Returns

Type	Description
NSShipmentMessageBlockEntity

Examples

NSMarketing  agent;
NSShipmentMessageBlockEntity thing = agent.CreateDefaultShipmentMessageBlockEntity();
thing = agent.SaveShipmentMessageBlockEntity(thing);

SaveShipmentMessageEntity(NSShipmentMessageEntity)

Updates the existing NSShipmentMessageEntity or creates a new NSShipmentMessageEntity if the id parameter is 0

Declaration

NSShipmentMessageEntity SaveShipmentMessageEntity(NSShipmentMessageEntity shipmentMessageEntity)

Parameters

Type	Name	Description
NSShipmentMessageEntity	shipmentMessageEntity	The NSShipmentMessageEntity to save.

Returns

Type	Description
NSShipmentMessageEntity

Examples

NSMarketing  agent;
NSShipmentMessageEntity thing = agent.CreateDefaultShipmentMessageEntity();
thing = agent.SaveShipmentMessageEntity(thing);

VerifyGoogleRecaptcha(String,String)

Tries to verify a Google recaptcha token. The token is gained from the recaptcha frontend component

Declaration

Bool VerifyGoogleRecaptcha(String token, String optionalSecretKey)

Parameters

Type	Name	Description
String	token
String	optionalSecretKey

Returns

Type	Description
Bool

Examples

NSMarketingAgent agent;
String token;
String optionalSecretKey;
Bool res = agent.VerifyGoogleRecaptcha(token, optionalSecretKey);