Class PortalCompat

constructor

• new PortalCompat(options?: PortalCompatOptions): PortalCompat

  Parameters

  • options: PortalCompatOptions = {}

  Returns PortalCompat

ReadonlysharingRestBase

generateToken

• generateToken(
      options: PortalGenerateTokenOptions,
  ): Promise<PortalTokenCredential>

  Exchange username/password for a portal token via POST /sharing/rest/generateToken. Stores the token on this instance and returns the credential (expires ms → expiresAtMs).

  Parameters

  • options: PortalGenerateTokenOptions

  Returns Promise<PortalTokenCredential>

getInfo

• getInfo(): Promise<PortalInfo>

  GET /sharing/rest/info.

  Returns Promise<PortalInfo>

getItem

• getItem(itemId: string, options?: PortalGetItemOptions): Promise<PortalItem>

  GET /sharing/rest/content/items/{id}.

  Parameters

  • itemId: string
  • options: PortalGetItemOptions = {}

  Returns Promise<PortalItem>

getItemData

• getItemData(itemId: string, options?: PortalGetItemOptions): Promise<unknown>

  GET /sharing/rest/content/items/{id}/data. Web maps return their operational layers here.

  Parameters

  • itemId: string
  • options: PortalGetItemOptions = {}

  Returns Promise<unknown>

getPortalSelf

• getPortalSelf(): Promise<PortalSelf>

  GET /sharing/rest/portals/self (attaches the token when present).

  Returns Promise<PortalSelf>

getToken

• getToken(): string | undefined

  The currently held portal token, if any.

  Returns string | undefined

openFeatureLayer

• openFeatureLayer(
      itemOrId: string | PortalItem,
      options?: PortalOpenOptions,
  ): Promise<PortalOpenResult>

  Resolve an item (fetching it when given an id), parse its service url, and return an authenticated handle. Feature Service items yield a FeatureLayerCompat bound to a client carrying the portal token; Map/Image Service items yield the resolved { baseUrl, serviceId, client }.

  Parameters

  • itemOrId: string | PortalItem
  • options: PortalOpenOptions = {}

  Returns Promise<PortalOpenResult>

registerWithIdentityManager

• registerWithIdentityManager(): void

  Register the currently held token with the shared identityManager under this portal's /sharing/rest server, so subsequent esri-compat calls resolve the same credential.

  Returns void

search

• search(options?: PortalSearchOptions): Promise<PortalSearchResult>

  GET /sharing/rest/search.

  Parameters

  • options: PortalSearchOptions = {}

  Returns Promise<PortalSearchResult>