Class NSMarketingAgent

NSMarketingAgent()

Agent used for Marketing functions, such as Forms.

Declaration

NSMarketingAgent

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

CreateDefaultFormEntity()

Sets default values into a new NSFormEntity.

Declaration

NSFormEntity CreateDefaultFormEntity()

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

Returns

CreateDefaultFormSubmissionEntity()

Sets default values into a new NSFormSubmissionEntity.

Declaration

NSFormSubmissionEntity CreateDefaultFormSubmissionEntity()

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

Returns

CreateDefaultShipmentMessageBlockEntity()

Sets default values into a new NSShipmentMessageBlockEntity.

Declaration

NSShipmentMessageBlockEntity CreateDefaultShipmentMessageBlockEntity()

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

Returns

CreateDefaultShipmentMessageEntity()

Sets default values into a new NSShipmentMessageEntity.

Declaration

NSShipmentMessageEntity CreateDefaultShipmentMessageEntity()

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

Returns

DeleteFormEntity(Integer)

Deletes the NSFormEntity

Declaration

DeleteFormEntity(Integer formEntity)

NSMarketingAgent agent;
agent.DeleteFormEntity(123);

Parameters

Returns

DeleteFormSubmissionEntity(Integer)

Deletes the NSFormSubmissionEntity

Declaration

DeleteFormSubmissionEntity(Integer formSubmissionEntity)

NSMarketingAgent agent;
agent.DeleteFormSubmissionEntity(123);

Parameters

Returns

DeleteShipmentMessageBlockEntity(Integer)

Deletes the NSShipmentMessageBlockEntity

Declaration

DeleteShipmentMessageBlockEntity(Integer shipmentMessageBlockEntity)

NSMarketingAgent agent;
agent.DeleteShipmentMessageBlockEntity(123);

Parameters

Returns

DeleteShipmentMessageEntity(Integer)

Deletes the NSShipmentMessageEntity

Declaration

DeleteShipmentMessageEntity(Integer shipmentMessageEntity)

NSMarketingAgent agent;
agent.DeleteShipmentMessageEntity(123);

Parameters

Returns

GetFormEntity(Integer)

Gets an NSFormEntity object.

Declaration

NSFormEntity GetFormEntity(Integer formEntityId)

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

Parameters

Returns

GetFormSubmissionEntity(Integer)

Gets an NSFormSubmissionEntity object.

Declaration

NSFormSubmissionEntity GetFormSubmissionEntity(Integer formSubmissionEntityId)

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

Parameters

Returns

GetPreviewMailing(Integer)

Gets a shipment message from its shipment address ID

Declaration

NSPreviewMailing GetPreviewMailing(Integer shipmentAddrId)

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

Parameters

Returns

GetPreviewMailingHeader(Integer)

Gets a shipment from its shipment ID

Declaration

NSPreviewMailingHeader GetPreviewMailingHeader(Integer shipmentId)

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

Parameters

Returns

GetShipmentMessageBlockEntity(Integer)

Gets an NSShipmentMessageBlockEntity object.

Declaration

NSShipmentMessageBlockEntity GetShipmentMessageBlockEntity(Integer shipmentMessageBlockEntityId)

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

Parameters

Returns

GetShipmentMessageEntity(Integer)

Gets an NSShipmentMessageEntity object.

Declaration

NSShipmentMessageEntity GetShipmentMessageEntity(Integer shipmentMessageEntityId)

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

Parameters

Returns

GetUserBlocks(Integer)

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

Declaration

NSShipmentMessageBlockEntity[] GetUserBlocks(Integer associateId)

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

Parameters

Returns

SaveFormEntity(NSFormEntity)

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

Declaration

NSFormEntity SaveFormEntity(NSFormEntity formEntity)

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

Parameters

Returns

SaveFormSubmissionEntity(NSFormSubmissionEntity)

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

Declaration

NSFormSubmissionEntity SaveFormSubmissionEntity(NSFormSubmissionEntity formSubmissionEntity)

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

Parameters

Returns

SaveShipmentMessageBlockEntity(NSShipmentMessageBlockEntity)

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

Declaration

NSShipmentMessageBlockEntity SaveShipmentMessageBlockEntity(NSShipmentMessageBlockEntity shipmentMessageBlockEntity)

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

Parameters

Returns

SaveShipmentMessageEntity(NSShipmentMessageEntity)

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

Declaration

NSShipmentMessageEntity SaveShipmentMessageEntity(NSShipmentMessageEntity shipmentMessageEntity)

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

Parameters

Returns

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)

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

Parameters

Returns