Catalog

Class

Catalog Class

Abstracts working with Catalogs and fetching collections with the correct scope applied.

For more information, check out the Catalog & Collection Guide

Implements

IHubCatalog

Accessors

Accessor	Type	Notes
availableScopes	EntityType[]	Return an array of the entity types available in this Catalog
collectionNames	string[]	Get the names of the collections
collections	IHubCollection[]	Get the collections array. Returns simple objects not Collection instances
displayConfig	IGalleryDisplayConfig	Return the display configuration for the gallery
schemaVersion	number	Return the schema version
scopes	ICatalogScope	Return the existing scopes hash
title	string	Title getter Title setter

Methods

Method	Returns	Notes
fromJson(json: IHubCatalog, context: IArcGISContext)	Catalog	Create a Catalog instance from a Catalog Definition Json object
init(identifier: string, context: IArcGISContext, options: { hubEntityType: HubEntityType prop: string })	Promise<Catalog>	Fetch a catalog At this point, it returns the `.catalog` property from the entity
addCollection(collection: IHubCollection)	void	Add a collection
contains(identifier: string, options: IContainsOptions)	Promise<IContainsResponse>
getCollection(name: string)	Collection	Get a Collection instance by name
getCollectionJson(name: string)	IHubCollection	Get the Collection json by name
getCustomCollection(type: EntityType, filters: IFilter[])	Collection	Get a Collection instance, based on a specific entity type and filters This extends from the base scope for the entity type
getCustomCollectionJson(type: EntityType, filters: IFilter[])	IHubCollection	Create a custom collection based on a specific entity type and filters Returned collection extends from the base scope for the entity type
getScope(type: EntityType)	IQuery \| undefined	Get the scope's query for a particular entity type
searchCollections(query: string \| IQuery, options: IHubSearchOptions)	Promise<ISearchResponseHash>	Execute a term search against all the collections in the Catalog or an IQuery against all collections that match the targetEntity. Note: This will not search scopes which do not have corresponding collections. If you want that behavior, use `searchCatalogs` function instead.
searchGroups(query: string \| IQuery, options: IHubSearchOptions)	Promise<IHubSearchResponse<IHubSearchResult>>	Search for Groups Will throw if the Catalog does not have a scope defined for groups
searchItems(query: string \| IQuery, options: IHubSearchOptions)	Promise<IHubSearchResponse<IHubSearchResult>>	Search for Items Will throw if the Catalog does not have a scope defined for items
searchScopes(query: string \| IQuery, options: IHubSearchOptions, limitTo: EntityType[])	Promise<ISearchResponseHash>	Execute a term search against all the scopes in the Catalog
searchUsers(query: string \| IQuery, options: IHubSearchOptions)	Promise<IHubSearchResponse<IHubSearchResult>>	Search for Users Will throw if the Catalog does not have a scope defined for users
setScope(type: EntityType, query: IQuery)	void	Set the scope for a specific entity type
toJson()	IHubCatalog	Return the JSON object backing the instance

fromJson

Static Static Class Method

Create a Catalog instance from a Catalog Definition Json object

fromJson(json: IHubCatalog, context: IArcGISContext) : Catalog

Parameters

Parameter	Type	Default	Notes
json Required	IHubCatalog
context Optional	IArcGISContext

Returns

Catalog

init

Static Static Class Method

Fetch a catalog At this point, it returns the .catalog property from the entity

init(identifier: string, context: IArcGISContext, options: {
hubEntityType:
HubEntityType
prop:
string
}) : Promise<Catalog>

Parameters

Parameter	Type	Notes
identifier Required	string	url, guid, cuid
context Optional	IArcGISContext
options Optional	{ hubEntityType: HubEntityType prop: string }	is possible, pass the hubEntityType to improve fetching performance

Returns

Promise<Catalog>

addCollection

Class Method

Add a collection

addCollection(collection: IHubCollection) : void

Parameters

Parameter	Type	Default	Notes
collection Required	IHubCollection

Returns

void

contains

Class Method

contains(identifier: string, options: IContainsOptions) : Promise<IContainsResponse>

Parameters

Parameter	Type	Default	Notes
identifier Required	string
options Required	IContainsOptions

Returns

Promise<IContainsResponse>

getCollection

Class Method

Get a Collection instance by name

getCollection(name: string) : Collection

Parameters

Parameter	Type	Default	Notes
name Required	string

Returns

Collection

getCollectionJson

Class Method

Get the Collection json by name

getCollectionJson(name: string) : IHubCollection

Parameters

Parameter	Type	Default	Notes
name Required	string

Returns

IHubCollection

getCustomCollection

Class Method

Get a Collection instance, based on a specific entity type and filters This extends from the base scope for the entity type

getCustomCollection(type: EntityType, filters: IFilter[]) : Collection

Parameters

Parameter	Type	Default	Notes
type Required	EntityType
filters Required	IFilter[]

Returns

Collection

getCustomCollectionJson

Class Method

Create a custom collection based on a specific entity type and filters Returned collection extends from the base scope for the entity type

getCustomCollectionJson(type: EntityType, filters: IFilter[]) : IHubCollection

Parameters

Parameter	Type	Default	Notes
type Required	EntityType
filters Required	IFilter[]

Returns

IHubCollection

getScope

Class Method

Get the scope's query for a particular entity type

getScope(type: EntityType) : IQuery | undefined

Parameters

Parameter	Type	Default	Notes
type Required	EntityType

Returns

IQuery | undefined

searchCollections

Class Method

Execute a term search against all the collections in the Catalog or an IQuery against all collections that match the targetEntity. Note: This will not search scopes which do not have corresponding collections. If you want that behavior, use searchCatalogs function instead.

searchCollections(query: string | IQuery, options: IHubSearchOptions) : Promise<ISearchResponseHash>

Parameters

Parameter	Type	Default	Notes
query Required	string \| IQuery		string or IQuery
options Optional	IHubSearchOptions	{}

Returns

Promise<ISearchResponseHash>

searchGroups

Class Method

Search for Groups Will throw if the Catalog does not have a scope defined for groups

searchGroups(query: string | IQuery, options: IHubSearchOptions) : Promise<IHubSearchResponse<IHubSearchResult>>

Parameters

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

Returns

Promise<IHubSearchResponse<IHubSearchResult>>

searchItems

Class Method

Search for Items Will throw if the Catalog does not have a scope defined for items

searchItems(query: string | IQuery, options: IHubSearchOptions) : Promise<IHubSearchResponse<IHubSearchResult>>

Parameters

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

Returns

Promise<IHubSearchResponse<IHubSearchResult>>

searchScopes

Class Method

Execute a term search against all the scopes in the Catalog

searchScopes(query: string | IQuery, options: IHubSearchOptions, limitTo: EntityType[]) : Promise<ISearchResponseHash>

Parameters

Parameter	Type	Default	Notes
query Required	string \| IQuery		term or IQuery
options Optional	IHubSearchOptions	{}
limitTo Optional	EntityType[]

Returns

Promise<ISearchResponseHash>

searchUsers

Class Method

Search for Users Will throw if the Catalog does not have a scope defined for users

searchUsers(query: string | IQuery, options: IHubSearchOptions) : Promise<IHubSearchResponse<IHubSearchResult>>

Parameters

Parameter	Type	Default	Notes
query Required	string \| IQuery		string or IQuery
options Optional	IHubSearchOptions	{}

Returns

Promise<IHubSearchResponse<IHubSearchResult>>

setScope

Class Method

Set the scope for a specific entity type

setScope(type: EntityType, query: IQuery) : void

Parameters

Parameter	Type	Default	Notes
type Required	EntityType
query Required	IQuery

Returns

void

toJson

Class Method

Return the JSON object backing the instance

toJson() : IHubCatalog

Returns

IHubCatalog

Class defined in common/src/search/Catalog.ts:37