Difference between revisions of "RoleExtensionRoleParameter class"

From Catglobe Wiki
Jump to: navigation, search
(Created page with "{{CGscriptClass_Template |Name=<nowiki>RoleExtensionRoleParameter</nowiki> |Description=<nowiki>Parameters for executing a role extension</nowiki> |Methods= {{CGscriptMethods_...")
 
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
|Name=<nowiki>RoleExtensionRoleParameter</nowiki>
 
|Name=<nowiki>RoleExtensionRoleParameter</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=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=Array of numbers|Name=<nowiki>RoleResourceIds</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>List of roles to change/query.</nowiki>}}
+
{{CGscriptProperties_Template|ReturnType=Array of ints|Name=<nowiki>RoleResourceIds</nowiki>|HasGetter=1|HasSetter=1|Description=<nowiki>List of roles to change/query.</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 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]]

Latest revision as of 11:52, 19 December 2019

RoleExtensionRoleParameter


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

  • 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.
  • Array of int RoleResourceIds { get; set; } - List of roles to change/query.
  • (From object) TypeInformation TypeInformation { get; } - Get information about this class.
  • (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.