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

fetchCatalog

Function

Fetch a IHubCatalog from a backing item. This will apply schema upgrades to the structure

Parameters

Parameter Type Default Notes
identifier Required string
requestOptions Required IHubRequestOptions

Available requestOptions

Property Type Notes
authentication Optional UserSession
hubApiUrl Optional string
isPortal Optional boolean
portalSelf Optional IHubRequestOptionsPortalSelf
credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.
headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.
hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.
httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.
maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
params Optional Inherited IParams

Additional parameters to pass in the request.
portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
rawResponse Optional Inherited boolean

Return the raw response

Returns

Promise<IHubCatalog>
Property Type Notes
schemaVersion number

Schema Version
collections Optional IHubCollection[]

Collections within the Catalog
emojii Optional string

Optional Emoji to show in the UI
integrity Optional {
collections:
string
scopes:
string
}

Hashes to verify the integrity of the catalog Only verified when the catalog is loaded into the editor If the hashes do not match, the catalog will not be loaded and the user will simply have the option to reset the catalog
scopes Optional ICatalogScope

Filter defines the "scopes" of the Catalog, on a per entity type basis
title Optional string

Title for the Gallery
Function defined in common/src/search/fetchCatalog.ts:17