Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RestHelperHTTPService

Provides a means of wrapping any request that is made to an external URL, for the purposes of handling automatic token retrieval when an endpoint is secured.

Hierarchy

  • RestHelperHTTPService

Index

Constructors

Properties

Methods

Constructors

constructor

  • Initializes a new instance of the {@link geocortex.essentials.RestHelperHTTPService} class.

    Parameters

    • Optional request: any

      An optional request object to associate with this helper.

    • Optional options: any

    Returns RestHelperHTTPService

Properties

optionsObject

optionsObject: any

The options object to be supplied to the esri request function.

requestObject

requestObject: any

The request object to be supplied to the esri request function.

Static arcGisPortalToken

arcGisPortalToken: TokenResult

The ArcGIS Portal token to pass along to Essentials when performing operations involving the map and secured ArcGIS Portal hosted services.

Static token

token: string

The Geocortex Essentials token for all requests satisfying the default scopes.

deprecated

2.5.1 Use getTokenForScope instead. This will ensure that tokens will not be brokered for non-Essentials URIs (unless explicitly instructed to do so).

Static tokenScopes

tokenScopes: object

Custom token scopes to apply.

Type declaration

  • [partialUri: string]: boolean | string

Methods

Private send

  • send(): any

  • Override send so that we can append tokens as needed.

    Returns any

Static appendTokenToUrl

  • appendTokenToUrl(url: string, token: string): string

  • Parameters

    • url: string
    • token: string

    Returns string

Static getAuthenticationControlBlockStore

  • getAuthenticationControlBlockStore(): any

Static getTokenForScope

  • getTokenForScope(uri: string): string

  • Returns the token for a scope URI.

    Parameters

    • uri: string

      The URI to return the token for.

    Returns string

Static setDefaultToken

  • setDefaultToken(token: string, scope: string): void

  • Sets the default Essentials token for all requests satisfying the default scope.

    Parameters

    • token: string

      The default token to set.

    • scope: string

      The URI scope for which the token applies.

    Returns void

Static urlHasToken

  • urlHasToken(url: string): boolean

  • Parameters

    • url: string

    Returns boolean