Class ExternalInfoService`Abstract`

Index

Constructors

Methods

_checkWikiInfo cancelWikiInfo hasWikiInfo requestWikiInfo

Constructors

constructor

new ExternalInfoService(): ExternalInfoService
Returns ExternalInfoService

Methods

`Static`_checkWikiInfo

_checkWikiInfo(landmark: Landmark): [boolean, ExternalInfo]
Internal helper to check Wikipedia info and return both result and ExternalInfo object.
Parameters
- landmark: Landmark
  Landmark for which the check will be done.
Returns [boolean, ExternalInfo]
[boolean, ExternalInfo] tuple
- Defined in core/externalinfo.ts:77

`Static`cancelWikiInfo

cancelWikiInfo(operationHandler: EventHandler): void
Cancels a Wikipedia info request.
Parameters
- operationHandler: EventHandler
  The event handler returned by requestWikiInfo.
Returns void
- Defined in core/externalinfo.ts:65

`Static`hasWikiInfo

hasWikiInfo(landmark: Landmark): boolean
Checks if the landmark has Wikipedia info Requests all the wikipedia info at once (page title/url, page summary, and list of pictures - only urls of the pictures) - returns true if request successfully made, false if something went wrong.
Parameters
- landmark: Landmark
  Landmark for which the check will be done.
Returns boolean
True if the landmark has Wikipedia info, false otherwise

Throws
An exception if it fails.
- Defined in core/externalinfo.ts:29

`Static`requestWikiInfo

requestWikiInfo(
landmark: Landmark,
onComplete: (err: GemError, extraInfo: ExternalInfo | null) => void,
): EventHandler | null
Requests Wikipedia info for a landmark. The result will be provided as an ExternalInfo object.
Parameters
- landmark: Landmark
  Landmark for which the request will be done.
- onComplete: (err: GemError, extraInfo: ExternalInfo | null) => void
  Callback to be triggered after the wikipedia request is done.
  
  Called with GemError.success and the external info object on success.
  
  Called with GemError.invalidInput and null info if the landmark does not have Wikipedia info.
  
  Called with GemError.connection and null info if connection is not available or restricted.
  
  Called with GemError.notFound and null info if wikipedia info is not found for the landmark.
  
  Called with GemError.general and null info on other errors.
Returns EventHandler | null
An EventHandler that can be used to cancel the request.

Throws
An exception if it fails.
- Defined in core/externalinfo.ts:46