Difference between revisions of "RoleExtensionUserParameter class"
(Tag: visualeditor) |
|||
| Line 2: | Line 2: | ||
|Name=<nowiki>RoleExtensionUserParameter</nowiki> | |Name=<nowiki>RoleExtensionUserParameter</nowiki> | ||
|Description=<nowiki>Parameters for executing a role extension</nowiki> | |Description=<nowiki>Parameters for executing a role extension</nowiki> | ||
| − | |Methods= | + | |InheritsFrom=RoleExtensionParameter|Methods= |
| − | {{CGscriptMethods_Template|ReturnType=RoleExtensionReturn|Name=<nowiki>Execute</nowiki>|Description=<nowiki>Execute call to the role extesion. If called inside a role extension the base/parent version is called if any. May return Empty.</nowiki>}} | + | {{CGscriptMethods_Template|ReturnType=RoleExtensionReturn|Name=<nowiki>Execute</nowiki>|Inherited=RoleExtensionParameter|Description=<nowiki>Execute call to the role extesion. If called inside a role extension the base/parent version is called if any. May return Empty.</nowiki>}} |
| − | {{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=bool|Name=<nowiki>InformUsers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If false, this script should avoid informing the user directly about the change. Default is true. Ignored if ReturnIfToggled is true.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>InformUsers</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If false, this script should avoid informing the user directly about the change. Default is true. Ignored if ReturnIfToggled is true.</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|Name=<nowiki>Parameters</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Parameters if any. Must match the ordering of the documentation.</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=array|Name=<nowiki>Parameters</nowiki>|HasGetter=1|HasSetter=1|Inherited=RoleExtensionParameter|Description=<nowiki>Parameters if any. Must match the ordering of the documentation.</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>}} |
{{CGscriptProperties_Template|ReturnType=Array of User|Name=<nowiki>Users</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>List of users to change/query.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=Array of User|Name=<nowiki>Users</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>List of users to change/query.</nowiki>}} | ||
| − | {{CGscriptProperties_Template|ReturnType=Array of Array|Name=<nowiki>WriteableValues</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Update values per user/role. Must match the ordering of the return documentation for the writeable values. May be empty for querying, or each element may be empty if not updating.</nowiki>}} | + | {{CGscriptProperties_Template|ReturnType=Array of Array|Name=<nowiki>WriteableValues</nowiki>|HasGetter=1|HasSetter=1|Inherited=RoleExtensionParameter|Description=<nowiki>Update values per user/role. Must match the ordering of the return documentation for the writeable values. May be empty for querying, or each element may be empty if not updating.</nowiki>}} |
}} | }} | ||
[[Category:Roles]] | [[Category:Roles]] | ||
Latest revision as of 08:24, 2 July 2020
RoleExtensionUserParameter
Parameters for executing a role extension
Parent class
Inherits from RoleExtensionParameter
Methods
- (From RoleExtensionParameter) RoleExtensionReturn Execute() - Execute call to the role extesion. If called inside a role extension the base/parent version is called if any. May return Empty.
- (From object) string ToString() - The string representation of the object.
Properties
- bool InformUsers { get; set; } - If false, this script should avoid informing the user directly about the change. Default is true. Ignored if ReturnIfToggled is true.
- string ObjectTypeName { get; } - The name of the type of object.
- (From RoleExtensionParameter) array Parameters { get; set; } - Parameters if any. Must match the ordering of the documentation.
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
- Array of User Users { get; set; } - List of users to change/query.
- (From RoleExtensionParameter) Array of Array WriteableValues { get; set; } - Update values per user/role. Must match the ordering of the return documentation for the writeable values. May be empty for querying, or each element may be empty if not updating.
