https://wiki.catglobe.com/index.php?action=history&feed=atom&title=Group_class 2026-04-29T20:19:26Z Revision history for this page on the wiki MediaWiki 1.43.0 https://wiki.catglobe.com/index.php?title=Group_class&diff=241063&oldid=prev 2026-04-20T10:20:43Z

<p>Created page with &quot;{{CGscriptClass_Template|Name=&lt;nowiki&gt;Group&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Represents a group resource.&lt;/nowiki&gt;|InheritsFrom=Array|Constructors={{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;Group resource id&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the group&lt;/nowiki&gt;}} |Description=&lt;nowiki&gt;Get an existing group by resource id&lt;/nowiki&gt;}} {{CGscriptConstructors_Template|Parameters= {{CGscriptParameters_Template|Type=string|...&quot;</p> <p><b>New page</b></p><div>{{CGscriptClass_Template|Name=&lt;nowiki&gt;Group&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Represents a group resource.&lt;/nowiki&gt;|InheritsFrom=Array|Constructors={{CGscriptConstructors_Template|Parameters=<br /> {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;Group resource id&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the group&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Get an existing group by resource id&lt;/nowiki&gt;}}<br /> {{CGscriptConstructors_Template|Parameters=<br /> {{CGscriptParameters_Template|Type=string|Name=&lt;nowiki&gt;Group name&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Name of the new group&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;Group Template unique id&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the group template (0 for default)&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;Parent resource unique id&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the parent resource&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Create a new group&lt;/nowiki&gt;}}|Methods={{CGscriptMethods_Template|ReturnType=bool|Name=&lt;nowiki&gt;AddUser&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;userUniqueId&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the user to add&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Add a user to this group; returns true if the user was newly added&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;AddUsers&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=Array of ints|Name=&lt;nowiki&gt;userUniqueIds&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Array of user unique ids to add&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Add specific users to this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Dictionary|Name=&lt;nowiki&gt;AreMember&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=Array of ints|Name=&lt;nowiki&gt;userUniqueIds&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Array of user unique ids to check&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Determine whether the specified users belong to this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;ConvertToStaticUsers&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Convert all dynamic users in this group to static users&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=bool|Name=&lt;nowiki&gt;EmailAddressExists&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=string|Name=&lt;nowiki&gt;emailAddress&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Email address to check&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Determine whether the specified email exists in this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=array|Name=&lt;nowiki&gt;EmailAddressesExist&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=array|Name=&lt;nowiki&gt;emailAddresses&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Array of email addresses to check&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Determine which of the specified emails exist in this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=array|Name=&lt;nowiki&gt;GetMembers&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Return an array of user resource ids in this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=array|Name=&lt;nowiki&gt;GetMembers&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeDeleted&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include deleted users&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeDisabled&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include disabled users&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeStatic&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include static users&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeDynamic&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include dynamic users&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Return an array of user resource ids in this group with filter options&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=array|Name=&lt;nowiki&gt;GetTimeUsed&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeUnverifiedHour&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include unverified hours&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=&lt;nowiki&gt;fromDate&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Start of the date range (inclusive)&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Returns time-registration records for group members from a date onwards&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=array|Name=&lt;nowiki&gt;GetTimeUsed&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeUnverifiedHour&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include unverified hours&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=&lt;nowiki&gt;fromDate&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Start of the date range (inclusive)&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=&lt;nowiki&gt;toDate&lt;/nowiki&gt;|Description=&lt;nowiki&gt;End of the date range (inclusive)&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Returns time-registration records for group members between two dates&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=array|Name=&lt;nowiki&gt;GetTimeUsed&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeUnverifiedHour&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include unverified hours&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=&lt;nowiki&gt;fromDate&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Start of the date range (inclusive)&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=&lt;nowiki&gt;toDate&lt;/nowiki&gt;|Description=&lt;nowiki&gt;End of the date range (inclusive)&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeDeleted&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include deleted users&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Returns time-registration records for group members between two dates, with deleted-user filter&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=array|Name=&lt;nowiki&gt;GetTimeUsed&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeUnverifiedHour&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include unverified hours&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=&lt;nowiki&gt;fromDate&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Start of the date range (inclusive)&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=DateTime|Name=&lt;nowiki&gt;toDate&lt;/nowiki&gt;|Description=&lt;nowiki&gt;End of the date range (inclusive)&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeDeleted&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include deleted users&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;includeDisabled&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to include disabled users&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Returns time-registration records for group members between two dates, with deleted and disabled user filters&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=int|Name=&lt;nowiki&gt;GetUserCount&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Return the actual number of users in this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=bool|Name=&lt;nowiki&gt;IsMember&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;userUniqueId&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the user&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Determine whether the specified user belongs to this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;RebuildGroup&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Rebuild this group&#039;s member list&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;RebuildGroup&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=bool|Name=&lt;nowiki&gt;parallelBuild&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Whether to rebuild rules in parallel transactions&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Rebuild this group&#039;s member list&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;RemoveAllUsers&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Remove all users from this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;RemoveUser&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;userUniqueId&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the user to remove&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Remove a user from this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;RemoveUsers&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=Array of ints|Name=&lt;nowiki&gt;userUniqueIds&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Array of user unique ids to remove&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Remove specific users from this group&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;Save&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Save the group to the database&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=string|Name=&lt;nowiki&gt;ToString&lt;/nowiki&gt;|Description=&lt;nowiki&gt;The string representation of the object.&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=object|Name=&lt;nowiki&gt;this[] { get; }&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;index&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Index&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Backward-compatible indexer&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=Empty|Name=&lt;nowiki&gt;this[] { get; }&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;index&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Index&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=object|Name=&lt;nowiki&gt;value&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Value to set&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Backward-compatible indexer&lt;/nowiki&gt;}}|Properties={{CGscriptProperties_Template|ReturnType=number|Name=&lt;nowiki&gt;Average&lt;/nowiki&gt;|HasGetter=1|Description=&lt;nowiki&gt;Average of the objects in the Array object. Can only use if all the elements are of type Number&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=bool|Name=&lt;nowiki&gt;CalculatedManHours&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Whether man-hours are calculated automatically&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;City&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;City of the address&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;CountryIsoCode&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;ISO code of the address country&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=int|Name=&lt;nowiki&gt;ManHours&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Allocated man-hours for this group&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=number|Name=&lt;nowiki&gt;Max&lt;/nowiki&gt;|HasGetter=1|Description=&lt;nowiki&gt;Largest of all the objects in the Array object. Can only use if all the elements are of type Number&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=number|Name=&lt;nowiki&gt;Min&lt;/nowiki&gt;|HasGetter=1|Description=&lt;nowiki&gt;Smallest of all the objects in the Array object. Can only use if all the elements are of type Number&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;Name&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Display name of the group&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;ObjectTypeName&lt;/nowiki&gt;|HasGetter=1|Description=&lt;nowiki&gt;The name of the type of object.&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=int|Name=&lt;nowiki&gt;ParentResourceId&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Unique id of the parent resource&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=array|Name=&lt;nowiki&gt;PhoneNumbers&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Phone numbers associated with this group&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;Postbox&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Postbox of the address&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;Region&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Region of the address&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=int|Name=&lt;nowiki&gt;ResourceId&lt;/nowiki&gt;|HasGetter=1|Description=&lt;nowiki&gt;Unique id of the group resource&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=int|Name=&lt;nowiki&gt;ResourceTemplateResourceId&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Unique id of the resource template for this group&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=Array of GroupRule|Name=&lt;nowiki&gt;Rules&lt;/nowiki&gt;|HasGetter=1|Description=&lt;nowiki&gt;The group builder rules attached to this group&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;StreetAddress&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Street address&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=number|Name=&lt;nowiki&gt;Sum&lt;/nowiki&gt;|HasGetter=1|Description=&lt;nowiki&gt;Sum of all the objects in the Array object. Can only use if all the elements are of type Number&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=bool|Name=&lt;nowiki&gt;TimeRegEnabled&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Whether time registration is enabled for this group&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=TypeInformation|Name=&lt;nowiki&gt;TypeInformation&lt;/nowiki&gt;|HasGetter=1|Description=&lt;nowiki&gt;Get information about this class.&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;Website&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Website associated with the group&lt;/nowiki&gt;}}<br /> {{CGscriptProperties_Template|ReturnType=string|Name=&lt;nowiki&gt;ZipCode&lt;/nowiki&gt;|HasGetter=1|HasSetter=1|Description=&lt;nowiki&gt;Zip/postal code of the address&lt;/nowiki&gt;}}|StaticMethods={{CGscriptMethods_Template|ReturnType=Dictionary|Name=&lt;nowiki&gt;Group_areMemberOfGroups&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=Array of ints|Name=&lt;nowiki&gt;List of group resource id&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Array of group unique ids to check&lt;/nowiki&gt;|Comma=,}}{{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;User resource id&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the user&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Determine which of the specified groups the user is a member of&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=array|Name=&lt;nowiki&gt;Group_getAllGroupResourceIdByUserResourceId&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;User resource id&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the user&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Get all group resource ids for a user&lt;/nowiki&gt;}}<br /> {{CGscriptMethods_Template|ReturnType=int|Name=&lt;nowiki&gt;Group_getUserCount&lt;/nowiki&gt;|Parameters=<br /> {{CGscriptParameters_Template|Type=int|Name=&lt;nowiki&gt;Group resource id&lt;/nowiki&gt;|Description=&lt;nowiki&gt;Unique id of the group&lt;/nowiki&gt;}}<br /> |Description=&lt;nowiki&gt;Return the actual number of users in the specified group&lt;/nowiki&gt;}}}}</div>

Antester@voxmeter.dk