Class NSSentryAgent
Data and function right queries.
Syntax
Examples
NSSentryAgent agent;
agent.callMethod(arg1, arg2);Constructors
NSSentryAgent()
Data and function right queries.
Introduced or updated in version: 7
Declaration
NSSentryAgentExamples
NSSentryAgent agent;
agent.callMethod(arg1, arg2);Methods
CanCreateAppointmentInAllDiaries()
Checks if the current associate can create appointments in diaries belonging all other associates. It checks only against associates that are diary owners.
Introduced or updated in version: 7
Declaration
Bool CanCreateAppointmentInAllDiaries()Returns
| Type | Description |
|---|---|
| Bool |
Examples
NSSentryAgent agent;
Bool res = agent.CanCreateAppointmentInAllDiaries();CanCreateAppointmentInAssociateDiaries(Integer[])
Checks if the current associate can create appointments in diaries belonging to the associates listed in associateIds. Checks only against associates that are diary owners.
Introduced or updated in version: 7
Declaration
Bool CanCreateAppointmentInAssociateDiaries(Integer[] associateIds)Parameters
| Type | Name | Description |
|---|---|---|
| Integer[] | associateIds |
Returns
| Type | Description |
|---|---|
| Bool | If none of the associates listed in the associateIds parameter is a diary owner, the method will return true. |
Examples
NSSentryAgent agent;
Integer[] associateIds;
Bool res = agent.CanCreateAppointmentInAssociateDiaries(associateIds);GetFunctionRights()
Gets a string array of all functions rights for the role of the current associate.
Introduced or updated in version: 7
Declaration
String[] GetFunctionRights()Returns
| Type | Description |
|---|---|
| String[] |
Examples
NSSentryAgent agent;
String[] res = agent.GetFunctionRights();GetNewTableRight(String)
Returns an NSTableRight for a new row based on tableName parameter.
Introduced or updated in version: 7
Declaration
NSTableRight GetNewTableRight(String tableName)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName |
Returns
| Type | Description |
|---|---|
| NSTableRight |
Examples
NSSentryAgent agent;
String tableName;
NSTableRight res = agent.GetNewTableRight(tableName);GetTableRightByContactOwnership(String,Integer)
Return the NSTableRight from the relationship between the current user and the given user and group.
Introduced or updated in version: 7
Declaration
NSTableRight GetTableRightByContactOwnership(String tableName, Integer contactId)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer | contactId |
Returns
| Type | Description |
|---|---|
| NSTableRight |
Examples
NSSentryAgent agent;
String tableName;
Integer contactId;
NSTableRight res = agent.GetTableRightByContactOwnership(tableName, contactId);GetTableRightByOwnership(String,Integer,Integer)
Return the NSTableRight from the relationship between the current user and the given user and group.
Introduced or updated in version: 7
Declaration
NSTableRight GetTableRightByOwnership(String tableName, Integer contactGroupId, Integer contactAssociateId)Parameters
| Type | Name | Description |
|---|---|---|
| String | tableName | |
| Integer | contactGroupId | |
| Integer | contactAssociateId |
Returns
| Type | Description |
|---|---|
| NSTableRight |
Examples
NSSentryAgent agent;
String tableName;
Integer contactGroupId;
Integer contactAssociateId;
NSTableRight res = agent.GetTableRightByOwnership(tableName, contactGroupId, contactAssociateId);HasFunctionRight(String)
Gets a boolean value indicating if the current user has the functional right.
Introduced or updated in version: 7
Declaration
Bool HasFunctionRight(String functionRight)Parameters
| Type | Name | Description |
|---|---|---|
| String | functionRight |
Returns
| Type | Description |
|---|---|
| Bool |