Show / Hide Table of Contents

Class NSTicketEntity

Represents a service ticket.

Syntax

Constructors

NSTicketEntity()

Initializes a new instance of the NSTicketEntity class.

Declaration
NSTicketEntity

Methods

GetActivate()

When the ticket should be activated, if it is postponed.

Declaration
DateTime GetActivate()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime activate = thing.GetActivate();

GetAlertLevel()

The alert level for the ticket. Matches the level value of the ticket_alert table.

Declaration
Integer GetAlertLevel()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer alertLevel = thing.GetAlertLevel();

GetAlertTimeout()

The datetime for when the ticket should jump to the next alert_level.

Declaration
DateTime GetAlertTimeout()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime alertTimeout = thing.GetAlertTimeout();

GetAuthor()

A string representing the author of the ticket (same as author of first message).

Declaration
String GetAuthor()
Returns
Type Description
String
Examples
NSTicketEntity thing;
String author = thing.GetAuthor();

GetBaseStatus()

Represents a service ticket.

Declaration
Integer GetBaseStatus()
Returns
Type Description
Integer

The status of the ticket. See TicketBaseStatus

Examples
NSTicketEntity thing;
Integer baseStatus = thing.GetBaseStatus();

GetCategory()

The ticket category entity which this ticket is connected to

Declaration
NSTicketCategoryEntity GetCategory()
Returns
Type Description
NSTicketCategoryEntity
Examples
NSTicketEntity thing;
NSTicketCategoryEntity category = thing.GetCategory();

GetClosedAt()

When the ticket was closed.

Declaration
DateTime GetClosedAt()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime closedAt = thing.GetClosedAt();

GetConnectId()

If a ticket is connected to another ticket, this field is set to the ID of the 'master' ticket.

Declaration
Integer GetConnectId()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer connectId = thing.GetConnectId();

GetCreatedAt()

When the ticket was created.

Declaration
DateTime GetCreatedAt()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime createdAt = thing.GetCreatedAt();

GetCreatedBy()

The associate who created this ticket

Declaration
NSAssociate GetCreatedBy()
Returns
Type Description
NSAssociate
Examples
NSTicketEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

GetCustomFields()

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

Declaration
Map GetCustomFields()
Returns
Type Description
Map
Examples
NSTicketEntity 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());

GetDeadline()

Deadline for ticket.

Declaration
DateTime GetDeadline()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime deadline = thing.GetDeadline();

GetExtraFields()

Gets the extra fields on TicketEntity as a map.

Declaration
Map GetExtraFields()
Returns
Type Description
Map
Examples
NSTicketEntity 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());

GetFirstReadByUser()

The datetime for when the ticket first was read by a user.

Declaration
DateTime GetFirstReadByUser()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime firstReadByUser = thing.GetFirstReadByUser();

GetFromAddress()

The from-address used when this ticket got created, e.g. by email

Declaration
String GetFromAddress()
Returns
Type Description
String
Examples
NSTicketEntity thing;
String fromAddress = thing.GetFromAddress();

GetHasAttachment()

Bool indicating if this ticket has one or more attachments.

Declaration
Bool GetHasAttachment()
Returns
Type Description
Bool
Examples
NSTicketEntity thing;
Bool hasAttachment = thing.GetHasAttachment();

GetLastChanged()

The last time the ticket was modified.

Declaration
DateTime GetLastChanged()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime lastChanged = thing.GetLastChanged();

GetMessages()

Represents a service ticket.

Declaration
NSTicketMessage[] GetMessages()
Returns
Type Description
NSTicketMessage[]

TicketMessageId, CreatedAt, SLevel, and Important for all the messages connected to this ticket.

Remarks

For message body, see the NSTicketMessageEntity or the NSTicketMessage archive.

Examples
NSTicketEntity thing;
NSTicketMessage[] messages = thing.GetMessages();

GetNumMessages()

The total number of messages for this request.

Declaration
Integer GetNumMessages()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer numMessages = thing.GetNumMessages();

GetNumReplies()

The number of replies (messages) to the customer for this request.

Declaration
Integer GetNumReplies()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer numReplies = thing.GetNumReplies();

GetOrigin()

What is the origin of this ticket

Declaration
Integer GetOrigin()
Returns
Type Description
Integer

See TicketOrigin.

Examples
NSTicketEntity thing;
Integer origin = thing.GetOrigin();

GetOwnedBy()

The associate who owns this ticket

Declaration
NSAssociate GetOwnedBy()
Returns
Type Description
NSAssociate
Examples
NSTicketEntity thing;
NSAssociate ownedBy = thing.GetOwnedBy();

GetPerson()

The primary person that this ticket is connected to

Declaration
NSPerson GetPerson()
Returns
Type Description
NSPerson
Examples
NSTicketEntity thing;
NSPerson person = thing.GetPerson();

GetPriority()

The ticket priority entity which this ticket is connected to

Declaration
NSTicketPriorityEntity GetPriority()
Returns
Type Description
NSTicketPriorityEntity
Examples
NSTicketEntity thing;
NSTicketPriorityEntity priority = thing.GetPriority();

GetReadByCustomer()

The datetime for when the ticket was read by the customer.

Declaration
DateTime GetReadByCustomer()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime readByCustomer = thing.GetReadByCustomer();

GetReadByOwner()

The datetime for when the ticket last was read by the owner.

Declaration
DateTime GetReadByOwner()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime readByOwner = thing.GetReadByOwner();

GetReadStatus()

Represents a service ticket.

Declaration
Integer GetReadStatus()
Returns
Type Description
Integer

Whether the owner has read the ticket or not (red, yellow, green). See TicketReadStatus.

Examples
NSTicketEntity thing;
Integer readStatus = thing.GetReadStatus();

GetRealTimeSpentExternally()

The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state

Declaration
Integer GetRealTimeSpentExternally()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer realTimeSpentExternally = thing.GetRealTimeSpentExternally();

GetRealTimeSpentInternally()

The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state

Declaration
Integer GetRealTimeSpentInternally()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer realTimeSpentInternally = thing.GetRealTimeSpentInternally();

GetRealTimeSpentQueue()

The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state

Declaration
Integer GetRealTimeSpentQueue()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer realTimeSpentQueue = thing.GetRealTimeSpentQueue();

GetRealTimeToClose()

Same as time_to_close, but not calculated based on priority.

Declaration
Integer GetRealTimeToClose()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer realTimeToClose = thing.GetRealTimeToClose();

GetRealTimeToReply()

Same as time_to_reply, but not calculated based on priority.

Declaration
Integer GetRealTimeToReply()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer realTimeToReply = thing.GetRealTimeToReply();

GetRepliedAt()

The datetime for when the ticket was replied to. I.e. the first external message added to the ticket.

Declaration
DateTime GetRepliedAt()
Returns
Type Description
DateTime
Examples
NSTicketEntity thing;
DateTime repliedAt = thing.GetRepliedAt();

GetSecondaryPersons()

The secondary persons this ticket is connected to

Declaration
NSPerson[] GetSecondaryPersons()
Returns
Type Description
NSPerson[]
Examples
NSTicketEntity thing;
NSPerson[] secondaryPersons = thing.GetSecondaryPersons();

GetSlevel()

Represents a service ticket.

Declaration
Integer GetSlevel()
Returns
Type Description
Integer

The security level of the ticket. See TicketSecurityLevel.

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

GetStatus()

The ticket status entity which this ticket is connected to

Declaration
NSTicketStatusEntity GetStatus()
Returns
Type Description
NSTicketStatusEntity
Examples
NSTicketEntity thing;
NSTicketStatusEntity status = thing.GetStatus();

GetTags()

An array containing the tags assigned to this request.

Declaration
NSTag[] GetTags()
Returns
Type Description
NSTag[]
Examples
NSTicketEntity thing;
NSTag[] tags = thing.GetTags();

GetTicketId()

The primary key (auto-incremented)

Declaration
Integer GetTicketId()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer ticketId = thing.GetTicketId();

GetTimeSpentExternally()

The total time (seconds) within the priority's office hours the ticket has been in a external waiting status (configurable), not including current state

Declaration
Integer GetTimeSpentExternally()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer timeSpentExternally = thing.GetTimeSpentExternally();

GetTimeSpentInternally()

The total time (seconds) within the priority's office hours the ticket has been in an open status (configurable), not including current state

Declaration
Integer GetTimeSpentInternally()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer timeSpentInternally = thing.GetTimeSpentInternally();

GetTimeSpentQueue()

The total time (seconds) within the priority's office hours the ticket has been in a queue status, not including current state

Declaration
Integer GetTimeSpentQueue()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer timeSpentQueue = thing.GetTimeSpentQueue();

GetTimeToClose()

The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority's timeframe.

Declaration
Integer GetTimeToClose()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer timeToClose = thing.GetTimeToClose();

GetTimeToReply()

The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority's timeframe.

Declaration
Integer GetTimeToReply()
Returns
Type Description
Integer
Examples
NSTicketEntity thing;
Integer timeToReply = thing.GetTimeToReply();

GetTitle()

The title of the ticket.

Declaration
String GetTitle()
Returns
Type Description
String
Examples
NSTicketEntity thing;
String title = thing.GetTitle();

SetActivate(DateTime)

When the ticket should be activated, if it is postponed.

Declaration
Void SetActivate(DateTime activate)
Parameters
Type Name Description
DateTime activate
Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime activate;
thing.SetActivate(activate);

SetAlertLevel(Integer)

The alert level for the ticket. Matches the level value of the ticket_alert table.

Declaration
Void SetAlertLevel(Integer alertLevel)
Parameters
Type Name Description
Integer alertLevel
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer alertLevel;
thing.SetAlertLevel(alertLevel);

SetAlertTimeout(DateTime)

The datetime for when the ticket should jump to the next alert level.

Declaration
Void SetAlertTimeout(DateTime alertTimeout)
Parameters
Type Name Description
DateTime alertTimeout
Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime alertTimeout;
thing.SetAlertTimeout(alertTimeout);

SetAuthor(String)

A string representing the author of the ticket (same as author of first message).

Declaration
Void SetAuthor(String author)
Parameters
Type Name Description
String author
Returns
Type Description
Void
Examples
NSTicketEntity thing;
String author;
thing.SetAuthor(author);

SetBaseStatus(Integer)

Represents a service ticket.

Declaration
Void SetBaseStatus(Integer baseStatus)
Parameters
Type Name Description
Integer baseStatus

The status of the ticket. See TicketBaseStatus.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer baseStatus;
thing.SetBaseStatus(baseStatus);

SetCategory(NSTicketCategoryEntity)

Represents a service ticket.

Declaration
Void SetCategory(NSTicketCategoryEntity category)
Parameters
Type Name Description
NSTicketCategoryEntity category

The ticket category entity which this ticket is connected to.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
NSTicketCategoryEntity category;
thing.SetCategory(category);

SetClosedAt(DateTime)

Represents a service ticket.

Declaration
Void SetClosedAt(DateTime closedAt)
Parameters
Type Name Description
DateTime closedAt

When the ticket was closed.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime closedAt;
thing.SetClosedAt(closedAt);

SetConnectId(Integer)

If a ticket is connected to another ticket, this field is set to the ID of the 'master' ticket.

Declaration
Void SetConnectId(Integer connectId)
Parameters
Type Name Description
Integer connectId
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer connectId;
thing.SetConnectId(connectId);

SetCreatedAt(DateTime)

When the ticket was created.

Declaration
Void SetCreatedAt(DateTime createdAt)
Parameters
Type Name Description
DateTime createdAt
Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime createdAt;
thing.SetCreatedAt(createdAt);

SetCreatedBy(NSAssociate)

Represents a service ticket.

Declaration
Void SetCreatedBy(NSAssociate createdBy)
Parameters
Type Name Description
NSAssociate createdBy

The associate who created this ticket.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

SetCustomFields(Map)

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

Declaration
Void SetCustomFields(Map udefs)
Parameters
Type Name Description
Map udefs
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Map udefs;
udefs.insert("SuperOffice:1", "[I:123]");
udefs.insert("SuperOffice:1","123"); // this will also work, but beware of decimal point variations in different languages
udefs.insert("custom.progid","foobar");
udefs.insert("x_foo","foobar");
udefs.insert("x_bar","456"); // List item id
thing.SetCustomFields(udefs);

SetDeadline(DateTime)

Represents a service ticket.

Declaration
Void SetDeadline(DateTime deadline)
Parameters
Type Name Description
DateTime deadline

Deadline for ticket.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime deadline;
thing.SetDeadline(deadline);

SetExtraFields(Map)

Sets the extra field values on TicketEntity with a map.

Declaration
Void SetExtraFields(Map extras)
Parameters
Type Name Description
Map extras
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Map extras;
extras.insert("custom.progid","foobar");
thing.SetExtraFields(extras);

SetFirstReadByUser(DateTime)

Represents a service ticket.

Declaration
Void SetFirstReadByUser(DateTime firstReadByUser)
Parameters
Type Name Description
DateTime firstReadByUser

The datetime for when the ticket first was read by a user.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime firstReadByUser;
thing.SetFirstReadByUser(firstReadByUser);

SetFromAddress(String)

The from-address used when this ticket got created, e.g. by email

Declaration
Void SetFromAddress(String fromAddress)
Parameters
Type Name Description
String fromAddress
Returns
Type Description
Void
Examples
NSTicketEntity thing;
String fromAddress;
thing.SetFromAddress(fromAddress);

SetHasAttachment(Bool)

Bool indicating if this ticket has one or more attachments.

Declaration
Void SetHasAttachment(Bool hasAttachment)
Parameters
Type Name Description
Bool hasAttachment
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Bool hasAttachment;
thing.SetHasAttachment(hasAttachment);

SetLastChanged(DateTime)

Represents a service ticket.

Declaration
Void SetLastChanged(DateTime lastChanged)
Parameters
Type Name Description
DateTime lastChanged

The last time the ticket was modified.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime lastChanged;
thing.SetLastChanged(lastChanged);

SetMessages(NSTicketMessage[])

Represents a service ticket.

Declaration
Void SetMessages(NSTicketMessage[] messages)
Parameters
Type Name Description
NSTicketMessage[] messages

TicketMessageId,CreatedAt,SLevel and Important for all the messages connected to this ticket.

Returns
Type Description
Void
Remarks

For message body, see the NSTicketMessageEntity or the NSTicketMessage archive.

Examples
NSTicketEntity thing;
NSTicketMessage[] messages;
thing.SetMessages(messages);

SetNumMessages(Integer)

The total number of messages for this request.

Declaration
Void SetNumMessages(Integer numMessages)
Parameters
Type Name Description
Integer numMessages
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer numMessages;
thing.SetNumMessages(numMessages);

SetNumReplies(Integer)

The number of replies (messages) to the customer for this request.

Declaration
Void SetNumReplies(Integer numReplies)
Parameters
Type Name Description
Integer numReplies
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer numReplies;
thing.SetNumReplies(numReplies);

SetOrigin(Integer)

Represents a service ticket.

Declaration
Void SetOrigin(Integer origin)
Parameters
Type Name Description
Integer origin

What is the origin of this ticket? See TicketOrigin.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer origin;
thing.SetOrigin(origin);

SetOwnedBy(NSAssociate)

Represents a service ticket.

Declaration
Void SetOwnedBy(NSAssociate ownedBy)
Parameters
Type Name Description
NSAssociate ownedBy

The associate who owns this ticket.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
NSAssociate ownedBy;
thing.SetOwnedBy(ownedBy);

SetPerson(NSPerson)

The primary person that this ticket is connected to

Declaration
Void SetPerson(NSPerson person)
Parameters
Type Name Description
NSPerson person
Returns
Type Description
Void
Examples
NSTicketEntity thing;
NSPerson person;
thing.SetPerson(person);

SetPriority(NSTicketPriorityEntity)

The ticket priority entity which this ticket is connected to

Declaration
Void SetPriority(NSTicketPriorityEntity priority)
Parameters
Type Name Description
NSTicketPriorityEntity priority
Returns
Type Description
Void
Examples
NSTicketEntity thing;
NSTicketPriorityEntity priority;
thing.SetPriority(priority);

SetReadByCustomer(DateTime)

Represents a service ticket.

Declaration
Void SetReadByCustomer(DateTime readByCustomer)
Parameters
Type Name Description
DateTime readByCustomer

The datetime for when the ticket was read by the customer.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime readByCustomer;
thing.SetReadByCustomer(readByCustomer);

SetReadByOwner(DateTime)

Represents a service ticket.

Declaration
Void SetReadByOwner(DateTime readByOwner)
Parameters
Type Name Description
DateTime readByOwner

The datetime for when the ticket was read by the owner.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime readByOwner;
thing.SetReadByOwner(readByOwner);

SetReadStatus(Integer)

Represents a service ticket.

Declaration
Void SetReadStatus(Integer readStatus)
Parameters
Type Name Description
Integer readStatus

Whether the owner has read the ticket or not (red, yellow, green). See TicketReadStatus.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer readStatus;
thing.SetReadStatus(readStatus);

SetRealTimeSpentExternally(Integer)

The total time (seconds) within 24x7 the ticket has been in a external waiting status (configurable), not including current state

Declaration
Void SetRealTimeSpentExternally(Integer realTimeSpentExternally)
Parameters
Type Name Description
Integer realTimeSpentExternally
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer realTimeSpentExternally;
thing.SetRealTimeSpentExternally(realTimeSpentExternally);

SetRealTimeSpentInternally(Integer)

The total time (seconds) within 24x7 the ticket has been in an open status (configurable), not including current state

Declaration
Void SetRealTimeSpentInternally(Integer realTimeSpentInternally)
Parameters
Type Name Description
Integer realTimeSpentInternally
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer realTimeSpentInternally;
thing.SetRealTimeSpentInternally(realTimeSpentInternally);

SetRealTimeSpentQueue(Integer)

The total time (seconds) within 24x7 hours the ticket has been in a queue status, not including current state

Declaration
Void SetRealTimeSpentQueue(Integer realTimeSpentQueue)
Parameters
Type Name Description
Integer realTimeSpentQueue
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer realTimeSpentQueue;
thing.SetRealTimeSpentQueue(realTimeSpentQueue);

SetRealTimeToClose(Integer)

Same as time_to_close, but not calculated based on priority.

Declaration
Void SetRealTimeToClose(Integer realTimeToClose)
Parameters
Type Name Description
Integer realTimeToClose
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer realTimeToClose;
thing.SetRealTimeToClose(realTimeToClose);

SetRealTimeToReply(Integer)

Same as time_to_reply, but not calculated based on priority.

Declaration
Void SetRealTimeToReply(Integer realTimeToReply)
Parameters
Type Name Description
Integer realTimeToReply
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer realTimeToReply;
thing.SetRealTimeToReply(realTimeToReply);

SetRepliedAt(DateTime)

The datetime for when the ticket was replied to (when the first external message added to the ticket).

Declaration
Void SetRepliedAt(DateTime repliedAt)
Parameters
Type Name Description
DateTime repliedAt

When the ticket was replied to.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
DateTime repliedAt;
thing.SetRepliedAt(repliedAt);

SetSecondaryPersons(NSPerson[])

The secondary persons this ticket is connected to

Declaration
Void SetSecondaryPersons(NSPerson[] secondaryPersons)
Parameters
Type Name Description
NSPerson[] secondaryPersons
Returns
Type Description
Void
Examples
NSTicketEntity thing;
NSPerson[] secondaryPersons;
thing.SetSecondaryPersons(secondaryPersons);

SetSlevel(Integer)

Represents a service ticket.

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

The security level of the ticket. See TicketSecurityLevel.

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

SetStatus(NSTicketStatusEntity)

Represents a service ticket.

Declaration
Void SetStatus(NSTicketStatusEntity status)
Parameters
Type Name Description
NSTicketStatusEntity status

The ticket status entity which this ticket is connected to.

Returns
Type Description
Void
Examples
NSTicketEntity thing;
NSTicketStatusEntity status;
thing.SetStatus(status);

SetTags(NSTag[])

An array containing the tags assigned to this request

Declaration
Void SetTags(NSTag[] tags)
Parameters
Type Name Description
NSTag[] tags
Returns
Type Description
Void
Examples
NSTicketEntity thing;
NSTag[] tags;
thing.SetTags(tags);

SetTicketId(Integer)

The primary key (auto-incremented)

Declaration
Void SetTicketId(Integer ticketId)
Parameters
Type Name Description
Integer ticketId
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer ticketId;
thing.SetTicketId(ticketId);

SetTimeSpentExternally(Integer)

The total time (seconds) within the priority's office hours the ticket has been in a external waiting status (configurable), not including current state

Declaration
Void SetTimeSpentExternally(Integer timeSpentExternally)
Parameters
Type Name Description
Integer timeSpentExternally
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer timeSpentExternally;
thing.SetTimeSpentExternally(timeSpentExternally);

SetTimeSpentInternally(Integer)

The total time (seconds) within the priority's office hours the ticket has been in an open status (configurable), not including current state

Declaration
Void SetTimeSpentInternally(Integer timeSpentInternally)
Parameters
Type Name Description
Integer timeSpentInternally
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer timeSpentInternally;
thing.SetTimeSpentInternally(timeSpentInternally);

SetTimeSpentQueue(Integer)

The total time (seconds) within the priority's office hours the ticket has been in a queue status, not including current state

Declaration
Void SetTimeSpentQueue(Integer timeSpentQueue)
Parameters
Type Name Description
Integer timeSpentQueue
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer timeSpentQueue;
thing.SetTimeSpentQueue(timeSpentQueue);

SetTimeToClose(Integer)

The time (minutes) between when the ticket was created and when it was closed. Calculated based on priority's timeframe.

Declaration
Void SetTimeToClose(Integer timeToClose)
Parameters
Type Name Description
Integer timeToClose
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer timeToClose;
thing.SetTimeToClose(timeToClose);

SetTimeToReply(Integer)

The time (minutes) between when the ticket was created and when it was replied to. Calculated based on priority's timeframe.

Declaration
Void SetTimeToReply(Integer timeToReply)
Parameters
Type Name Description
Integer timeToReply
Returns
Type Description
Void
Examples
NSTicketEntity thing;
Integer timeToReply;
thing.SetTimeToReply(timeToReply);

SetTitle(String)

The title of the ticket.

Declaration
Void SetTitle(String title)
Parameters
Type Name Description
String title
Returns
Type Description
Void
Examples
NSTicketEntity thing;
String title;
thing.SetTitle(title);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top