createHubGroup
Create a new Hub Group we are creating an IGroup with the createGroup call so we need to convert the Hub Group to IGroup first then convert it back to Hub Group and return it
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
partialGroup Required | Partial<IHubGroup> | ||
requestOptions Required | IUserRequestOptions |
Available requestOptions
Property | Type | Notes |
---|
Returns
Property | Type | Notes |
---|---|---|
AccessLevel |
Access level of the group ("private" | "org" | "public") we are using AccessLevel instead of SettableAccessLevel intentionally due to the Portal API being inconsistent between .access on items vs groups |
|
boolean |
Whether the user can delete the group, only owners and admins can |
|
boolean |
Whether the user can edit the group, only owners and admins can |
|
boolean |
Whether discussions are enabled or disabled |
|
boolean |
Whether the group accepts members through invitations only |
|
boolean |
Whether the group is for read only or not |
|
boolean |
Whether the group is editable |
|
boolean |
Whether the group is for view only or not |
|
boolean |
Whether the group is protected or not the group cannot be deleted if protected |
|
Inherited | Date |
Date the entity was created |
Inherited | string |
Source of the creation date as a property path
e.q |
Inherited | string |
Id of the entity as a string |
Inherited | string |
Name of the Entity For Entities backed by items, this is typically the title |
Inherited | string |
For Item backed results, this will be |
Inherited | Date |
Date when the entity was last updated Depending on the entity, this could be derived in many different ways |
Inherited | string |
Source of the updated date |
Optional | boolean |
Whether there is a field we are trying to clear, if true, we need to send clearEmptyFields: true to the updateGroup call |
Optional | "invite" | "request" | "auto" |
The join type for the group (invite, request, auto) This is mapped to isInvitationOnly and autoJoin |
Optional | boolean |
Whether members can auto join the group |
Optional | string |
Description for the group |
Optional | boolean |
Whether the group is an open data group |
Optional | boolean |
Is it an admin group / is leaving disallowed |
Optional | MemberType |
Member types of the group ("owner" | "admin" | "member" | "none") |
Optional | MembershipAccess |
Who can join the groups (organization, collaborators, anyone) |
Optional | string |
Id of the org that the group belongs to Depending who is fetching the group, and the owning org's settings this may not be returned from the Portal API |
Optional | string |
Username of the owner of the group |
Optional | GroupSortField |
Sort field for the Group |
Optional | PlatformSortOrder |
Sort order for the Group |
Optional | string[] |
User configurable tags |
Optional | string |
Group thumbnail url (read-only) |
Optional | string |
Group thumbnail url (read-only) |
Optional | string[] |
System configurable typekeywords |
Optional Inherited | IDiscussionsSettings |
The entity's discussion settings |
Optional Inherited | string | |
Optional Inherited | IFeatureFlags |
We need a means to enable / disable the "feature/capability" represented by a permission
for an entity. e.g. we want to disable events for a site, so we have |
Optional Inherited | IHubEntityLinks |
Links to related things |
Optional Inherited | IEntityPermissionPolicy[] |
Array of permission policies that apply to the entity Only permissions with `entity |
Optional Inherited | string |
Source of the entity. Exact logic for this tbd, but the intent is to allow the result to be attributed to something other than "owner" |
Optional Inherited | string |
Sanitized summary derived from item.snippet, item.description, group.description, user.description, event.description etc |
Function defined in common/src/groups/HubGroups.ts:102