Class NSShipmentMessageEntity

Syntax

Constructors

NSShipmentMessageEntity()

Initializes a new instance of the NSShipmentMessageEntity class.

Declaration

NSShipmentMessageEntity

Methods

GetAccessKey()

Declaration

String GetAccessKey()

Returns

Type	Description
String	Key used for access verification.

Examples

NSShipmentMessageEntity thing;
String accessKey = thing.GetAccessKey();

GetDescription()

Declaration

String GetDescription()

Returns

Type	Description
String	Describes this message.

Examples

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

GetDesign()

Declaration

String GetDesign()

Returns

Type	Description
String	Will contain the design part of a message. The format will vary based on the type of designer used to create the message.

Examples

NSShipmentMessageEntity thing;
String design = thing.GetDesign();

GetDesigntype()

Declaration

Integer GetDesigntype()

Returns

Type	Description
Integer	The type of the design. See DesignType.

Examples

NSShipmentMessageEntity thing;
Integer designType = thing.GetDesigntype();

GetDocumentMessage()

Declaration

Integer GetDocumentMessage()

Returns

Type	Description
Integer	The SM document used as template for this mailing.

Examples

NSShipmentMessageEntity thing;
Integer documentMessage = thing.GetDocumentMessage();

GetFlags()

Declaration

Integer GetFlags()

Returns

Type	Description
Integer	Identifies if HTML or plain message is included in message. See ShipmentMessageType.

Examples

NSShipmentMessageEntity thing;
Integer flags = thing.GetFlags();

GetFolderId()

Declaration

Integer GetFolderId()

Returns

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

Examples

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

GetHeaderField()

Declaration

String GetHeaderField()

Returns

Type	Description
String	Extra header fields added to mail. Must be formatted correctly.

Examples

NSShipmentMessageEntity thing;
String headerField = thing.GetHeaderField();

GetHtmlMessage()

Declaration

String GetHtmlMessage()

Returns

Type	Description
String	HTML formatted text of this message.

Examples

NSShipmentMessageEntity thing;
String htmlMessage = thing.GetHtmlMessage();

GetInlineImages()

Declaration

Bool GetInlineImages()

Returns

Type	Description
Bool	Should images be included inline?

Examples

NSShipmentMessageEntity thing;
Bool inlineImages = thing.GetInlineImages();

GetLongDescription()

Declaration

String GetLongDescription()

Returns

Type	Description
String	A field for a long description of this template.

Examples

NSShipmentMessageEntity thing;
String longDescription = thing.GetLongDescription();

GetPlainMessage()

Declaration

String GetPlainMessage()

Returns

Type	Description
String	Plain message text of this message.

Examples

NSShipmentMessageEntity thing;
String plainMessage = thing.GetPlainMessage();

GetRegistered()

Declaration

DateTime GetRegistered()

Returns

Type	Description
DateTime	Registered when.

Examples

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

GetRegisteredAssociateId()

Declaration

Integer GetRegisteredAssociateId()

Returns

Type	Description
Integer	Registered by whom.

Examples

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

GetRegisterViews()

Declaration

Bool GetRegisterViews()

Returns

Type	Description
Bool	Register message views?

Examples

NSShipmentMessageEntity thing;
Bool registerViews = thing.GetRegisterViews();

GetShipmentMessageId()

Declaration

Integer GetShipmentMessageId()

Returns

Type	Description
Integer	Primary key.

Examples

NSShipmentMessageEntity thing;
Integer shipmentMessageId = thing.GetShipmentMessageId();

GetSmsMessage()

Declaration

String GetSmsMessage()

Returns

Type	Description
String	SMS version of this message.

Examples

NSShipmentMessageEntity thing;
String smsMessage = thing.GetSmsMessage();

GetSubject()

Declaration

String GetSubject()

Returns

Type	Description
String	The mail subject field of the message.

Examples

NSShipmentMessageEntity thing;
String subject = thing.GetSubject();

GetUpdated()

Declaration

DateTime GetUpdated()

Returns

Type	Description
DateTime	Last updated when.

Examples

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

GetUpdatedAssociateId()

Declaration

Integer GetUpdatedAssociateId()

Returns

Type	Description
Integer	Last updated by whom.

Examples

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

GetUpdatedCount()

Declaration

Integer GetUpdatedCount()

Returns

Type	Description
Integer	Number of updates made to this record.

Examples

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

SetAccessKey(String)

Declaration

Void SetAccessKey(String accessKey)

Parameters

Type	Name	Description
String	accessKey	Key used for access verification.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
String accessKey;
thing.SetAccessKey(accessKey);

SetDescription(String)

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	Describes this message.

Returns

Type	Description
Void

Examples

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

SetDesign(String)

Declaration

Void SetDesign(String design)

Parameters

Type	Name	Description
String	design	Will contain the design part of a message. The format will vary based on the type of designer used to create the message.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
String design;
thing.SetDesign(design);

SetDesigntype(Integer)

Declaration

Void SetDesigntype(Integer designType)

Parameters

Type	Name	Description
Integer	designType	The type of the design. See DesignType.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
Integer designType;
thing.SetDesigntype(designType);

SetDocumentMessage(Integer)

Declaration

Void SetDocumentMessage(Integer documentMessage)

Parameters

Type	Name	Description
Integer	documentMessage	The SM document used as template for this mailing.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
Integer documentMessage;
thing.SetDocumentMessage(documentMessage);

SetFlags(Integer)

Declaration

Void SetFlags(Integer flags)

Parameters

Type	Name	Description
Integer	flags	Identifies if HTML or plain message is included in message. See ShipmentMessageType.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
Integer flags;
thing.SetFlags(flags);

SetFolderId(Integer)

Declaration

Void SetFolderId(Integer folderId)

Parameters

Type	Name	Description
Integer	folderId	The folder which this message belongs to. -1 indicates that the message is on the root.

Returns

Type	Description
Void

Examples

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

SetHeaderField(String)

Declaration

Void SetHeaderField(String headerField)

Parameters

Type	Name	Description
String	headerField	Extra header fields added to mail. Must be formatted correctly.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
String headerField;
thing.SetHeaderField(headerField);

SetHtmlMessage(String)

Declaration

Void SetHtmlMessage(String htmlMessage)

Parameters

Type	Name	Description
String	htmlMessage	HTML formatted text of this message.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
String htmlMessage;
thing.SetHtmlMessage(htmlMessage);

SetInlineImages(Bool)

Declaration

Void SetInlineImages(Bool inlineImages)

Parameters

Type	Name	Description
Bool	inlineImages	Should images be included inline?

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
Bool inlineImages;
thing.SetInlineImages(inlineImages);

SetLongDescription(String)

Declaration

Void SetLongDescription(String longDescription)

Parameters

Type	Name	Description
String	longDescription	A field for a long description of this template.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
String longDescription;
thing.SetLongDescription(longDescription);

SetPlainMessage(String)

Declaration

Void SetPlainMessage(String plainMessage)

Parameters

Type	Name	Description
String	plainMessage	Plain message text of this message.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
String plainMessage;
thing.SetPlainMessage(plainMessage);

SetRegistered(DateTime)

Declaration

Void SetRegistered(DateTime registered)

Parameters

Type	Name	Description
DateTime	registered	Registered when.

Returns

Type	Description
Void

Examples

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

SetRegisteredAssociateId(Integer)

Declaration

Void SetRegisteredAssociateId(Integer registeredAssociateId)

Parameters

Type	Name	Description
Integer	registeredAssociateId	Registered by whom.

Returns

Type	Description
Void

Examples

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

SetRegisterViews(Bool)

Declaration

Void SetRegisterViews(Bool registerViews)

Parameters

Type	Name	Description
Bool	registerViews	Register message views?

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
Bool registerViews;
thing.SetRegisterViews(registerViews);

SetShipmentMessageId(Integer)

Declaration

Void SetShipmentMessageId(Integer shipmentMessageId)

Parameters

Type	Name	Description
Integer	shipmentMessageId	Primary key.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
Integer shipmentMessageId;
thing.SetShipmentMessageId(shipmentMessageId);

SetSmsMessage(String)

Declaration

Void SetSmsMessage(String smsMessage)

Parameters

Type	Name	Description
String	smsMessage	SMS version of this message.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
String smsMessage;
thing.SetSmsMessage(smsMessage);

SetSubject(String)

Declaration

Void SetSubject(String subject)

Parameters

Type	Name	Description
String	subject	The mail subject field of the message.

Returns

Type	Description
Void

Examples

NSShipmentMessageEntity thing;
String subject;
thing.SetSubject(subject);

SetUpdated(DateTime)

Declaration

Void SetUpdated(DateTime updated)

Parameters

Type	Name	Description
DateTime	updated	Last updated when.

Returns

Type	Description
Void

Examples

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

SetUpdatedAssociateId(Integer)

Declaration

Void SetUpdatedAssociateId(Integer updatedAssociateId)

Parameters

Type	Name	Description
Integer	updatedAssociateId	Last updated by whom.

Returns

Type	Description
Void

Examples

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

SetUpdatedCount(Integer)

Declaration

Void SetUpdatedCount(Integer updatedCount)

Parameters

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

Returns

Type	Description
Void

Examples

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