NSMarketingAgent - SuperOffice

Agent used for Marketing functions, such as Forms.

Constructors

NSMarketingAgent()

NSMarketingAgent

Agent used for Marketing functions, such as Forms.

Methods

CreateDefaultFormEntity()

Sets default values into a new NSFormEntity.

NSFormEntity CreateDefaultFormEntity()

Returns: CRMScript.NetServer.NSFormEntity

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

Example:

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

CreateDefaultFormSubmissionEntity()

Sets default values into a new NSFormSubmissionEntity.

NSFormSubmissionEntity CreateDefaultFormSubmissionEntity()

Returns: CRMScript.NetServer.NSFormSubmissionEntity

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

Example:

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

CreateDefaultShipmentMessageBlockEntity()

Sets default values into a new NSShipmentMessageBlockEntity.

NSShipmentMessageBlockEntity CreateDefaultShipmentMessageBlockEntity()

Returns: CRMScript.NetServer.NSShipmentMessageBlockEntity

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

Example:

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

CreateDefaultShipmentMessageEntity()

Sets default values into a new NSShipmentMessageEntity.

NSShipmentMessageEntity CreateDefaultShipmentMessageEntity()

Returns: CRMScript.NetServer.NSShipmentMessageEntity

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

Example:

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

DeleteFormEntity(Integer)

Deletes the NSFormEntity

DeleteFormEntity(Integer formEntity)

Returns: CRMScript.Global.Void Example:

NSMarketingAgent agent;
agent.DeleteFormEntity(123);

DeleteFormSubmissionEntity(Integer)

Deletes the NSFormSubmissionEntity

DeleteFormSubmissionEntity(Integer formSubmissionEntity)

Returns: CRMScript.Global.Void Example:

NSMarketingAgent agent;
agent.DeleteFormSubmissionEntity(123);

DeleteShipmentMessageBlockEntity(Integer)

Deletes the NSShipmentMessageBlockEntity

DeleteShipmentMessageBlockEntity(Integer shipmentMessageBlockEntity)

Returns: CRMScript.Global.Void Example:

NSMarketingAgent agent;
agent.DeleteShipmentMessageBlockEntity(123);

DeleteShipmentMessageEntity(Integer)

Deletes the NSShipmentMessageEntity

DeleteShipmentMessageEntity(Integer shipmentMessageEntity)

Returns: CRMScript.Global.Void Example:

NSMarketingAgent agent;
agent.DeleteShipmentMessageEntity(123);

GetFormEntity(Integer)

Gets an NSFormEntity object.

NSFormEntity GetFormEntity(Integer formEntityId)

Returns: CRMScript.NetServer.NSFormEntity Example:

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

GetFormSubmissionEntity(Integer)

Gets an NSFormSubmissionEntity object.

NSFormSubmissionEntity GetFormSubmissionEntity(Integer formSubmissionEntityId)

Returns: CRMScript.NetServer.NSFormSubmissionEntity Example:

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

GetPreviewMailing(Integer)

Gets a shipment message from its shipment address ID

NSPreviewMailing GetPreviewMailing(Integer shipmentAddrId)

Returns: CRMScript.NetServer.NSPreviewMailing Example:

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

GetPreviewMailingHeader(Integer)

Gets a shipment from its shipment ID

NSPreviewMailingHeader GetPreviewMailingHeader(Integer shipmentId)

Returns: CRMScript.NetServer.NSPreviewMailingHeader Example:

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

GetShipmentMessageBlockEntity(Integer)

Gets an NSShipmentMessageBlockEntity object.

NSShipmentMessageBlockEntity GetShipmentMessageBlockEntity(Integer shipmentMessageBlockEntityId)

Returns: CRMScript.NetServer.NSShipmentMessageBlockEntity Example:

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

GetShipmentMessageEntity(Integer)

Gets an NSShipmentMessageEntity object.

NSShipmentMessageEntity GetShipmentMessageEntity(Integer shipmentMessageEntityId)

Returns: CRMScript.NetServer.NSShipmentMessageEntity Example:

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

GetUserBlocks(Integer)

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

NSShipmentMessageBlockEntity[] GetUserBlocks(Integer associateId)

Returns: CRMScript.NetServer.NSShipmentMessageBlockEntity[] Example:

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

NSFormEntity SaveFormEntity(NSFormEntity formEntity)

Returns: CRMScript.NetServer.NSFormEntity Example:

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

NSFormSubmissionEntity SaveFormSubmissionEntity(NSFormSubmissionEntity formSubmissionEntity)

Returns: CRMScript.NetServer.NSFormSubmissionEntity Example:

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

NSShipmentMessageBlockEntity SaveShipmentMessageBlockEntity(NSShipmentMessageBlockEntity shipmentMessageBlockEntity)

Returns: CRMScript.NetServer.NSShipmentMessageBlockEntity Example:

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

NSShipmentMessageEntity SaveShipmentMessageEntity(NSShipmentMessageEntity shipmentMessageEntity)

Returns: CRMScript.NetServer.NSShipmentMessageEntity Example:

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

Bool VerifyGoogleRecaptcha(String token, String optionalSecretKey)

Returns: CRMScript.Global.Bool Example:

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

​Constructors

​NSMarketingAgent()

​Methods

​CreateDefaultFormEntity()

​CreateDefaultFormSubmissionEntity()

​CreateDefaultShipmentMessageBlockEntity()

​CreateDefaultShipmentMessageEntity()

​DeleteFormEntity(Integer)

​DeleteFormSubmissionEntity(Integer)

​DeleteShipmentMessageBlockEntity(Integer)

​DeleteShipmentMessageEntity(Integer)

​GetFormEntity(Integer)

​GetFormSubmissionEntity(Integer)

​GetPreviewMailing(Integer)

​GetPreviewMailingHeader(Integer)

​GetShipmentMessageBlockEntity(Integer)

​GetShipmentMessageEntity(Integer)

​GetUserBlocks(Integer)

​SaveFormEntity(NSFormEntity)

​SaveFormSubmissionEntity(NSFormSubmissionEntity)

​SaveShipmentMessageBlockEntity(NSShipmentMessageBlockEntity)

​SaveShipmentMessageEntity(NSShipmentMessageEntity)

​VerifyGoogleRecaptcha(String,String)

Constructors

NSMarketingAgent()

Methods

CreateDefaultFormEntity()

CreateDefaultFormSubmissionEntity()

CreateDefaultShipmentMessageBlockEntity()

CreateDefaultShipmentMessageEntity()

DeleteFormEntity(Integer)

DeleteFormSubmissionEntity(Integer)

DeleteShipmentMessageBlockEntity(Integer)

DeleteShipmentMessageEntity(Integer)

GetFormEntity(Integer)

GetFormSubmissionEntity(Integer)

GetPreviewMailing(Integer)

GetPreviewMailingHeader(Integer)

GetShipmentMessageBlockEntity(Integer)

GetShipmentMessageEntity(Integer)

GetUserBlocks(Integer)

SaveFormEntity(NSFormEntity)

SaveFormSubmissionEntity(NSFormSubmissionEntity)

SaveShipmentMessageBlockEntity(NSShipmentMessageBlockEntity)

SaveShipmentMessageEntity(NSShipmentMessageEntity)

VerifyGoogleRecaptcha(String,String)