Class SiteServiceDiscoveryProvider

Interface to the Geocortex Essentials Service Discovery. Allows searching for matching services against the Service Discovery REST endpoints.

Not supported on versions of Essentials prior to 4.5. Check the supported member after the class is initialized.
Requires an initialized Site to work.
Sets rootUrl to "{SITE_URL}/../../../connections".

Hierarchy

SiteServiceDiscoveryProvider

Implements

ServiceDiscoveryProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SiteServiceDiscoveryProvider(whitelistAgol?: boolean, whitelistPortal?: boolean): SiteServiceDiscoveryProvider

- Defined in Essentials.ts:7431
Parameters
- Optional whitelistAgol: boolean
- Optional whitelistPortal: boolean
Returns SiteServiceDiscoveryProvider

Properties

Protected _rootUrl

_rootUrl: string

Protected _site

_site: Site

initialized

initialized: boolean

isHttpsMode

isHttpsMode: boolean

supported

supported: boolean

whitelistAgol

whitelistAgol: boolean

whitelistPortal

whitelistPortal: boolean

Methods

Protected _createMapService

_createMapService(item: ResultItem, serviceDefinition: RealizeMapServiceResult): Thenable<MapService>

- Defined in Essentials.ts:7472
Parameters
- item: ResultItem
- serviceDefinition: RealizeMapServiceResult
Returns Thenable<MapService>

Protected _getConnectionId

_getConnectionId(item: ResultItem): string

- Defined in Essentials.ts:7465
Parameters
- item: ResultItem
Returns string

Protected _processError

_processError(result: any): any

- Defined in Essentials.ts:7470
Processes the ajax result, throwing an exception if it is an error response.

Parameters
- result: any
  
  The ajax response.
Returns any

Protected _processItem

_processItem(coreItem: ResultItem): ResultItem

- Defined in Essentials.ts:7471
Parameters
- coreItem: ResultItem
Returns ResultItem

Protected _verifyInitialized

_verifyInitialized(): void

- Defined in Essentials.ts:7480
Verify that this class is initialized, throwing an exception if it isn't.

Returns void

Protected _verifySupported

_verifySupported(): void

- Defined in Essentials.ts:7476
Verify that Service Discovery is supported, throwing an exception if it isn't.

Returns void

expandService

expandService(item: ResultItem): Thenable<ResultItem>

Implementation of ServiceDiscoveryProvider.expandService
- Defined in Essentials.ts:7457
TODO Document

Parameters
- item: ResultItem
Returns Thenable<ResultItem>

findServices

findServices(term: string, options?: FindServicesOptions): Thenable<ResultItem[]>

Implementation of ServiceDiscoveryProvider.findServices
- Defined in Essentials.ts:7452
TODO Document

Parameters
- term: string
- Optional options: FindServicesOptions
Returns Thenable<ResultItem[]>

getRootUrl

getRootUrl(): string

- Defined in Essentials.ts:7441
TODO Document

Returns string

initialize

initialize(site: Site): void

- Defined in Essentials.ts:7437
TODO Document

Parameters
- site: Site
Returns void

realizeMapService

realizeMapService(item: ResultItem, sr: string): Thenable<MapService>

Implementation of ServiceDiscoveryProvider.realizeMapService
- Defined in Essentials.ts:7463
TODO Document

Parameters
- item: ResultItem
- sr: string
Returns Thenable<MapService>

Protected sendRequest

sendRequest<T>(url: string, request: any): Thenable<T>

- Defined in Essentials.ts:7464
Type parameters
- T
Parameters
- url: string
- request: any
Returns Thenable<T>

suggestHints

suggestHints(term: string): Thenable<string[]>

Implementation of ServiceDiscoveryProvider.suggestHints
- Defined in Essentials.ts:7446
TODO Document

Parameters
- term: string
Returns Thenable<string[]>