Documentation
¶
Overview ¶
Package groups provides API services to manage groups.
Index ¶
Constants ¶
const ( OriginGroupMembership = "group_membership" OriginItemUnlocking = "item_unlocking" OriginSelf = "self" OriginOther = "other" OriginComputed = "computed" OriginGranted = "granted" )
Variables ¶
This section is empty.
Functions ¶
func GenerateGroupCode ¶
GenerateGroupCode generate a random code for a group.
Types ¶
type GroupGetResponseCodePart ¶
type GroupGetResponseCodePart struct {
// Nullable; returned only if the current user is a manager
Code *string `json:"code"`
// Nullable; returned only if the current user is a manager
CodeLifetime *int32 `json:"code_lifetime"`
// Nullable; returned only if the current user is a manager
CodeExpiresAt *database.Time `json:"code_expires_at"`
}
GroupGetResponseCodePart contains fields related to the group's code. These fields are only displayed if the current user is a manager of the group. swagger:ignore
type GroupManagersViewResponseRowThroughAncestorGroups ¶
type GroupManagersViewResponseRowThroughAncestorGroups struct {
// enum: none,memberships,memberships_and_group
// displayed only when include_managers_of_ancestor_groups=1, note that the group is an ancestor of itself
CanManageThroughAncestorGroups string `json:"can_manage_through_ancestor_groups"`
// displayed only when include_managers_of_ancestor_groups=1, note that the group is an ancestor of itself
CanGrantGroupAccessThroughAncestorGroups bool `json:"can_grant_group_access_through_ancestor_groups"`
// displayed only when include_managers_of_ancestor_groups=1, note that the group is an ancestor of itself
CanWatchMembersThroughAncestorGroups bool `json:"can_watch_members_through_ancestor_groups"`
}
GroupManagersViewResponseRowThroughAncestorGroups contains permissions propagated from ancestor groups.
type GroupManagersViewResponseRowUser ¶
type GroupManagersViewResponseRowUser struct {
// Displayed only for users
Login string `json:"login"`
// Nullable; displayed only for users
FirstName *string `json:"first_name"`
// Nullable; displayed only for users
LastName *string `json:"last_name"`
}
GroupManagersViewResponseRowUser contains names of a manager.
type ManagerPermissionsPart ¶
type ManagerPermissionsPart struct {
CurrentUserCanManageValue int `json:"-"`
// returned only if the current user is a manager
// enum: none,memberships,memberships_and_group
CurrentUserCanManage string `json:"current_user_can_manage"`
// returned only if the current user is a manager
CurrentUserCanGrantGroupAccess bool `json:"current_user_can_grant_group_access"`
// returned only if the current user is a manager
CurrentUserCanWatchMembers bool `json:"current_user_can_watch_members"`
}
ManagerPermissionsPart contains fields related to permissions for managing the group. These fields are only displayed if the current user is a manager of the group. swagger:ignore
type UserCountPart ¶
type UserCountPart struct {
// The number of descendant users (returned only if the current user is a manager)
UserCount int32 `json:"user_count"`
}
UserCountPart contains the number of descendant users for a group. This field is only displayed if the current user is a manager of the group. swagger:ignore
Source Files
¶
- accept_join_requests.go
- accept_leave_requests.go
- add_child.go
- check_code.go
- create_code.go
- create_group.go
- create_invitations.go
- create_manager.go
- create_user_batch.go
- delete_group.go
- get_breadcrumbs.go
- get_children.go
- get_current_user_team_by_item.go
- get_granted_permissions.go
- get_group.go
- get_group_progress.go
- get_group_progress_csv.go
- get_managers.go
- get_members.go
- get_navigation.go
- get_parents.go
- get_participant_progress.go
- get_permissions.go
- get_requests.go
- get_roots.go
- get_team_descendants.go
- get_team_progress.go
- get_team_progress_csv.go
- get_user_batch_prefixes.go
- get_user_batches.go
- get_user_descendants.go
- get_user_progress.go
- get_user_progress_csv.go
- get_user_requests.go
- groups.go
- path_from_root.go
- reject_join_requests.go
- reject_leave_requests.go
- remove_child.go
- remove_code.go
- remove_manager.go
- remove_members.go
- remove_user_batch.go
- requests.go
- search_for_possible_subgroups.go
- update_group.go
- update_manager.go
- update_permissions.go
- withdraw_invitations.go