NSTicketMessageEntity

The ticket messages are e-mails, SMS or other messages attached to a ticket (aka request).

Constructors

NSTicketMessageEntity()

NSTicketMessageEntity

Initializes a new instance of the NSTicketMessageEntity class.

Methods

GetAuthor()

A string representing the author of the message. Could be a user’s name, or a persons email address.

String GetAuthor()

Returns: CRMScript.Global.String Example:

NSTicketMessageEntity thing;
String author = thing.GetAuthor();

GetBody()

The textbody for the message.

String GetBody()

Returns: CRMScript.Global.String Example:

NSTicketMessageEntity thing;
String body = thing.GetBody();

GetCreatedAt()

When the message was posted.

DateTime GetCreatedAt()

Returns: CRMScript.Global.DateTime Example:

NSTicketMessageEntity thing;
DateTime createdAt = thing.GetCreatedAt();

GetCreatedBy()

The associate who created this ticket message

NSAssociate GetCreatedBy()

Returns: CRMScript.NetServer.NSAssociate Example:

NSTicketMessageEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

GetCustomFields()

Gets the user-defined + extra fields on a TicketMessageEntity as a map.

Map GetCustomFields()

Returns: CRMScript.Native.Map Example:

NSTicketMessageEntity thing;
Map fields = thing.GetCustomFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetDebugInfo()

The debug info for the message.

String GetDebugInfo()

Returns: CRMScript.Global.String Example:

NSTicketMessageEntity thing;
String debugInfo = thing.GetDebugInfo();

GetEjMessageId()

The primary key (auto-incremented)

Integer GetEjMessageId()

Returns: CRMScript.Global.Integer Example:

NSTicketMessageEntity thing;
Integer ejMessageId = thing.GetEjMessageId();

GetEmailHeader()

The email header is saved in this field as raw text

String GetEmailHeader()

Returns: CRMScript.Global.String Example:

NSTicketMessageEntity thing;
String emailHeader = thing.GetEmailHeader();

GetExtraFields()

Gets the extra fields on TicketMessageEntity as a map.

Map GetExtraFields()

Returns: CRMScript.Native.Map Example:

NSTicketMessageEntity thing;
Map fields = thing.GetExtraFields();
String oldValue = fields.get("x_foobar");
fields.insert("x_foobar", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetHtmlBody()

The HTML body for the message (if any).

String GetHtmlBody()

Returns: CRMScript.Global.String Example:

NSTicketMessageEntity thing;
String htmlBody = thing.GetHtmlBody();

GetImportant()

If this message is important or not.

Bool GetImportant()

Returns: CRMScript.Global.Bool Example:

NSTicketMessageEntity thing;
Bool important = thing.GetImportant();

GetMailSorter()

The name of the mail sorter used when the email was imported. Note: We must use name instead of id since the id’s change every time one changes the mail sorter. :-0

String GetMailSorter()

Returns: CRMScript.Global.String Example:

NSTicketMessageEntity thing;
String mailSorter = thing.GetMailSorter();

GetMessageCategory()

Integer GetMessageCategory()

Returns: CRMScript.Global.Integer - Defines what kind of message this is. See <xref href=“CRMScript.NetServer.TicketMessageCategory” data-throw-if-not-resolved=“false”></xref>. Example:

NSTicketMessageEntity thing;
Integer messageCategory = thing.GetMessageCategory();

GetMessageHeaders()

NSTicketMessageHeader[] GetMessageHeaders()

Returns: CRMScript.NetServer.NSTicketMessageHeader[] - Contains the message headers, like To, Cc, Bcc information, or custom headers. Example:

NSTicketMessageEntity thing;
TicketMessageHeader[] messageHeaders = thing.GetMessageHeaders();

GetMessageId()

The X-Message-Id header value from the email. Used for threading, i.e. connecting messages to existing tickets.

String GetMessageId()

Returns: CRMScript.Global.String Example:

NSTicketMessageEntity thing;
String messageId = thing.GetMessageId();

GetPerson()

If this is an incoming message, this will contain the person

NSPerson GetPerson()

Returns: CRMScript.NetServer.NSPerson Example:

NSTicketMessageEntity thing;
NSPerson person = thing.GetPerson();

GetSearchTitle()

A copy of the title of the ticket, for search optimization and simpler reporting.

String GetSearchTitle()

Returns: CRMScript.Global.String Example:

NSTicketMessageEntity thing;
String searchTitle = thing.GetSearchTitle();

GetSlevel()

Integer GetSlevel()

Returns: CRMScript.Global.Integer - The security level of the message. See <xref href=“CRMScript.NetServer.TicketSecurityLevel” data-throw-if-not-resolved=“false”></xref>. Example:

NSTicketMessageEntity thing;
Integer slevel = thing.GetSlevel();

GetTicket()

The connected ticket

NSTicket GetTicket()

Returns: CRMScript.NetServer.NSTicket Example:

NSTicketMessageEntity thing;
NSTicket ticket = thing.GetTicket();

GetTimeSpent()

The time spent (minutes) for this message.

Integer GetTimeSpent()

Returns: CRMScript.Global.Integer Example:

NSTicketMessageEntity thing;
Integer timeSpent = thing.GetTimeSpent();

GetType()

Integer GetType()

Returns: CRMScript.Global.Integer - The type of the message (plaintext/html). See <xref href=“CRMScript.NetServer.TicketMessageType” data-throw-if-not-resolved=“false”></xref>. Example:

NSTicketMessageEntity thing;
Integer type = thing.GetType();

SetAuthor(String)

A string representing the author of the message. Could be a user’s name, or a persons email address.

Void SetAuthor(String author)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
String author;
thing.SetAuthor(author);

SetBody(String)

The textbody for the message.

Void SetBody(String body)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
String body;
thing.SetBody(body);

SetCreatedAt(DateTime)

When the message was posted.

Void SetCreatedAt(DateTime createdAt)

Example:

NSTicketMessageEntity thing;
DateTime createdAt;
thing.SetCreatedAt(createdAt);

SetCreatedBy(NSAssociate)

The associate who created this ticket message

Void SetCreatedBy(NSAssociate createdBy)

Example:

NSTicketMessageEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

SetCustomFields(Map)

Sets the user-defined and extra fields on a TicketMessageEntity with a map.

Void SetCustomFields(Map udefs)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
udefs["x_foo"] = "foobar";
udefs["x_bar"] = "456"; // List item id
thing.SetCustomFields(udefs);

SetDebugInfo(String)

The debug info for the message.

Void SetDebugInfo(String debugInfo)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
String debugInfo;
thing.SetDebugInfo(debugInfo);

SetEjMessageId(Integer)

The primary key (auto-incremented)

Void SetEjMessageId(Integer ejMessageId)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
Integer ejMessageId;
thing.SetEjMessageId(ejMessageId);

SetEmailHeader(String)

The email header is saved in this field as raw text

Void SetEmailHeader(String emailHeader)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
String emailHeader;
thing.SetEmailHeader(emailHeader);

SetExtraFields(Map)

Sets the extra field values on TicketMessageEntity with a map.

Void SetExtraFields(Map extras)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
Map extras;
extras["SuperOffice:1"] = "[I:123]";
extras["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
extras["custom.progid"] = "foobar";
thing.SetExtraFields(extras);

SetHtmlBody(String)

The HTML body for the message (if any).

Void SetHtmlBody(String htmlBody)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
String htmlBody;
thing.SetHtmlBody(htmlBody);

SetImportant(Bool)

If this message is important or not.

Void SetImportant(Bool important)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
Bool important;
thing.SetImportant(important);

SetMailSorter(String)

The name of the mail sorter used when the email was imported. Note: We must use name instead of id since the id’s change every time one changes the mail sorter. :-0

Void SetMailSorter(String mailSorter)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
String mailSorter;
thing.SetMailSorter(mailSorter);

SetMessageCategory(Integer)

Void SetMessageCategory(Integer messageCategory)

Example:

NSTicketMessageEntity thing;
Integer messageCategory;
thing.SetMessageCategory(messageCategory);

SetMessageHeaders(NSTicketMessageHeader[])

Void SetMessageHeaders(NSTicketMessageHeader[] messageHeaders)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
NSTicketMessageHeader[] messageHeaders;
thing.SetMessageHeaders(messageHeaders);

SetMessageId(String)

The X-Message-Id header value from the email. Used for threading, i.e. connecting messages to existing tickets.

Void SetMessageId(String messageId)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
String messageId;
thing.SetMessageId(messageId);

SetPerson(NSPerson)

If this is an incoming message, this will contain the person

Void SetPerson(NSPerson person)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
NSPerson person;
thing.SetPerson(person);

SetSearchTitle(String)

A copy of the title of the ticket, for search optimisation and simpler reporting.

Void SetSearchTitle(String searchTitle)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
String searchTitle;
thing.SetSearchTitle(searchTitle);

SetSlevel(Integer)

Void SetSlevel(Integer slevel)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
Integer slevel;
thing.SetSlevel(slevel);

SetTicket(NSTicket)

The connected ticket

Void SetTicket(NSTicket ticket)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
NSTicket ticket;
thing.SetTicket(ticket);

SetTimeSpent(Integer)

The time spent (minutes) for this message.

Void SetTimeSpent(Integer timeSpent)

Returns: CRMScript.Global.Void Example:

NSTicketMessageEntity thing;
Integer timeSpent;
thing.SetTimeSpent(timeSpent);

SetType(Integer)

Void SetType(Integer type)

Example:

NSTicketMessageEntity thing;
Integer type;
thing.SetType(type);

​Constructors

​NSTicketMessageEntity()

​Methods

​GetAuthor()

​GetBody()

​GetCreatedAt()

​GetCreatedBy()

​GetCustomFields()

​GetDebugInfo()

​GetEjMessageId()

​GetEmailHeader()

​GetExtraFields()

​GetHtmlBody()

​GetImportant()

​GetMailSorter()

​GetMessageCategory()

​GetMessageHeaders()

​GetMessageId()

​GetPerson()

​GetSearchTitle()

​GetSlevel()

​GetTicket()

​GetTimeSpent()

​GetType()

​SetAuthor(String)

​SetBody(String)

​SetCreatedAt(DateTime)

​SetCreatedBy(NSAssociate)

​SetCustomFields(Map)

​SetDebugInfo(String)

​SetEjMessageId(Integer)

​SetEmailHeader(String)

​SetExtraFields(Map)

​SetHtmlBody(String)

​SetImportant(Bool)

​SetMailSorter(String)

​SetMessageCategory(Integer)

​SetMessageHeaders(NSTicketMessageHeader[])

​SetMessageId(String)

​SetPerson(NSPerson)

​SetSearchTitle(String)

​SetSlevel(Integer)

​SetTicket(NSTicket)

​SetTimeSpent(Integer)

​SetType(Integer)

Constructors

NSTicketMessageEntity()

Methods

GetAuthor()

GetBody()

GetCreatedAt()

GetCreatedBy()

GetCustomFields()

GetDebugInfo()

GetEjMessageId()

GetEmailHeader()

GetExtraFields()

GetHtmlBody()

GetImportant()

GetMailSorter()

GetMessageCategory()

GetMessageHeaders()

GetMessageId()

GetPerson()

GetSearchTitle()

GetSlevel()

GetTicket()

GetTimeSpent()

GetType()

SetAuthor(String)

SetBody(String)

SetCreatedAt(DateTime)

SetCreatedBy(NSAssociate)

SetCustomFields(Map)

SetDebugInfo(String)

SetEjMessageId(Integer)

SetEmailHeader(String)

SetExtraFields(Map)

SetHtmlBody(String)

SetImportant(Bool)

SetMailSorter(String)

SetMessageCategory(Integer)

SetMessageHeaders(NSTicketMessageHeader[])

SetMessageId(String)

SetPerson(NSPerson)

SetSearchTitle(String)

SetSlevel(Integer)

SetTicket(NSTicket)

SetTimeSpent(Integer)

SetType(Integer)