shareEntityWithGroups
Shares an entity to one or more groups
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
entity Required | IHubItemEntity |
An IHubItemEntity object |
|
groupIds Required | string[] |
An array of group IDs to share the entity to |
|
context Required | IArcGISContext |
An IArcGISContext object |
Returns
a promise that resolves the updated entity
Property | Type | Notes |
---|---|---|
boolean |
Can current user delete the entity
Derived from |
|
boolean |
Can current user edit the entity
Derived from |
|
string |
Platform derived based on current user's access to the entity if defined, it means the user can edit the entity |
|
string |
Username of the owner of the item |
|
number |
Current schema version. Used to determine what if any schema migrations should be applied when the item is loaded |
|
string[] |
User configurable tags |
|
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 | AccessLevel |
Access level of the item ("private" | "org" | "public") |
Optional | IHubGeography |
boundary will default to the item extent but can be overwritten by enrichments from the Hub API (inline) or fetched from a location such as /resources/boundary.json |
Optional | boolean |
Can this item be recycled? This will be returned by the Portal API once recycling is enabled on the platform Optional because it can default to false if not returned by the API |
Optional | string[] |
Parsed item categories (see parseItemCategories) |
Optional | string |
Culture code of the content
i.e. |
Optional | string |
Description for the item |
Optional | number[][] |
Extent of the Entity |
Optional | IHubLocation |
The location of the Entity |
Optional | string |
The orgId of the Entity, if available |
Optional | boolean |
Is the item protected? |
Optional | string |
Thumbnail (read-only) |
Optional | string |
TODO: Deprecate this in favor of IHubEntityBase.links.thumbnail Thumbnail Url (read-only) |
Optional | string[] |
System configurable typekeywords |
Optional | string |
TODO: change this property to store item.url. Store the canonical url in IHubEntityBase.links.self instead. |
Optional | IWithViewSettings |
Project display properties |
Optional Inherited |
{
|
|
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 | string |
followers group id |
Optional Inherited | boolean |
If the item has discussions enabled |
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/core/shareEntityWithGroups.ts:15