Class NSShipmentMessageEntity
Constructors
NSShipmentMessageEntity()
Initializes a new instance of the NSShipmentMessageEntity class.
Declaration
NSShipmentMessageEntityMethods
GetAccessKey()
Declaration
String GetAccessKey()Examples
NSShipmentMessageEntity thing;
String accessKey = thing.GetAccessKey();Returns
| Type | Description |
| String | Key used for access verification. |
GetDescription()
Declaration
String GetDescription()Examples
NSShipmentMessageEntity thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | Describes this message. |
GetDesign()
Declaration
String GetDesign()Examples
NSShipmentMessageEntity thing;
String design = thing.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. |
GetDesigntype()
Declaration
Integer GetDesigntype()Examples
NSShipmentMessageEntity thing;
Integer designType = thing.GetDesigntype();Returns
| Type | Description |
| Integer | The type of the design. See <xref href="CRMScript.NetServer.DesignType" data-throw-if-not-resolved="false"></xref>. |
GetDocumentMessage()
Declaration
Integer GetDocumentMessage()Examples
NSShipmentMessageEntity thing;
Integer documentMessage = thing.GetDocumentMessage();Returns
| Type | Description |
| Integer | The SM document used as template for this mailing. |
GetFlags()
Declaration
Integer GetFlags()Examples
NSShipmentMessageEntity thing;
Integer flags = thing.GetFlags();Returns
| Type | Description |
| Integer | Identifies if HTML or plain message is included in message. See <xref href="CRMScript.NetServer.ShipmentMessageType" data-throw-if-not-resolved="false"></xref>. |
GetFolderId()
Declaration
Integer GetFolderId()Examples
NSShipmentMessageEntity thing;
Integer folderId = thing.GetFolderId();Returns
| Type | Description |
| Integer | The folder which this message belongs to. -1 indicates that the message is on the root. |
GetHeaderField()
Declaration
String GetHeaderField()Examples
NSShipmentMessageEntity thing;
String headerField = thing.GetHeaderField();Returns
| Type | Description |
| String | Extra header fields added to mail. Must be formatted correctly. |
GetHtmlMessage()
Declaration
String GetHtmlMessage()Examples
NSShipmentMessageEntity thing;
String htmlMessage = thing.GetHtmlMessage();Returns
| Type | Description |
| String | HTML formatted text of this message. |
GetInlineImages()
Declaration
Bool GetInlineImages()Examples
NSShipmentMessageEntity thing;
Bool inlineImages = thing.GetInlineImages();Returns
| Type | Description |
| Bool | Should images be included inline? |
GetLongDescription()
Declaration
String GetLongDescription()Examples
NSShipmentMessageEntity thing;
String longDescription = thing.GetLongDescription();Returns
| Type | Description |
| String | A field for a long description of this template. |
GetPlainMessage()
Declaration
String GetPlainMessage()Examples
NSShipmentMessageEntity thing;
String plainMessage = thing.GetPlainMessage();Returns
| Type | Description |
| String | Plain message text of this message. |
GetRegistered()
Declaration
DateTime GetRegistered()Examples
NSShipmentMessageEntity thing;
DateTime registered = thing.GetRegistered();Returns
| Type | Description |
| DateTime | Registered when. |
GetRegisteredAssociateId()
Declaration
Integer GetRegisteredAssociateId()Examples
NSShipmentMessageEntity thing;
Integer registeredAssociateId = thing.GetRegisteredAssociateId();Returns
| Type | Description |
| Integer | Registered by whom. |
GetRegisterViews()
Declaration
Bool GetRegisterViews()Examples
NSShipmentMessageEntity thing;
Bool registerViews = thing.GetRegisterViews();Returns
| Type | Description |
| Bool | Register message views? |
GetShipmentMessageId()
Declaration
Integer GetShipmentMessageId()Examples
NSShipmentMessageEntity thing;
Integer shipmentMessageId = thing.GetShipmentMessageId();Returns
| Type | Description |
| Integer | Primary key. |
GetSmsMessage()
Declaration
String GetSmsMessage()Examples
NSShipmentMessageEntity thing;
String smsMessage = thing.GetSmsMessage();Returns
| Type | Description |
| String | SMS version of this message. |
GetSubject()
Declaration
String GetSubject()Examples
NSShipmentMessageEntity thing;
String subject = thing.GetSubject();Returns
| Type | Description |
| String | The mail subject field of the message. |
GetUpdated()
Declaration
DateTime GetUpdated()Examples
NSShipmentMessageEntity thing;
DateTime updated = thing.GetUpdated();Returns
| Type | Description |
| DateTime | Last updated when. |
GetUpdatedAssociateId()
Declaration
Integer GetUpdatedAssociateId()Examples
NSShipmentMessageEntity thing;
Integer updatedAssociateId = thing.GetUpdatedAssociateId();Returns
| Type | Description |
| Integer | Last updated by whom. |
GetUpdatedCount()
Declaration
Integer GetUpdatedCount()Examples
NSShipmentMessageEntity thing;
Integer updatedCount = thing.GetUpdatedCount();Returns
| Type | Description |
| Integer | Number of updates made to this record. |
SetAccessKey(String)
Declaration
Void SetAccessKey(String accessKey)Examples
NSShipmentMessageEntity thing;
String accessKey;
thing.SetAccessKey(accessKey);Parameters
| Type | Name | Description |
| String | accessKey | Key used for access verification. |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSShipmentMessageEntity thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | Describes this message. |
Returns
| Type | Description |
| Void |
SetDesign(String)
Declaration
Void SetDesign(String design)Examples
NSShipmentMessageEntity thing;
String design;
thing.SetDesign(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 |
SetDesigntype(Integer)
Declaration
Void SetDesigntype(Integer designType)Examples
NSShipmentMessageEntity thing;
Integer designType;
thing.SetDesigntype(designType);Parameters
| Type | Name | Description |
| Integer | designType | The type of the design. See <xref href="CRMScript.NetServer.DesignType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetDocumentMessage(Integer)
Declaration
Void SetDocumentMessage(Integer documentMessage)Examples
NSShipmentMessageEntity thing;
Integer documentMessage;
thing.SetDocumentMessage(documentMessage);Parameters
| Type | Name | Description |
| Integer | documentMessage | The SM document used as template for this mailing. |
Returns
| Type | Description |
| Void |
SetFlags(Integer)
Declaration
Void SetFlags(Integer flags)Examples
NSShipmentMessageEntity thing;
Integer flags;
thing.SetFlags(flags);Parameters
| Type | Name | Description |
| Integer | flags | Identifies if HTML or plain message is included in message. See <xref href="CRMScript.NetServer.ShipmentMessageType" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetFolderId(Integer)
Declaration
Void SetFolderId(Integer folderId)Examples
NSShipmentMessageEntity thing;
Integer folderId;
thing.SetFolderId(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 |
SetHeaderField(String)
Declaration
Void SetHeaderField(String headerField)Examples
NSShipmentMessageEntity thing;
String headerField;
thing.SetHeaderField(headerField);Parameters
| Type | Name | Description |
| String | headerField | Extra header fields added to mail. Must be formatted correctly. |
Returns
| Type | Description |
| Void |
SetHtmlMessage(String)
Declaration
Void SetHtmlMessage(String htmlMessage)Examples
NSShipmentMessageEntity thing;
String htmlMessage;
thing.SetHtmlMessage(htmlMessage);Parameters
| Type | Name | Description |
| String | htmlMessage | HTML formatted text of this message. |
Returns
| Type | Description |
| Void |
SetInlineImages(Bool)
Declaration
Void SetInlineImages(Bool inlineImages)Examples
NSShipmentMessageEntity thing;
Bool inlineImages;
thing.SetInlineImages(inlineImages);Parameters
| Type | Name | Description |
| Bool | inlineImages | Should images be included inline? |
Returns
| Type | Description |
| Void |
SetLongDescription(String)
Declaration
Void SetLongDescription(String longDescription)Examples
NSShipmentMessageEntity thing;
String longDescription;
thing.SetLongDescription(longDescription);Parameters
| Type | Name | Description |
| String | longDescription | A field for a long description of this template. |
Returns
| Type | Description |
| Void |
SetPlainMessage(String)
Declaration
Void SetPlainMessage(String plainMessage)Examples
NSShipmentMessageEntity thing;
String plainMessage;
thing.SetPlainMessage(plainMessage);Parameters
| Type | Name | Description |
| String | plainMessage | Plain message text of this message. |
Returns
| Type | Description |
| Void |
SetRegistered(DateTime)
Declaration
Void SetRegistered(DateTime registered)Examples
NSShipmentMessageEntity thing;
DateTime registered;
thing.SetRegistered(registered);Parameters
| Type | Name | Description |
| DateTime | registered | Registered when. |
Returns
| Type | Description |
| Void |
SetRegisteredAssociateId(Integer)
Declaration
Void SetRegisteredAssociateId(Integer registeredAssociateId)Examples
NSShipmentMessageEntity thing;
Integer registeredAssociateId;
thing.SetRegisteredAssociateId(registeredAssociateId);Parameters
| Type | Name | Description |
| Integer | registeredAssociateId | Registered by whom. |
Returns
| Type | Description |
| Void |
SetRegisterViews(Bool)
Declaration
Void SetRegisterViews(Bool registerViews)Examples
NSShipmentMessageEntity thing;
Bool registerViews;
thing.SetRegisterViews(registerViews);Parameters
| Type | Name | Description |
| Bool | registerViews | Register message views? |
Returns
| Type | Description |
| Void |
SetShipmentMessageId(Integer)
Declaration
Void SetShipmentMessageId(Integer shipmentMessageId)Examples
NSShipmentMessageEntity thing;
Integer shipmentMessageId;
thing.SetShipmentMessageId(shipmentMessageId);Parameters
| Type | Name | Description |
| Integer | shipmentMessageId | Primary key. |
Returns
| Type | Description |
| Void |
SetSmsMessage(String)
Declaration
Void SetSmsMessage(String smsMessage)Examples
NSShipmentMessageEntity thing;
String smsMessage;
thing.SetSmsMessage(smsMessage);Parameters
| Type | Name | Description |
| String | smsMessage | SMS version of this message. |
Returns
| Type | Description |
| Void |
SetSubject(String)
Declaration
Void SetSubject(String subject)Examples
NSShipmentMessageEntity thing;
String subject;
thing.SetSubject(subject);Parameters
| Type | Name | Description |
| String | subject | The mail subject field of the message. |
Returns
| Type | Description |
| Void |
SetUpdated(DateTime)
Declaration
Void SetUpdated(DateTime updated)Examples
NSShipmentMessageEntity thing;
DateTime updated;
thing.SetUpdated(updated);Parameters
| Type | Name | Description |
| DateTime | updated | Last updated when. |
Returns
| Type | Description |
| Void |
SetUpdatedAssociateId(Integer)
Declaration
Void SetUpdatedAssociateId(Integer updatedAssociateId)Examples
NSShipmentMessageEntity thing;
Integer updatedAssociateId;
thing.SetUpdatedAssociateId(updatedAssociateId);Parameters
| Type | Name | Description |
| Integer | updatedAssociateId | Last updated by whom. |
Returns
| Type | Description |
| Void |
SetUpdatedCount(Integer)
Declaration
Void SetUpdatedCount(Integer updatedCount)Examples
NSShipmentMessageEntity thing;
Integer updatedCount;
thing.SetUpdatedCount(updatedCount);Parameters
| Type | Name | Description |
| Integer | updatedCount | Number of updates made to this record. |
Returns
| Type | Description |
| Void |