Class NSTicketCategoryEntity
Describes the meta data for a ticket category, and provides special operations on it.
Constructors
NSTicketCategoryEntity()
Initializes a new instance of the NSTicketCategoryEntity class.
Declaration
NSTicketCategoryEntityMethods
GetAssignmentLag()
Declaration
Integer GetAssignmentLag()Examples
NSTicketCategoryEntity thing;
Integer assignmentLag = thing.GetAssignmentLag();Returns
| Type | Description |
| Integer | Number of minutes we shall override the assignment if a customer sends consecutive messages to this category. |
GetCategoryMaster()
Declaration
Integer GetCategoryMaster()Examples
NSTicketCategoryEntity thing;
Integer categoryMaster = thing.GetCategoryMaster();Returns
| Type | Description |
| Integer | The user associated with this category. |
GetClosingStatus()
Declaration
Integer GetClosingStatus()Examples
NSTicketCategoryEntity thing;
Integer closingStatus = thing.GetClosingStatus();Returns
| Type | Description |
| Integer | Should new requests have the 'close request' in this category checked as default, or should the users preferences be selected? See <xref href="CRMScript.NetServer.TicketCategoryClosingStatus" data-throw-if-not-resolved="false"></xref> |
GetCustomFields()
Gets the user-defined + extra fields on an NSTicketCategoryEntity as a map.
Declaration
Map GetCustomFields()Examples
NSTicketCategoryEntity 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());Returns
| Type | Description |
| Map |
GetDelegateMethod()
Declaration
Integer GetDelegateMethod()Examples
NSTicketCategoryEntity thing;
Integer delegateMethod = thing.GetDelegateMethod();Returns
| Type | Description |
| Integer | An integer indicating the delegation method for this category. See <xref href="CRMScript.NetServer.TicketCategoryDelegateMethod" data-throw-if-not-resolved="false"></xref>. |
GetExternalName()
Declaration
String GetExternalName()Examples
NSTicketCategoryEntity thing;
String externalName = thing.GetExternalName();Returns
| Type | Description |
| String | The external name for this category, used for the customer frontend. |
GetExtraFields()
Gets the extra fields on NSTicketCategoryEntity as a map.
Declaration
Map GetExtraFields()Examples
NSTicketCategoryEntity 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());Returns
| Type | Description |
| Map | Map containing extra field values by field name. |
GetFlags()
Declaration
Integer GetFlags()Examples
NSTicketCategoryEntity thing;
Integer flags = thing.GetFlags();Returns
| Type | Description |
| Integer | A bitmask representing flags for this category. See <xref href="CRMScript.NetServer.TicketCategoryFlags" data-throw-if-not-resolved="false"></xref>. |
GetFullname()
Declaration
String GetFullname()Examples
NSTicketCategoryEntity thing;
String fullname = thing.GetFullname();Returns
| Type | Description |
| String | The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'. |
GetMsgClosingStatus()
Declaration
Integer GetMsgClosingStatus()Examples
NSTicketCategoryEntity thing;
Integer msgClosingStatus = thing.GetMsgClosingStatus();Returns
| Type | Description |
| Integer | Should new messages have the 'close request' in this category checked as default, or should the users preferences be selected? See <xref href="CRMScript.NetServer.TicketCategoryClosingStatus" data-throw-if-not-resolved="false"></xref>. |
GetName()
Declaration
String GetName()Examples
NSTicketCategoryEntity thing;
String name = thing.GetName();Returns
| Type | Description |
| String | The (short) name of this category. E.g. 'support'. |
GetNotificationEmail()
Declaration
String GetNotificationEmail()Examples
NSTicketCategoryEntity thing;
String notificationEmail = thing.GetNotificationEmail();Returns
| Type | Description |
| String | Comma-separated list of addresses to notify when requests are re-delegated to (unassigned) in this category. |
GetParentId()
Declaration
Integer GetParentId()Examples
NSTicketCategoryEntity thing;
Integer parentId = thing.GetParentId();Returns
| Type | Description |
| Integer | The parent category for this category. -1 if this is a top-level category. |
GetReplyTemplate()
Declaration
Integer GetReplyTemplate()Examples
NSTicketCategoryEntity thing;
Integer replyTemplate = thing.GetReplyTemplate();Returns
| Type | Description |
| Integer | Reply template to merge with messages posted in this category. |
GetTicketCategoryId()
Declaration
Integer GetTicketCategoryId()Examples
NSTicketCategoryEntity thing;
Integer ticketCategoryId = thing.GetTicketCategoryId();Returns
| Type | Description |
| Integer | The ID of the ticket category. (primary key). |
SetAssignmentLag(Integer)
Declaration
Void SetAssignmentLag(Integer assignmentLag)Examples
NSTicketCategoryEntity thing;
Integer assignmentLag;
thing.SetAssignmentLag(assignmentLag);Parameters
| Type | Name | Description |
| Integer | assignmentLag | Number of minutes we shall override the assignment if a customer sends consecutive messages to this category. |
Returns
| Type | Description |
| Void |
SetCategoryMaster(Integer)
Declaration
Void SetCategoryMaster(Integer categoryMaster)Examples
NSTicketCategoryEntity thing;
Integer categoryMaster;
thing.SetCategoryMaster(categoryMaster);Parameters
| Type | Name | Description |
| Integer | categoryMaster | The user associated with this category. |
Returns
| Type | Description |
| Void |
SetClosingStatus(Integer)
Declaration
Void SetClosingStatus(Integer closingStatus)Examples
NSTicketCategoryEntity thing;
Integer closingStatus;
thing.SetClosingStatus(closingStatus);Parameters
| Type | Name | Description |
| Integer | closingStatus | Should new requests have the 'close request' in this category checked as default, or should the users preferences be selected. See <xref href="CRMScript.NetServer.TicketCategoryClosingStatus" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetCustomFields(Map)
Sets the user-defined and extra fields on an NSTicketCategoryEntity with a map.
Declaration
Void SetCustomFields(Map udefs)Examples
NSTicketCategoryEntity 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);Parameters
| Type | Name | Description |
| Map | udefs |
Returns
| Type | Description |
| Void |
SetDelegateMethod(Integer)
Declaration
Void SetDelegateMethod(Integer delegateMethod)Examples
NSTicketCategoryEntity thing;
Integer delegateMethod;
thing.SetDelegateMethod(delegateMethod);Parameters
| Type | Name | Description |
| Integer | delegateMethod | An integer indicating the delegation method for this category. See <xref href="CRMScript.NetServer.TicketCategoryDelegateMethod" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetExternalName(String)
Declaration
Void SetExternalName(String externalName)Examples
NSTicketCategoryEntity thing;
String externalName;
thing.SetExternalName(externalName);Parameters
| Type | Name | Description |
| String | externalName | The external name for this category, used for the customer frontend. |
Returns
| Type | Description |
| Void |
SetExtraFields(Map)
Sets the extra field values on NSTicketCategoryEntity with a map.
Declaration
Void SetExtraFields(Map extras)Examples
NSTicketCategoryEntity 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);Parameters
| Type | Name | Description |
| Map | extras |
Returns
| Type | Description |
| Void |
SetFlags(Integer)
Declaration
Void SetFlags(Integer flags)Examples
NSTicketCategoryEntity thing;
Integer flags;
thing.SetFlags(flags);Parameters
| Type | Name | Description |
| Integer | flags | A bitmask representing flags for this category. See <xref href="CRMScript.NetServer.TicketCategoryFlags" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetFullname(String)
Declaration
Void SetFullname(String fullname)Examples
NSTicketCategoryEntity thing;
String fullname;
thing.SetFullname(fullname);Parameters
| Type | Name | Description |
| String | fullname | The fullname (compiled from parents' names) for this category. E.g. 'norway/product A/support'. |
Returns
| Type | Description |
| Void |
SetMsgClosingStatus(Integer)
Declaration
Void SetMsgClosingStatus(Integer msgClosingStatus)Examples
NSTicketCategoryEntity thing;
Integer msgClosingStatus;
thing.SetMsgClosingStatus(msgClosingStatus);Parameters
| Type | Name | Description |
| Integer | msgClosingStatus | Should new messages have the 'close request' in this category checked as default, or should the users preferences be selected? See <xref href="CRMScript.NetServer.TicketCategoryClosingStatus" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSTicketCategoryEntity thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | The (short) name of this category. E.g. 'support'. |
Returns
| Type | Description |
| Void |
SetNotificationEmail(String)
Declaration
Void SetNotificationEmail(String notificationEmail)Examples
NSTicketCategoryEntity thing;
String notificationEmail;
thing.SetNotificationEmail(notificationEmail);Parameters
| Type | Name | Description |
| String | notificationEmail | Comma-separated list of addresses to notify when requests are re-delegated to (unassigned) in this category. |
Returns
| Type | Description |
| Void |
SetParentId(Integer)
Declaration
Void SetParentId(Integer parentId)Examples
NSTicketCategoryEntity thing;
Integer parentId;
thing.SetParentId(parentId);Parameters
| Type | Name | Description |
| Integer | parentId | The parent category for this category. -1 if this is a top-level category. |
Returns
| Type | Description |
| Void |
SetReplyTemplate(Integer)
Declaration
Void SetReplyTemplate(Integer replyTemplate)Examples
NSTicketCategoryEntity thing;
Integer replyTemplate;
thing.SetReplyTemplate(replyTemplate);Parameters
| Type | Name | Description |
| Integer | replyTemplate | Reply template to merge with messages posted in this category. |
Returns
| Type | Description |
| Void |
SetTicketCategoryId(Integer)
Declaration
Void SetTicketCategoryId(Integer ticketCategoryId)Examples
NSTicketCategoryEntity thing;
Integer ticketCategoryId;
thing.SetTicketCategoryId(ticketCategoryId);Parameters
| Type | Name | Description |
| Integer | ticketCategoryId | The ID of the ticket category. (primary key). |
Returns
| Type | Description |
| Void |