NSTicketAgent - SuperOffice

Agent used for Ticket functions.

Constructors

NSTicketAgent()

NSTicketAgent

Agent used for Ticket functions.

Methods

AddAttachments(Integer,Integer[])

Connects existing attachments with this TicketMessage. Can connect multiple attachments

Void AddAttachments(Integer ticketMessageEntityId, Integer[] attachmentIds)

Returns: CRMScript.Global.Void

CreateDefaultAttachmentEntity()

Sets default values into a new NSAttachmentEntity.

NSAttachmentEntity CreateDefaultAttachmentEntity()

Returns: CRMScript.NetServer.NSAttachmentEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

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

CreateDefaultTicketEntity()

Sets default values into a new NSTicketEntity.

NSTicketEntity CreateDefaultTicketEntity()

Returns: CRMScript.NetServer.NSTicketEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

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

CreateDefaultTicketMessageEntity()

Sets default values into a new NSTicketMessageEntity.

NSTicketMessageEntity CreateDefaultTicketMessageEntity()

Returns: CRMScript.NetServer.NSTicketMessageEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

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

DeleteTicketEntity(Integer)

Deletes a ticket

Void DeleteTicketEntity(Integer ticketEntityId)

Returns: CRMScript.Global.Void Example:

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

DeleteTicketMessageEntity(Integer)

Deletes a ticket message

Void DeleteTicketMessageEntity(Integer ticketMessageEntityId)

Returns: CRMScript.Global.Void Example:

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

GetAttachmentEntity(Integer)

Gets an NSAttachmentEntity object.

NSAttachmentEntity GetAttachmentEntity(Integer attachmentEntityId)

Returns: CRMScript.NetServer.NSAttachmentEntity Example:

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

GetAttachmentInfo(Integer)

Gets a list with meta data for all attached attachments

NSAttachmentEntity[] GetAttachmentInfo(Integer ticketMessageEntityId)

Returns: CRMScript.NetServer.NSAttachmentEntity[] Example:

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

GetAttachmentStream(Integer)

Gets the content of an attachment

NSStream GetAttachmentStream(Integer attachmentId)

Returns: CRMScript.NetServer.NSStream Example:

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

GetTicket(Integer)

Gets an NSTicket object.

NSTicket GetTicket(Integer ticketId)

Returns: CRMScript.NetServer.NSTicket Example:

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

GetTicketAttachments(Integer)

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

NSAttachmentEntity[] GetTicketAttachments(Integer ticketEntityId)

Returns: CRMScript.NetServer.NSAttachmentEntity[] Example:

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

GetTicketEntity(Integer)

Gets an NSTicketEntity object.

NSTicketEntity GetTicketEntity(Integer ticketEntityId)

Returns: CRMScript.NetServer.NSTicketEntity Example:

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

GetTicketMessage(Integer)

Gets an NSTicketMessage object.

NSTicketMessage GetTicketMessage(Integer ticketMessageId)

Returns: CRMScript.NetServer.NSTicketMessage Example:

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

GetTicketMessageEntity(Integer)

Gets an NSTicketMessageEntity object.

NSTicketMessageEntity GetTicketMessageEntity(Integer ticketMessageEntityId)

Returns: CRMScript.NetServer.NSTicketMessageEntity Example:

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

GetTickets(Integer[])

Gets multiple tickets

NSTicket[] GetTickets(Integer[] ticketIds)

Returns: CRMScript.NetServer.NSTicket[] Example:

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

Html2Text(String)

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

String Html2Text(String content)

Returns: CRMScript.Global.String Example:

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

NotifyNewTicket(Integer)

Notifies user agents about the creation of a new ticket

Void NotifyNewTicket(Integer ticketEntityId)

Returns: CRMScript.Global.Void Example:

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

NotifyNewTicketMessage(Integer)

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

Void NotifyNewTicketMessage(Integer ticketEntityId)

Returns: CRMScript.Global.Void Example:

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

SanitizeMailContent(String)

Removes harmful HTML tags and attributes from an email

String SanitizeMailContent(String content)

Returns: CRMScript.Global.String Example:

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

SanitizeMailContents(String[])

Removes harmful HTML tags and attributes from an email

String[] SanitizeMailContents(String[] contents)

Returns: CRMScript.Global.String[] Example:

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

SaveAttachmentEntity(NSAttachmentEntity)

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

NSAttachmentEntity SaveAttachmentEntity(NSAttachmentEntity attachmentEntity)

Returns: CRMScript.NetServer.NSAttachmentEntity Example:

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

SaveTicketEntity(NSTicketEntity)

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

NSTicketEntity SaveTicketEntity(NSTicketEntity ticketEntity)

Returns: CRMScript.NetServer.NSTicketEntity Example:

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

SaveTicketMessageEntity(NSTicketMessageEntity)

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

NSTicketMessageEntity SaveTicketMessageEntity(NSTicketMessageEntity ticketMessageEntity)

Returns: CRMScript.NetServer.NSTicketMessageEntity Example:

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

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

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

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

Returns: CRMScript.Global.Void Example:

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);

SetTicketMessageImportant(Integer,Bool)

Sets the important flag on or off for a ticket message

Void SetTicketMessageImportant(Integer ticketMessageId, Bool important)

Returns: CRMScript.Global.Void

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

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

Returns: CRMScript.NetServer.NSTicketEntity Example:

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

UploadAttachment(Integer,NSStream)

Uploads an attachment and returns the attachment ID

Integer UploadAttachment(Integer attachmentId, NSStream content)

Returns: CRMScript.Global.Integer

​Constructors

​NSTicketAgent()

​Methods

​AddAttachments(Integer,Integer[])

​CreateDefaultAttachmentEntity()

​CreateDefaultTicketEntity()

​CreateDefaultTicketMessageEntity()

​DeleteTicketEntity(Integer)

​DeleteTicketMessageEntity(Integer)

​GetAttachmentEntity(Integer)

​GetAttachmentInfo(Integer)

​GetAttachmentStream(Integer)

​GetTicket(Integer)

​GetTicketAttachments(Integer)

​GetTicketEntity(Integer)

​GetTicketMessage(Integer)

​GetTicketMessageEntity(Integer)

​GetTickets(Integer[])

​Html2Text(String)

​NotifyNewTicket(Integer)

​NotifyNewTicketMessage(Integer)

​SanitizeMailContent(String)

​SanitizeMailContents(String[])

​SaveAttachmentEntity(NSAttachmentEntity)

​SaveTicketEntity(NSTicketEntity)

​SaveTicketMessageEntity(NSTicketMessageEntity)

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

​SetTicketMessageImportant(Integer,Bool)

​SetTicketReadByOwner(Integer,Integer,Bool)

​UploadAttachment(Integer,NSStream)

Constructors

NSTicketAgent()

Methods

AddAttachments(Integer,Integer[])

CreateDefaultAttachmentEntity()

CreateDefaultTicketEntity()

CreateDefaultTicketMessageEntity()

DeleteTicketEntity(Integer)

DeleteTicketMessageEntity(Integer)

GetAttachmentEntity(Integer)

GetAttachmentInfo(Integer)

GetAttachmentStream(Integer)

GetTicket(Integer)

GetTicketAttachments(Integer)

GetTicketEntity(Integer)

GetTicketMessage(Integer)

GetTicketMessageEntity(Integer)

GetTickets(Integer[])

Html2Text(String)

NotifyNewTicket(Integer)

NotifyNewTicketMessage(Integer)

SanitizeMailContent(String)

SanitizeMailContents(String[])

SaveAttachmentEntity(NSAttachmentEntity)

SaveTicketEntity(NSTicketEntity)

SaveTicketMessageEntity(NSTicketMessageEntity)

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

SetTicketMessageImportant(Integer,Bool)

SetTicketReadByOwner(Integer,Integer,Bool)

UploadAttachment(Integer,NSStream)