RoleExtensionEventDocumentation class: Difference between revisions
From Catglobe Wiki
More actions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{CGscriptClass_Template | {{CGscriptClass_Template | ||
|Name=<nowiki> | |Name=<nowiki>RoleExtensionDocumentation</nowiki> | ||
|Description=<nowiki>Documents | |Description=<nowiki>Documents how a given role extension can be called</nowiki> | ||
|InheritsFrom= | |InheritsFrom=object|Methods= | ||
|Methods= | |||
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} | {{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Inherited=object|Description=<nowiki>The string representation of the object.</nowiki>}} | ||
|Properties= | |Properties= | ||
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>Description</nowiki>|HasGetter=1 | {{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>Description</nowiki>|HasGetter=1|Description=<nowiki>A short description of the functionality for an admin user to better understand what it actually does.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IncludeChildrenInPath</nowiki>|HasGetter=1|HasSetter=1 | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>IncludeChildrenInPath</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If true and LimitToPath is set, then LimitToPath applies to any role with the path as prefix. Default is false.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>LimitToPath</nowiki>|HasGetter=1|HasSetter=1 | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>LimitToPath</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If set, only roles in a given path are applicable for this role extensions. Default is Empty.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>Name</nowiki>|HasGetter=1 | {{CGscriptProperties_Template|ReturnType=LocalizedString|Name=<nowiki>Name</nowiki>|HasGetter=1|Description=<nowiki>The name of the functionality for an admin user to see.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Description=<nowiki>The name of the type of object.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ObjectTypeName</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>The name of the type of object.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=Array of RoleExtensionParameterDocumentation|Name=<nowiki>Parameters</nowiki>|HasGetter=1|HasSetter=1 | {{CGscriptProperties_Template|ReturnType=Array of RoleExtensionParameterDocumentation|Name=<nowiki>Parameters</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Documentation for possible parameters.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PathIsRelative</nowiki>|HasGetter=1|HasSetter=1 | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>PathIsRelative</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If true, the path is a postfix on the Top level parent that the role extension is defined on. Default is true.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>PermissionRequired</nowiki>|HasGetter=1|HasSetter=1 | {{CGscriptProperties_Template|ReturnType=int|Name=<nowiki>PermissionRequired</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Minimum access required on a user/role to be able to do it's function: 2 = needs read access, 4 = write access, 6 = full access. Default is 4.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=Array of RoleExtensionQueryValueDocumentation|Name=<nowiki>Result</nowiki>|HasGetter=1|HasSetter=1 | {{CGscriptProperties_Template|ReturnType=Array of RoleExtensionQueryValueDocumentation|Name=<nowiki>Result</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Documentation for return value of calling the script.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowResultInGrid</nowiki>|HasGetter=1|HasSetter=1 | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>ShowResultInGrid</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If true, values returned by this script in query mode is suitable to be shown in the user/role grid, no parameters are allowed if true. Default is true.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=<nowiki>TypeInformation</nowiki>|HasGetter=1|Inherited=object|Description=<nowiki>Get information about this class.</nowiki>}} | ||
}} | }} | ||
[[Category:Roles]] | [[Category:Roles]] | ||
Revision as of 07:22, 2 July 2020
RoleExtensionDocumentation
Documents how a given role extension can be called
Parent class
Inherits from object
Methods
- (From object) string ToString() - The string representation of the object.
Properties
- LocalizedString Description { get; } - A short description of the functionality for an admin user to better understand what it actually does.
- bool IncludeChildrenInPath { get; set; } - If true and LimitToPath is set, then LimitToPath applies to any role with the path as prefix. Default is false.
- string LimitToPath { get; set; } - If set, only roles in a given path are applicable for this role extensions. Default is Empty.
- LocalizedString Name { get; } - The name of the functionality for an admin user to see.
- (From object) string ObjectTypeName { get; } - The name of the type of object.
- Array of RoleExtensionParameterDocumentation Parameters { get; set; } - Documentation for possible parameters.
- bool PathIsRelative { get; set; } - If true, the path is a postfix on the Top level parent that the role extension is defined on. Default is true.
- int PermissionRequired { get; set; } - Minimum access required on a user/role to be able to do it's function: 2 = needs read access, 4 = write access, 6 = full access. Default is 4.
- Array of RoleExtensionQueryValueDocumentation Result { get; set; } - Documentation for return value of calling the script.
- bool ShowResultInGrid { get; set; } - If true, values returned by this script in query mode is suitable to be shown in the user/role grid, no parameters are allowed if true. Default is true.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.