HubProjectManager

Class

Centralized functions used to manage IHubProject instances

This class is a convenience wrapper over util functions which are also directly accessible for use in scenarios where classes are inconvenient.

Implements

Methods

Method	Returns	Notes
init(contextOrManager: ArcGISContextManager \| IArcGISContext)	HubProjectManager	Factory function to construct a new HubProjectManager instance. Note: Used so that we could do async actions in the ctor.
create(project: Partial<IHubProject>, requestOptions: IUserRequestOptions)	Promise<IHubProject>	Create and store new project. Projects are stored as Items in the Sharing API
destroy(id: string, requestOptions: IUserRequestOptions)	Promise<void>	Destroy a project. This permanently removes the backing Item
fetch(identifier: string, requestOptions: IRequestOptions)	Promise<IHubProject>	Fetch a Project via id or it's slug This function does not require a user to be authenticated, but it does require an `IRequestOptions` which contains the portal instance to communicate with
fromItem(item: IItem, requestOptions: IRequestOptions)	Promise<IHubProject>	Convert a Hub Project Item to a IHubProject
search(query: string \| IQuery, options: IHubSearchOptions)	Promise<IHubSearchResponse<IHubProject>>	Search for Projects
setAccess(project: IHubProject, accessLevel: "public" \| "org" \| "private", requestOptions: IUserRequestOptions)	Promise<ISharingResponse>	Sets the access level of a Hub Project
shareToGroup(project: IHubProject, group: IGroup, requestOptions: IUserRequestOptions)	Promise<ISharingResponse>	Shares a Hub Project to a group
shareToGroups(project: IHubProject, groups: IGroup[], requestOptions: IUserRequestOptions)	Promise<ISharingResponse[]>	Shares a Hub Project to N Groups.
unshareFromGroup(project: IHubProject, group: IGroup, requestOptions: IUserRequestOptions)	Promise<ISharingResponse>	Unshares a Hub Project from a group
unshareFromGroups(project: IHubProject, groups: IGroup[], requestOptions: IUserRequestOptions)	Promise<ISharingResponse[]>	Unshares a Hub Project from N groups.
update(project: IHubProject, requestOptions: IUserRequestOptions)	Promise<IHubProject>	Update a project
updateThumbnail(project: IHubProject, file: any, filename: string, requestOptions: IUserRequestOptions)	Promise<IHubProject>	Set the thumbnail for the Project

init

Static Static Class Method

Factory function to construct a new HubProjectManager instance.

init(contextOrManager: ArcGISContextManager | IArcGISContext) : HubProjectManager

Parameters

Parameter	Type	Default	Notes
contextOrManager Required	ArcGISContextManager \| IArcGISContext

Returns

HubProjectManager

Note: Used so that we could do async actions in the ctor.

create

Class Method

Create and store new project.

create(project: Partial<IHubProject>, requestOptions: IUserRequestOptions) : Promise<IHubProject>

Parameters

Parameter	Type	Default	Notes
project Required	Partial<IHubProject>
requestOptions Optional	IUserRequestOptions

Returns

Promise<IHubProject>

Projects are stored as Items in the Sharing API

destroy

Class Method

Destroy a project. This permanently removes the backing Item

destroy(id: string, requestOptions: IUserRequestOptions) : Promise<void>

Parameters

Parameter	Type	Default	Notes
id Required	string
requestOptions Optional	IUserRequestOptions

Returns

Promise<void>

fetch

Class Method

Fetch a Project via id or it's slug

fetch(identifier: string, requestOptions: IRequestOptions) : Promise<IHubProject>

Parameters

Parameter	Type	Default	Notes
identifier Required	string
requestOptions Optional	IRequestOptions

Returns

Promise<IHubProject>

This function does not require a user to be authenticated, but it does require an IRequestOptions which contains the portal instance to communicate with

fromItem

Class Method

Convert a Hub Project Item to a IHubProject

fromItem(item: IItem, requestOptions: IRequestOptions) : Promise<IHubProject>

Parameters

Parameter	Type	Default	Notes
item Required	IItem
requestOptions Optional	IRequestOptions

Returns

Promise<IHubProject>

search

Class Method

Search for Projects

search(query: string | IQuery, options: IHubSearchOptions) : Promise<IHubSearchResponse<IHubProject>>

Parameters

Parameter	Type	Default	Notes
query Required	string \| IQuery
options Required	IHubSearchOptions

Returns

Promise<IHubSearchResponse<IHubProject>>

setAccess

Class Method

Sets the access level of a Hub Project

setAccess(project: IHubProject, accessLevel: "public" | "org" | "private", requestOptions: IUserRequestOptions) : Promise<ISharingResponse>

Parameters

Parameter	Type	Default	Notes
project Required	IHubProject
accessLevel Required	"public" \| "org" \| "private"
requestOptions Optional	IUserRequestOptions

Returns

Promise<ISharingResponse>

shareToGroup

Class Method

Shares a Hub Project to a group

shareToGroup(project: IHubProject, group: IGroup, requestOptions: IUserRequestOptions) : Promise<ISharingResponse>

Parameters

Parameter	Type	Default	Notes
project Required	IHubProject
group Required	IGroup
requestOptions Optional	IUserRequestOptions

Returns

Promise<ISharingResponse>

shareToGroups

Class Method

Shares a Hub Project to N Groups.

shareToGroups(project: IHubProject, groups: IGroup[], requestOptions: IUserRequestOptions) : Promise<ISharingResponse[]>

Parameters

Parameter	Type	Default	Notes
project Required	IHubProject
groups Required	IGroup[]
requestOptions Optional	IUserRequestOptions

Returns

Promise<ISharingResponse[]>

unshareFromGroup

Class Method

Unshares a Hub Project from a group

unshareFromGroup(project: IHubProject, group: IGroup, requestOptions: IUserRequestOptions) : Promise<ISharingResponse>

Parameters

Parameter	Type	Default	Notes
project Required	IHubProject
group Required	IGroup
requestOptions Optional	IUserRequestOptions

Returns

Promise<ISharingResponse>

unshareFromGroups

Class Method

Unshares a Hub Project from N groups.

unshareFromGroups(project: IHubProject, groups: IGroup[], requestOptions: IUserRequestOptions) : Promise<ISharingResponse[]>

Parameters

Parameter	Type	Default	Notes
project Required	IHubProject
groups Required	IGroup[]
requestOptions Optional	IUserRequestOptions

Returns

Promise<ISharingResponse[]>

update

Class Method

Update a project

update(project: IHubProject, requestOptions: IUserRequestOptions) : Promise<IHubProject>

Parameters

Parameter	Type	Default	Notes
project Required	IHubProject
requestOptions Optional	IUserRequestOptions

Returns

Promise<IHubProject>

updateThumbnail

Class Method

Set the thumbnail for the Project

updateThumbnail(project: IHubProject, file: any, filename: string, requestOptions: IUserRequestOptions) : Promise<IHubProject>

Parameters

Parameter	Type	Default	Notes
project Required	IHubProject
file Required	any
filename Required	string
requestOptions Optional	IUserRequestOptions

Returns

Promise<IHubProject>

Class defined in common/src/projects/HubProjectManager.ts:39