HubChannel

Class

Implements

Constructors

new HubChannel(entity: IHubChannel, context: IArcGISContext) : HubChannel

Constructor Parameters

Parameter	Type	Default	Notes
entity Required	IHubChannel
context Required	IArcGISContext

Properties

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

Accessors

Accessor	Type	Notes
canDelete	boolean	Can the current user delete the channel?
canEdit	boolean	Can the current user edit the channel?
orgId	string	The orgId of the channel

Methods

Method	Returns	Notes
create(partialChannel: Partial<IHubChannel>, context: IArcGISContext, save: boolean)	Promise<HubChannel>	Create a new HubChannel, returning a HubChannel instance. Note: This does not persist the Channel into the backing store
fetch(identifier: string, context: IArcGISContext)	Promise<HubChannel>	Fetch a Channel from the backing store and return a HubChannel instance.
fromJson(json: Partial<IHubChannel>, context: IArcGISContext)	HubChannel	Create an instance from an IHubChannel object
convertToCardModel(_opts: IConvertToCardModelOpts)	IHubCardViewModel	TODO
delete()	Promise<void>	Delete the HubChannel from the store set a flag to indicate that it is destroyed
fromEditor(editor: IHubChannelEditor)	Promise<IHubChannel>	Load the channel from the editor object
getEditorConfig(i18nScope: string, type: ChannelEditorType)	Promise<IEditorConfig>	Get a specifc editor config for the HubChannel entity.
save()	Promise<void>	Save the HubChannel to the backing store.
toEditor(_editorContext: IEntityEditorContext, _include: string[])	Promise<IHubChannelEditor>	Return the channel as an editor object
toJson()	IHubChannel	Return the backing entity as an object literal
update(changes: Partial<IHubChannel>)	void	Apply a new state to the instance

create

Static Static Class Method

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

create(partialChannel: Partial<IHubChannel>, context: IArcGISContext, save: boolean) : Promise<HubChannel>

Parameters

Parameter	Type	Default	Notes
partialChannel Required	Partial<IHubChannel>		A partial IHubChannel object
context Required	IArcGISContext		ArcGIS Context
save Optional	boolean	false

Returns

a HubChannel instance

Promise<HubChannel>

fetch

Static Static Class Method

Fetch a Channel from the backing store and return a HubChannel instance.

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

Parameters

Parameter	Type	Default	Notes
identifier Required	string		Identifier of the channel to load
context Required	IArcGISContext		An IArcGISContext object

Returns

a HubChannel instance

Promise<HubChannel>

fromJson

Static Static Class Method

Create an instance from an IHubChannel object

fromJson(json: Partial<IHubChannel>, context: IArcGISContext) : HubChannel

Parameters

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

Returns

a HubChannel instance

HubChannel

convertToCardModel

Class Method

TODO

convertToCardModel(_opts: IConvertToCardModelOpts) : IHubCardViewModel

Parameters

Parameter	Type	Default	Notes
_opts Optional	IConvertToCardModelOpts

Returns

IHubCardViewModel

delete

Class Method

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

delete() : Promise<void>

Returns

a promise

Promise<void>

fromEditor

Class Method

Load the channel from the editor object

fromEditor(editor: IHubChannelEditor) : Promise<IHubChannel>

Parameters

Parameter	Type	Default	Notes
editor Required	IHubChannelEditor		An IHubChannelEditor object

Returns

a promise that resolves an IHubChannel

Promise<IHubChannel>

getEditorConfig

Class Method

Get a specifc editor config for the HubChannel entity.

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

Parameters

Parameter	Type	Default	Notes
i18nScope Required	string		A string representing the i18n scope for translated strings
type Required	ChannelEditorType		One of the supported ChannelEditorType strings

Returns

a promise that resolves a IEditorConfig object

Promise<IEditorConfig>

save

Class Method

Save the HubChannel to the backing store.

save() : Promise<void>

Returns

a promise

Promise<void>

toEditor

Class Method

Return the channel as an editor object

toEditor(_editorContext: IEntityEditorContext, _include: string[]) : Promise<IHubChannelEditor>

Parameters

Parameter	Type	Default	Notes
_editorContext Required	IEntityEditorContext
_include Optional	string[]

Returns

a promise that resolves an IHubChannelEditor object

Promise<IHubChannelEditor>

toJson

Class Method

Return the backing entity as an object literal

toJson() : IHubChannel

Returns

an IHubChannel

IHubChannel

update

Class Method

Apply a new state to the instance

update(changes: Partial<IHubChannel>) : void

Parameters

Parameter	Type	Default	Notes
changes Required	Partial<IHubChannel>		A partial IHubChannel object

Returns

void

Class defined in packages/common/src/channels/HubChannel.ts:20