Difference between revisions of "RoleExtensionReturn class"
(Tag: visualeditor) |
|||
| Line 2: | Line 2: | ||
|Name=<nowiki>RoleExtensionReturn</nowiki> | |Name=<nowiki>RoleExtensionReturn</nowiki> | ||
|Description=<nowiki>Return result for executing a role extension</nowiki> | |Description=<nowiki>Return result for executing a role extension</nowiki> | ||
| − | |Constructors= | + | |InheritsFrom=object|Constructors= |
{{CGscriptConstructors_Template|Description=<nowiki>Make new return result holder</nowiki>}} | {{CGscriptConstructors_Template|Description=<nowiki>Make new return result holder</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=string|Name=<nowiki>ErrorMessage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If not success, this contains the error message. If empty, errormessages per user is in the result array.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=string|Name=<nowiki>ErrorMessage</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>If not success, this contains the error message. If empty, errormessages per user is in the result array.</nowiki>}} | ||
| Line 11: | Line 11: | ||
{{CGscriptProperties_Template|ReturnType=Array of Array|Name=<nowiki>Result</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Any result returned from the script, the order and length of each must match the original Users/Role array.</nowiki>}} | {{CGscriptProperties_Template|ReturnType=Array of Array|Name=<nowiki>Result</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Any result returned from the script, the order and length of each must match the original Users/Role array.</nowiki>}} | ||
{{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Success</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Did the script complete successful?</nowiki>}} | {{CGscriptProperties_Template|ReturnType=bool|Name=<nowiki>Success</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>Did the script complete successful?</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]] | ||
Latest revision as of 09:33, 2 July 2020
RoleExtensionReturn
Return result for executing a role extension
Parent class
Inherits from object
Constructors
- () - Make new return result holder
Methods
- (From object) string ToString() - The string representation of the object.
Properties
- string ErrorMessage { get; set; } - If not success, this contains the error message. If empty, errormessages per user is in the result array.
- string ObjectTypeName { get; } - The name of the type of object.
- Array of Array Result { get; set; } - Any result returned from the script, the order and length of each must match the original Users/Role array.
- bool Success { get; set; } - Did the script complete successful?
- (From object) TypeInformation TypeInformation { get; } - Get information about this class.
