@esri/hub.js
@esri/hub.js

HubUser

Class

Implements

Properties

Property Type Notes
context Protected IArcGISContext
entity Protected IHubUser
isDestroyed Protected false

Methods

Method Returns Notes
HubUser

Create an instance from a IHubUser object
Promise<void>

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

Note that Hub does not currently support the deletion of users, so this function should not be used as of now.
Promise<IHubUser>

Transforms editor values into entity values
Promise<IEditorConfig>

Get the editor config for the HubUser entity.
Promise<void>

Save the HubUser to the backing store.

Note that Hub does not currently support the creation of users, so this function should only be used for updating users.
Promise<IHubUser>

Transforms entity values into editor values
IHubUser

Method that returns the entity as a JSON object We have this on the EntityItem class, but we don't implement that here

fromJson

Static Static Class Method

Create an instance from a IHubUser object

Parameters

Parameter Type Default Notes
json Required Partial<IHubUser>

JSON object to create a HubProject from
context Required IArcGISContext

ArcGIS context

Returns

HubUser

HubUser

delete

Class Method

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

  • delete() : Promise<void>

Returns

Promise<void>

Note that Hub does not currently support the deletion of users, so this function should not be used as of now.

fromEditor

Class Method

Transforms editor values into entity values

Parameters

Parameter Type Default Notes
editor Required IHubUser

Returns

Promise<IHubUser>

getEditorConfig

Class Method

Get the editor config for the HubUser entity.

Parameters

Parameter Type Default Notes
i18nScope Required string

translation scope to be interpolated into the uiSchema
type Required UserEditorType

editor type - corresponds to the returned uiSchema

Returns

Promise<IEditorConfig>

save

Class Method

Save the HubUser to the backing store.

  • save() : Promise<void>

Returns

Promise<void>

Note that Hub does not currently support the creation of users, so this function should only be used for updating users.

toEditor

Class Method

Transforms entity values into editor values

Parameters

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

Returns

Promise<IHubUser>

toJson

Class Method

Method that returns the entity as a JSON object We have this on the EntityItem class, but we don't implement that here

Returns

IHubUser

IHubUser
Class defined in common/src/users/HubUser.ts:11