Toggle menu
862
3.8K
30.2K
279.1K
Catglobe Wiki
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

RoleExtensionUserParameter class: Difference between revisions

From Catglobe Wiki
Created page with "{{CGscriptClass_Template |Name=<nowiki>RoleExtensionUserParameter</nowiki> |Description=<nowiki>Parameters for executing a role extension</nowiki> |Methods= {{CGscriptMethods_..."
 
No edit summary
Line 13: Line 13:
{{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|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]]

Revision as of 06:46, 19 December 2019

RoleExtensionUserParameter



Parameters for executing a role extension


Methods

  • 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.
  • 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.
  • array Parameters { get; set; } - Parameters if any. Must match the ordering of the documentation.
  • TypeInformation TypeInformation { get; } - Get information about this class.
  • Array of User Users { get; set; } - List of users to change/query.
  • 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.