RoleExtensionUserDocumentation class - Revision history

Administrator at 07:57, 2 July 2020

2020-07-02T07:57:16Z

Administrator at 06:23, 19 December 2019

2019-12-19T06:23:02Z

← Older revision		Revision as of 06:23, 19 December 2019
Line 20:		Line 20:
	{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=TypeInformation\|Name=<nowiki>TypeInformation</nowiki>\|HasGetter=1\|Description=<nowiki>Get information about this class.</nowiki>}}
	}}		}}
			[[Category:Roles]]

Administrator: Created page with "{{CGscriptClass_Template |Name=RoleExtensionUserDocumentation |Description=Documents how a given role extension can be called on a list users..."

2019-12-19T06:22:47Z

Created page with "{{CGscriptClass_Template |Name=<nowiki>RoleExtensionUserDocumentation</nowiki> |Description=<nowiki>Documents how a given role extension can be called on a list users</nowiki>..."

New page

{{CGscriptClass_Template
|Name=<nowiki>RoleExtensionUserDocumentation</nowiki>
|Description=<nowiki>Documents how a given role extension can be called on a list users</nowiki>
|Constructors=
{{CGscriptConstructors_Template|Description=<nowiki>Make new documentation</nowiki>}}
|Methods=
{{CGscriptMethods_Template|ReturnType=string|Name=<nowiki>ToString</nowiki>|Description=<nowiki>The string representation of the object.</nowiki>}}
|Properties=
{{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|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=bool|Name=<nowiki>InformsUsers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If true, this script will send a notification to the user about the change. Default is false.</nowiki>}}
{{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|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=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|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|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|Description=<nowiki>Documentation for return value of calling the script.</nowiki>}}
{{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|Description=<nowiki>Get information about this class.</nowiki>}}
}}

← Older revision		Revision as of 07:57, 2 July 2020
Line 2:		Line 2:
	\|Name=<nowiki>RoleExtensionUserDocumentation</nowiki>		\|Name=<nowiki>RoleExtensionUserDocumentation</nowiki>
	\|Description=<nowiki>Documents how a given role extension can be called on a list users</nowiki>		\|Description=<nowiki>Documents how a given role extension can be called on a list users</nowiki>
	\|Constructors=		\|InheritsFrom=RoleExtensionDocumentation\|Constructors=
	{{CGscriptConstructors_Template\|Description=<nowiki>Make new documentation</nowiki>}}		{{CGscriptConstructors_Template\|Description=<nowiki>Make new documentation</nowiki>}}
	\|Methods=		\|Methods=
	{{CGscriptMethods_Template\|ReturnType=string\|Name=<nowiki>ToString</nowiki>\|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\|Description=<nowiki>A short description of the functionality for an admin user to better understand what it actually does.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=LocalizedString\|Name=<nowiki>Description</nowiki>\|HasGetter=1\|Inherited=RoleExtensionDocumentation\|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\|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=bool\|Name=<nowiki>IncludeChildrenInPath</nowiki>\|HasGetter=1\|HasSetter=1\|Inherited=RoleExtensionDocumentation\|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=bool\|Name=<nowiki>InformsUsers</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>If true, this script will send a notification to the user about the change. Default is false.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=bool\|Name=<nowiki>InformsUsers</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>If true, this script will send a notification to the user about the change. Default is false.</nowiki>}}
	{{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=string\|Name=<nowiki>LimitToPath</nowiki>\|HasGetter=1\|HasSetter=1\|Inherited=RoleExtensionDocumentation\|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\|Description=<nowiki>The name of the functionality for an admin user to see.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=LocalizedString\|Name=<nowiki>Name</nowiki>\|HasGetter=1\|Inherited=RoleExtensionDocumentation\|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\|Description=<nowiki>The name of the type of object.</nowiki>}}
	{{CGscriptProperties_Template\|ReturnType=Array of RoleExtensionParameterDocumentation\|Name=<nowiki>Parameters</nowiki>\|HasGetter=1\|HasSetter=1\|Description=<nowiki>Documentation for possible parameters.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=Array of RoleExtensionParameterDocumentation\|Name=<nowiki>Parameters</nowiki>\|HasGetter=1\|HasSetter=1\|Inherited=RoleExtensionDocumentation\|Description=<nowiki>Documentation for possible parameters.</nowiki>}}
	{{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=bool\|Name=<nowiki>PathIsRelative</nowiki>\|HasGetter=1\|HasSetter=1\|Inherited=RoleExtensionDocumentation\|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\|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=int\|Name=<nowiki>PermissionRequired</nowiki>\|HasGetter=1\|HasSetter=1\|Inherited=RoleExtensionDocumentation\|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\|Description=<nowiki>Documentation for return value of calling the script.</nowiki>}}		{{CGscriptProperties_Template\|ReturnType=Array of RoleExtensionQueryValueDocumentation\|Name=<nowiki>Result</nowiki>\|HasGetter=1\|HasSetter=1\|Inherited=RoleExtensionDocumentation\|Description=<nowiki>Documentation for return value of calling the script.</nowiki>}}
	{{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=bool\|Name=<nowiki>ShowResultInGrid</nowiki>\|HasGetter=1\|HasSetter=1\|Inherited=RoleExtensionDocumentation\|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\|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]]