shareEventWithGroups
Shares an event with one or more groups
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
groupIds Required | string[] |
An array of group IDs to share the event with |
|
entity Required | IHubEvent |
An IHubEvent object |
|
context Required | IArcGISContext |
An IArcGISContext object |
Returns
a promise that resolves IHubItemEntity
Property | Type | Notes |
---|---|---|
boolean |
True when users can be registered to attend the event |
|
HubEventAttendanceType |
The attendnace type of the event. Either |
|
boolean |
True when the user can change the access of the event to |
|
boolean |
True when the user can change the access of the event to |
|
boolean |
True when the user can change the access of the event to |
|
boolean |
True when the user can change the access of the event to |
|
boolean |
True when the user can change the status of the event to |
|
boolean |
True when the user can change the status of the event to |
|
boolean |
True when the user can change the status of the event to |
|
string[] |
An Array of edit group IDs the event is shared with |
|
string |
The end date of the event |
|
Date |
The end date & time of the event |
|
string |
The end time of the event |
|
number | null |
The maximum capacity for in-person attendance |
|
HubEventCapacityType |
The capacity type for an in-person event, either |
|
number |
The current number of in-person registrants with a registration status of |
|
boolean |
True when the event is an all day event |
|
boolean |
True when the event has been canceled |
|
boolean |
True when the event takes place in the past |
|
boolean |
True when the event is planned |
|
boolean |
True when the event has been removed |
|
boolean |
If attendees should be notified of event updates |
|
number | null |
The maximum attendance capacity for an online event |
|
HubEventCapacityType |
The capacity type for an online event, either |
|
number |
The current number of online registrants with a registration status of |
|
string[] |
An Array of view group IDs the event is shared with |
|
string[] |
A collection of content ids explicitly referenced by the event |
|
Array<{
|
A collection of objects containing the ids & types for entities referenced by the event |
|
string |
The start date of the event |
|
Date |
The start date & time of the event |
|
string |
The start time of the event |
|
string |
The time zone of the event |
|
Inherited | boolean |
Can current user delete the entity
Derived from |
Inherited | boolean |
Can current user edit the entity
Derived from |
Inherited | IHubCatalog[] |
Catalogs |
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 |
Platform derived based on current user's access to the entity if defined, it means the user can edit the entity |
Inherited | string |
Name of the Entity For Entities backed by items, this is typically the title |
Inherited | string |
Organization urlKey used to construct the slug |
Inherited | string |
Username of the owner of the item |
Inherited | number |
Current schema version. Used to determine what if any schema migrations should be applied when the item is loaded |
Inherited | string[] |
User configurable tags |
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 | string | null |
The details for an online event |
Optional | string | null |
The URL for an online event |
Optional Inherited | AccessLevel |
Access level of the item ("private" | "org" | "public") |
Optional Inherited |
{
|
|
Optional Inherited | 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 Inherited | 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 Inherited | string[] |
Parsed item categories (see parseItemCategories) |
Optional Inherited | string |
Culture code of the content
i.e. |
Optional Inherited | string |
Description for the item |
Optional Inherited | IDiscussionsSettings |
The entity's discussion settings |
Optional Inherited | string | |
Optional Inherited | number[][] |
Extent of the Entity |
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 | IHubLocation |
The location of the Entity |
Optional Inherited | string |
The orgId of the Entity, if available |
Optional Inherited | IEntityPermissionPolicy[] |
Array of permission policies that apply to the entity Only permissions with `entity |
Optional Inherited | boolean |
Is the item protected? |
Optional Inherited | string |
Slug that can be used to lookup an entity by something other than it's id |
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 |
Optional Inherited | string |
Thumbnail (read-only) |
Optional Inherited | string |
TODO: Deprecate this in favor of IHubEntityBase.links.thumbnail Thumbnail Url (read-only) |
Optional Inherited | string[] |
System configurable typekeywords |
Optional Inherited | string |
TODO: change this property to store item.url. Store the canonical url in IHubEntityBase.links.self instead. |
Optional Inherited | IWithViewSettings |
Project display properties |
Function defined in common/src/events/_internal/shareEventWithGroups.ts:15