To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Extends: AbstractCollectionResource
Implements: CollectionResource, UserAdminResource, MakeCollectionableResource, PropFindableResource, GetableResource, PrincipalResource, Mailbox, CalDavPrincipal, CardDavPrincipal, ProfileResource, RepositoriesHome
Properties
| Name | Returns | Notes |
|---|---|---|
| accessControlList | Map<Principal,List<AccessControlledResource.Priviledge>> | Get all allowed priviledges for all principals on this resource. Note that a principal might be a user, a group, or a built-in webdav group such as AUTHENTICATED |
| activeMenuIds | String[] | |
| address | String | |
| addressBookHomeSet | HrefList | |
| allFields | Map<String,String> | Returns a map of all fields stored against this profile for all groups in this organisation, keyed on the field name. If there are fields with the same name only one will be in the map |
| calendarHomeSet | HrefList | Contains a single path, which is the path to this users collection of calendars |
| calendarUserAddressSet | HrefList | |
| calendarUserType | String | |
| children | ResourceList<CommonResource> | |
| createDate | Date | The date this profile was created |
| currentUserRoles | Set<Role> | Get all current roles for a user |
| directoryTemplate | String | |
String | ||
| emailDisabled | boolean | |
| extProfileBean | ExtProfileBean | |
| firstName | String | The user's first name |
| formattedName | String | |
| hasPassword | boolean | Check if there is a password for this account |
| idenitifer | PrincipleId | The identifier is the same as the path to the user |
| inbox | MessageFolder | A folder containing received messages |
| lastVisit | Date | |
| memberships | MembershipList | Get all memberships for organisations within the current organisation |
| modifiedDate | Date | |
| name | String | |
| nickName | String | The name the user was asked to be identified as. Note there is no uniqueness constraints on this field |
| parent | CommonCollectionResource | |
| phone | String | The standard phone number field for a profile |
| primaryMembership | MembershipBean | Get the first membership for the primary group this user is associated with. Return null if there are none. |
| primaryMemberships | MembershipList | Get all primary memberships as a list |
| profile | ProfileBean | |
| profilePicHref | String | |
| repositories | List<BranchFolder> | Get the repositories owned by this user |
| signatureCredentials | Map<String,SignatureCredentialBean> | |
| supportedComponentSets | SupportedCalendarComponentListsSet | |
| surName | String | The user's surname |
| thisEntity | BaseEntity | |
| thisProfile | Profile | |
| thisUser | Profile | Get the user this resource represents |
| title | String | Returns the title (ie, as in the page title) of the resource. This is the nickname if available, otherwise the first name, otherwise the resource name, which is also the user ID |
| userId | Long | The numeric ID of this user. Always unique |
Methods
| Signature | Returns | Notes |
|---|---|---|
isInGroup(String groupName) | boolean | Check if the user has a membershuip in the organisation currently being accessed, or a child of it, to a group of the given name |
isInGroup(String groupName, String orgId) | boolean | Check if the user has a membershuip in the group, for the given organisation |
memberships(String groupName) | MembershipList | |
dailyVisits(Date from, Date to) | List<DayStat> | Get the number of hits for each day with visits for this user and website, in the given date range |
dailyVisits(Website website) | List<DayStat> | |
save() | void | Apply any changes to persistence. Does not use a transaction, so you must have started a transaction already. This will update the search index so should be done last to ensure the transaction is not rolled back |
© 2025 Kademi Ltd