Class NSTicketAgent

NSTicketAgent()

Agent used for Ticket functions.

Declaration

NSTicketAgent

NSTicketAgent agent;
agent.callMethod(arg1, arg2);

AddAttachments(Integer,Integer[])

Connects existing attachments with this TicketMessage. Can connect multiple attachments

Declaration

Void AddAttachments(Integer ticketMessageEntityId, Integer[] attachmentIds)

Parameters

Returns

CreateDefaultAttachmentEntity()

Sets default values into a new NSAttachmentEntity.

Declaration

NSAttachmentEntity CreateDefaultAttachmentEntity()

NSTicketAgent agent;
NSAttachmentEntity thing = agent.CreateDefaultAttachmentEntity();
thing = agent.SaveAttachmentEntity(thing);

Returns

CreateDefaultTicketEntity()

Sets default values into a new NSTicketEntity.

Declaration

NSTicketEntity CreateDefaultTicketEntity()

NSTicketAgent agent;
NSTicketEntity thing = agent.CreateDefaultTicketEntity();
thing = agent.SaveTicketEntity(thing);

Returns

CreateDefaultTicketMessageEntity()

Sets default values into a new NSTicketMessageEntity.

Declaration

NSTicketMessageEntity CreateDefaultTicketMessageEntity()

NSTicketAgent agent;
NSTicketMessageEntity thing = agent.CreateDefaultTicketMessageEntity();
thing = agent.SaveTicketMessageEntity(thing);

Returns

DeleteTicketEntity(Integer)

Deletes a ticket

Declaration

Void DeleteTicketEntity(Integer ticketEntityId)

NSTicketAgent agent;
Integer ticketEntityId;
agent.DeleteTicketEntity(ticketEntityId);

Parameters

Returns

DeleteTicketMessageEntity(Integer)

Deletes a ticket message

Declaration

Void DeleteTicketMessageEntity(Integer ticketMessageEntityId)

NSTicketAgent agent;
Integer ticketMessageEntityId;
agent.DeleteTicketMessageEntity(ticketMessageEntityId);

Parameters

Returns

GetAttachmentEntity(Integer)

Gets an NSAttachmentEntity object.

Declaration

NSAttachmentEntity GetAttachmentEntity(Integer attachmentEntityId)

NSTicketAgent agent;
NSAttachmentEntity thing = agent.GetAttachmentEntity(123);

Parameters

Returns

GetAttachmentInfo(Integer)

Gets a list with meta data for all attached attachments

Declaration

NSAttachmentEntity[] GetAttachmentInfo(Integer ticketMessageEntityId)

NSTicketAgent agent;
Integer ticketMessageEntityId;
NSAttachmentEntity[] res = agent.GetAttachmentInfo(ticketMessageEntityId);

Parameters

Returns

GetAttachmentStream(Integer)

Gets the content of an attachment

Declaration

NSStream GetAttachmentStream(Integer attachmentId)

NSTicketAgent agent;
Integer attachmentId;
NSStream res = agent.GetAttachmentStream(attachmentId);

Parameters

Returns

GetTicket(Integer)

Gets an NSTicket object.

Declaration

NSTicket GetTicket(Integer ticketId)

NSTicketAgent agent;
NSTicket thing = agent.GetTicket(123);

Parameters

Returns

GetTicketAttachments(Integer)

Gets attachment infos for all attachments connected to messages in specified ticket

Declaration

NSAttachmentEntity[] GetTicketAttachments(Integer ticketEntityId)

NSTicketAgent agent;
Integer ticketEntityId;
NSAttachmentEntity[] res = agent.GetTicketAttachments(ticketEntityId);

Parameters

Returns

GetTicketEntity(Integer)

Gets an NSTicketEntity object.

Declaration

NSTicketEntity GetTicketEntity(Integer ticketEntityId)

NSTicketAgent agent;
NSTicketEntity thing = agent.GetTicketEntity(123);

Parameters

Returns

GetTicketMessage(Integer)

Gets an NSTicketMessage object.

Declaration

NSTicketMessage GetTicketMessage(Integer ticketMessageId)

NSTicketAgent agent;
NSTicketMessage thing = agent.GetTicketMessage(123);

Parameters

Returns

GetTicketMessageEntity(Integer)

Gets an NSTicketMessageEntity object.

Declaration

NSTicketMessageEntity GetTicketMessageEntity(Integer ticketMessageEntityId)

NSTicketAgent agent;
NSTicketMessageEntity thing = agent.GetTicketMessageEntity(123);

Parameters

Returns

GetTickets(Integer[])

Gets multiple tickets

Declaration

NSTicket[] GetTickets(Integer[] ticketIds)

NSTicketAgent agent;
Integer[] ticketIds;
NSTicket[] res = agent.GetTickets(ticketIds);

Parameters

Returns

Html2Text(String)

Creates a plain text version of the html, suitable for email

Declaration

String Html2Text(String content)

NSTicketAgent agent;
String content;
String res = agent.Html2Text(content);

Parameters

Returns

NotifyNewTicket(Integer)

Notifies user agents about the creation of a new ticket

Declaration

Void NotifyNewTicket(Integer ticketEntityId)

NSTicketAgent agent;
Integer ticketEntityId;
agent.NotifyNewTicket(ticketEntityId);

Parameters

Returns

NotifyNewTicketMessage(Integer)

Notifies user agents about the creation of a new message on a ticket

Declaration

Void NotifyNewTicketMessage(Integer ticketEntityId)

NSTicketAgent agent;
Integer ticketEntityId;
agent.NotifyNewTicketMessage(ticketEntityId);

Parameters

Returns

SanitizeMailContent(String)

Removes harmful HTML tags and attributes from an email

Declaration

String SanitizeMailContent(String content)

NSTicketAgent agent;
String content;
String res = agent.SanitizeMailContent(content);

Parameters

Returns

SanitizeMailContents(String[])

Removes harmful HTML tags and attributes from an email

Declaration

String[] SanitizeMailContents(String[] contents)

NSTicketAgent agent;
String[] contents;
String[] res = agent.SanitizeMailContents(contents);

Parameters

Returns

SaveAttachmentEntity(NSAttachmentEntity)

Updates the existing NSAttachmentEntity or creates a new NSAttachmentEntity if the id parameter is 0

Declaration

NSAttachmentEntity SaveAttachmentEntity(NSAttachmentEntity attachmentEntity)

NSTicketAgent agent;
NSAttachmentEntity thing = agent.CreateDefaultAttachmentEntity();
thing = agent.SaveAttachmentEntity(thing);

Parameters

Returns

SaveTicketEntity(NSTicketEntity)

Updates the existing NSTicketEntity or creates a new NSTicketEntity if the id parameter is 0

Declaration

NSTicketEntity SaveTicketEntity(NSTicketEntity ticketEntity)

NSTicketAgent agent;
NSTicketEntity thing = agent.CreateDefaultTicketEntity();
thing = agent.SaveTicketEntity(thing);

Parameters

Returns

SaveTicketMessageEntity(NSTicketMessageEntity)

Updates the existing NSTicketMessageEntity or creates a new NSTicketMessageEntity if the id parameter is 0

Declaration

NSTicketMessageEntity SaveTicketMessageEntity(NSTicketMessageEntity ticketMessageEntity)

NSTicketAgent agent;
NSTicketMessageEntity thing = agent.CreateDefaultTicketMessageEntity();
thing = agent.SaveTicketMessageEntity(thing);

Parameters

Returns

SendTicketMessage(Integer,String[],String[],String[],String,Integer,String)

Sends a message to recipients, e.g. by email or sms

Declaration

Void SendTicketMessage(Integer ticketMessageEntityId, String[] to, String[] cc, String[] bcc, String subject, Integer replyTemplateId, String gdprSource)

NSTicketAgent agent;
Integer ticketMessageEntityId;
String[] to;
String[] cc;
String[] bcc;
String subject;
Integer replyTemplateId;
String gdprSource;
agent.SendTicketMessage(ticketMessageEntityId, to, cc, bcc, subject, replyTemplateId, gdprSource);

Parameters

Returns

SetTicketMessageImportant(Integer,Bool)

Sets the important flag on or off for a ticket message

Declaration

Void SetTicketMessageImportant(Integer ticketMessageId, Bool important)

Parameters

Returns

SetTicketReadByOwner(Integer,Integer,Bool)

Sets the ReadByOwner status for a ticket. It will only have an effect if the calling user is the same as the owner of the ticket

Declaration

NSTicketEntity SetTicketReadByOwner(Integer ticketEntityId, Integer readStatus, Bool checkEscalating)

NSTicketAgent agent;
Integer ticketEntityId;
Integer readStatus;
Bool checkEscalating;
NSTicketEntity res = agent.SetTicketReadByOwner(ticketEntityId, readStatus, checkEscalating);

Parameters

Returns

UploadAttachment(Integer,NSStream)

Uploads an attachment and returns the attachment ID

Declaration

Integer UploadAttachment(Integer attachmentId, NSStream content)

Parameters

Returns