Difference between revisions of "NavigationAccessHelper class"
Nguyenduyan (talk | contribs) (Created page with "{{CGscriptClass_Template |Name=NavigationAccessHelper |Description=Class to manipulate navigation access |Constructors= {{CGscriptConstructors_Template|Description=Instanciate...") |
|||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
| − | |Name=NavigationAccessHelper | + | |Name=<nowiki>NavigationAccessHelper</nowiki> |
| − | |Description= | + | |Description=<nowiki>Helper class to fetch navigation access</nowiki> |
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
| − | {{CGscriptConstructors_Template|Description=Instanciate new helper}} | + | {{CGscriptConstructors_Template|Description=<nowiki>Instanciate new helper</nowiki>}} |
|Methods= | |Methods= | ||
| − | {{CGscriptMethods_Template|ReturnType=Array of strings|Name=AllAvailableNavigationAccess|Description=Get names of all navigation access in the system}} | + | {{CGscriptMethods_Template|ReturnType=Array of strings|Name=<nowiki>AllAvailableNavigationAccess</nowiki>|Description=<nowiki>Get names of all navigation access in the system</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=Array of strings|Name=AllNavigationAccessWithAccess|Description=Get names of all navigation access the current user has access to in the system}} | + | {{CGscriptMethods_Template|ReturnType=Array of strings|Name=<nowiki>AllNavigationAccessWithAccess</nowiki>|Description=<nowiki>Get names of all navigation access the current user has access to in the system</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=bool|Name=HasNavigationAccess|Parameters= | + | {{CGscriptMethods_Template|ReturnType=bool|Name=<nowiki>HasNavigationAccess</nowiki>|Parameters= |
| − | {{CGscriptParameters_Template|Type=string|Name=navigationAccessName|Description=Name of the nav access to check}} | + | {{CGscriptParameters_Template|Type=string|Name=<nowiki>navigationAccessName</nowiki>|Description=<nowiki>Name of the nav access to check</nowiki>}} |
| − | |Description=Check if the current user has access to a specific navigation access}} | + | |Description=<nowiki>Check if the current user has access to a specific navigation access</nowiki>}} |
| − | {{CGscriptMethods_Template|ReturnType=string|Name=ToString|Description=The string representation of the object.}} | + | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} |
|Properties= | |Properties= | ||
| − | {{CGscriptProperties_Template|ReturnType=string|Name=ObjectTypeName|HasGetter=1|Description=The name of the type of object.}} | + | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} |
| − | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=TypeInformation|HasGetter=1|Description=Get information about this class.}} | + | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} |
}} | }} | ||
| + | |||
| + | === <span style="color:#DF8621">'''Examples'''</span> === | ||
| + | |||
| + | <source lang="javascript"> | ||
| + | NavigationAccessHelper nav = new NavigationAccessHelper(); | ||
| + | print(nav.AllAvailableNavigationAccess()); | ||
| + | print(nav.AllNavigationAccessWithAccess()); | ||
| + | print(nav.HasNavigationAccess("Questionnaire_Search")); | ||
| + | </source> | ||
Latest revision as of 06:03, 2 July 2020
Helper class to fetch navigation access
Parent class
Inherits from object
Constructors
- () - Instanciate new helper
Methods
- Array of string AllAvailableNavigationAccess() - Get names of all navigation access in the system
- Array of string AllNavigationAccessWithAccess() - Get names of all navigation access the current user has access to in the system
- bool HasNavigationAccess(string navigationAccessName "Name of the nav access to check") - Check if the current user has access to a specific navigation access
- (From object) string ToString() - The string representation of the object.
Properties
- string ObjectTypeName { get; } - The name of the type of object.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
Examples
NavigationAccessHelper nav = new NavigationAccessHelper();
print(nav.AllAvailableNavigationAccess());
print(nav.AllNavigationAccessWithAccess());
print(nav.HasNavigationAccess("Questionnaire_Search"));
