Show / Hide Table of Contents

Class NSTicketMessage

The TicketMessage carrier is used for representing a service ticket message.

Syntax

Constructors

NSTicketMessage()

Initializes a new instance of the NSTicketMessage class.

Declaration
NSTicketMessage

Methods

GetAuthor()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
String GetAuthor()
Returns
Type Description
String

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

Examples
NSTicketMessage thing;
String author = thing.GetAuthor();

GetContactDepartment()

\n

Declaration
String GetContactDepartment()
Returns
Type Description
String

nDepartment.

Examples
NSTicketMessage thing;
String contactDepartment = thing.GetContactDepartment();

GetContactId()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Integer GetContactId()
Returns
Type Description
Integer

Primary key.

Examples
NSTicketMessage thing;
Integer contactId = thing.GetContactId();

GetContactName()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
String GetContactName()
Returns
Type Description
String

Contact name.

Examples
NSTicketMessage thing;
String contactName = thing.GetContactName();

GetCreatedAt()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
DateTime GetCreatedAt()
Returns
Type Description
DateTime

When the message was posted.

Examples
NSTicketMessage thing;
DateTime createdAt = thing.GetCreatedAt();

GetEmailHeader()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
String GetEmailHeader()
Returns
Type Description
String

The email header is saved in this field as raw text.

Examples
NSTicketMessage thing;
String emailHeader = thing.GetEmailHeader();

GetImportant()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Bool GetImportant()
Returns
Type Description
Bool

If this message is important or not.

Examples
NSTicketMessage thing;
Bool important = thing.GetImportant();

GetNumAttachments()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Integer GetNumAttachments()
Returns
Type Description
Integer

Number of attachments in the message.

Examples
NSTicketMessage thing;
Integer numAttachments = thing.GetNumAttachments();

GetPersonFullName()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
String GetPersonFullName()
Returns
Type Description
String

Gets the persons full name (internal name used in clients for employees).

Examples
NSTicketMessage thing;
String personFullName = thing.GetPersonFullName();

GetPersonId()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Integer GetPersonId()
Returns
Type Description
Integer

Primary key.

Examples
NSTicketMessage thing;
Integer personId = thing.GetPersonId();

GetSlevel()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Integer GetSlevel()
Returns
Type Description
Integer

The security-level of the message. See TicketSecurityLevel.

Examples
NSTicketMessage thing;
Integer slevel = thing.GetSlevel();

GetTicketMessageId()

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Integer GetTicketMessageId()
Returns
Type Description
Integer

The primary key (auto-incremented).

Examples
NSTicketMessage thing;
Integer ticketMessageId = thing.GetTicketMessageId();

SetAuthor(String)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetAuthor(String author)
Parameters
Type Name Description
String author

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

Returns
Type Description
Void
Examples
NSTicketMessage thing;
String author;
thing.SetAuthor(author);

SetContactDepartment(String)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetContactDepartment(String contactDepartment)
Parameters
Type Name Description
String contactDepartment

Department.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
String contactDepartment;
thing.SetContactDepartment(contactDepartment);

SetContactId(Integer)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetContactId(Integer contactId)
Parameters
Type Name Description
Integer contactId

Primary key.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
Integer contactId;
thing.SetContactId(contactId);

SetContactName(String)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetContactName(String contactName)
Parameters
Type Name Description
String contactName

Contact name.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
String contactName;
thing.SetContactName(contactName);

SetCreatedAt(DateTime)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetCreatedAt(DateTime createdAt)
Parameters
Type Name Description
DateTime createdAt

When the message was posted.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
DateTime createdAt;
thing.SetCreatedAt(createdAt);

SetEmailHeader(String)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetEmailHeader(String emailHeader)
Parameters
Type Name Description
String emailHeader

The email header is saved in this field as raw text.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
String emailHeader;
thing.SetEmailHeader(emailHeader);

SetImportant(Bool)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetImportant(Bool important)
Parameters
Type Name Description
Bool important

If this message is important or not.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
Bool important;
thing.SetImportant(important);

SetNumAttachments(Integer)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetNumAttachments(Integer numAttachments)
Parameters
Type Name Description
Integer numAttachments

Number of attachments in the message.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
Integer numAttachments;
thing.SetNumAttachments(numAttachments);

SetPersonFullName(String)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetPersonFullName(String personFullName)
Parameters
Type Name Description
String personFullName

Gets the persons full name (internal name used in clients for employees).

Returns
Type Description
Void
Examples
NSTicketMessage thing;
String personFullName;
thing.SetPersonFullName(personFullName);

SetPersonId(Integer)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetPersonId(Integer personId)
Parameters
Type Name Description
Integer personId

Primary key.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
Integer personId;
thing.SetPersonId(personId);

SetSlevel(Integer)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetSlevel(Integer slevel)
Parameters
Type Name Description
Integer slevel

The security-level of the message. See TicketSecurityLevel.

Returns
Type Description
Void
Examples
NSTicketMessage thing;
Integer slevel;
thing.SetSlevel(slevel);

SetTicketMessageId(Integer)

The TicketMessage carrier is used for representing a service ticket message.

Declaration
Void SetTicketMessageId(Integer ticketMessageId)
Parameters
Type Name Description
Integer ticketMessageId

The primary key (auto-incremented).

Returns
Type Description
Void
Examples
NSTicketMessage thing;
Integer ticketMessageId;
thing.SetTicketMessageId(ticketMessageId);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top