RoleExtensionUserParameter class

From Catglobe Wiki
Revision as of 08:24, 2 July 2020 by Administrator (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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.