HubGroup

Class

Hub Group Class

Implements

Properties

Property	Type	Notes
context Protected	IArcGISContext
entity Protected	IHubGroup
isDestroyed Protected	false
thumbnailCache Protected	null

Accessors

Accessor	Type	Notes
canDelete	boolean	Whether the user can delete the group only the owner or admins of the group can
canEdit	boolean	Whether the user can edit the group, only the owner or admins of the group can
isProtected	boolean	Whether the group is protected, if so, it can't be deleted

Methods

Method	Returns	Notes
create(partialGroup: Partial<IHubGroup>, context: IArcGISContext, save: boolean)	Promise<HubGroup>	Create a new HubGroup, returning a HubGroup instance. Note: This does not persist the Group into the backing store
fetch(identifier: string, context: IArcGISContext)	Promise<HubGroup>	Fetch a Group from the backing store and return a HubGroup instance.
fromJson(json: Partial<IHubGroup>, context: IArcGISContext)	HubGroup	Create an instance from an IHubGroup object
addPermissionPolicy(policy: IEntityPermissionPolicy)	void	Add a policy to the entity
checkPermission(permission: Permission)	IPermissionAccessResponse	Check if current user has a specific permission, accounting for both system and entity level policies
delete()	Promise<void>	Delete the HubGroup from the store set a flag to indicate that it is destroyed
fromEditor(editor: IHubGroupEditor)	Promise<IHubGroup>	Load the group from the editor object
getEditorConfig(i18nScope: string, type: GroupEditorType)	Promise<IEditorConfig>
getPermissionPolicies(permission: Permission)	IEntityPermissionPolicy[]	Get all policies related to a specific permission
removePermissionPolicy(permission: Permission, id: string)	void	Remove a policy from the entity
save()	Promise<void>	Save the HubGroup to the backing store
toEditor(_editorContext: IEntityEditorContext, include: string[])	Promise<IHubGroupEditor>	Return the group as an editor object
toJson()	IHubGroup	Return the backing entity as an object literal
update(changes: Partial<IHubGroup>)	void	Apply a new state to the instance

create

Static Static Class Method

Create a new HubGroup, returning a HubGroup instance. Note: This does not persist the Group into the backing store

create(partialGroup: Partial<IHubGroup>, context: IArcGISContext, save: boolean) : Promise<HubGroup>

Parameters

Parameter	Type	Default
partialGroup Required	Partial<IHubGroup>
context Required	IArcGISContext
save Optional	boolean	false

Returns

Promise<HubGroup>

fetch

Static Static Class Method

Fetch a Group from the backing store and return a HubGroup instance.

fetch(identifier: string, context: IArcGISContext) : Promise<HubGroup>

Parameters

Parameter	Type	Default	Notes
identifier Required	string		Identifier of the group to load
context Required	IArcGISContext

Returns

Promise<HubGroup>

fromJson

Static Static Class Method

Create an instance from an IHubGroup object

fromJson(json: Partial<IHubGroup>, context: IArcGISContext) : HubGroup

Parameters

Parameter	Type	Default	Notes
json Required	Partial<IHubGroup>		JSON object to create a HubGroup from
context Required	IArcGISContext		ArcGIS context

Returns

HubGroup

addPermissionPolicy

Class Method

Add a policy to the entity

addPermissionPolicy(policy: IEntityPermissionPolicy) : void

Parameters

Parameter	Type	Default	Notes
policy Required	IEntityPermissionPolicy

Returns

void

checkPermission

Class Method

Check if current user has a specific permission, accounting for both system and entity level policies

checkPermission(permission: Permission) : IPermissionAccessResponse

Parameters

Parameter	Type	Default	Notes
permission Required	Permission

Returns

IPermissionAccessResponse

delete

Class Method

Delete the HubGroup from the store set a flag to indicate that it is destroyed

delete() : Promise<void>

Returns

Promise<void>

fromEditor

Class Method

Load the group from the editor object

fromEditor(editor: IHubGroupEditor) : Promise<IHubGroup>

Parameters

Parameter	Type	Default	Notes
editor Required	IHubGroupEditor

Returns

Promise<IHubGroup>

getEditorConfig

Class Method

getEditorConfig(i18nScope: string, type: GroupEditorType) : Promise<IEditorConfig>

Parameters

Parameter	Type	Default	Notes
i18nScope Required	string
type Required	GroupEditorType

Returns

Promise<IEditorConfig>

getPermissionPolicies

Class Method

Get all policies related to a specific permission

getPermissionPolicies(permission: Permission) : IEntityPermissionPolicy[]

Parameters

Parameter	Type	Default	Notes
permission Required	Permission

Returns

IEntityPermissionPolicy[]

removePermissionPolicy

Class Method

Remove a policy from the entity

removePermissionPolicy(permission: Permission, id: string) : void

Parameters

Parameter	Type	Default	Notes
permission Required	Permission
id Required	string

Returns

void

save

Class Method

Save the HubGroup to the backing store

save() : Promise<void>

Returns

Promise<void>

toEditor

Class Method

Return the group as an editor object

toEditor(_editorContext: IEntityEditorContext, include: string[]) : Promise<IHubGroupEditor>

Parameters

Parameter	Type	Default	Notes
_editorContext Optional	IEntityEditorContext	{}
include Optional	string[]	[]

Returns

Promise<IHubGroupEditor>

toJson

Class Method

Return the backing entity as an object literal

toJson() : IHubGroup

Returns

IHubGroup

update

Class Method

Apply a new state to the instance

update(changes: Partial<IHubGroup>) : void

Parameters

Parameter	Type	Default	Notes
changes Required	Partial<IHubGroup>

Returns

void

Class defined in packages/common/src/groups/HubGroup.ts:35