Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ApiManager

Hierarchy

  • ApiManager

Index

Properties

Private APIEndpoint

APIEndpoint: string

Private CacheEndpoint

CacheEndpoint: string

Private DirectEndpoint

DirectEndpoint: string

Private controller

controller: string

Private dbgPrefix

dbgPrefix: string

debug

debug: boolean

debugOldIE

debugOldIE: boolean

Private errPrefix

errPrefix: string

Private hashesCached

hashesCached: object

Type declaration

  • [hash: string]: boolean

isIE

isIE: boolean

Private queuedRequests

queuedRequests: object

Type declaration

Methods

Private CacheRequest

  • CacheRequest(request: ApiRequest, callback: Function, onFailCallback: Function, useDataCache: boolean): void
  • Parameters

    • request: ApiRequest
    • callback: Function
    • onFailCallback: Function
    • useDataCache: boolean

    Returns void

LoginAsync

  • LoginAsync(callback: Function): void
  • Parameters

    • callback: Function

    Returns void

Private ProcessRequest

  • Parameters

    • requestHash: string
    • uncachableParams: any
    • callback: ApiRequestCallback
    • Default value encode: boolean = false
    • Default value onFailCallback: AjaxDataOnFailCallback = null
    • Optional noPrefixes: boolean
    • Default value mlserverFwd: string = null

    Returns void

ProcessRequestDirect

  • ProcessRequestDirect(request: any, callback: ApiRequestCallback, encode?: boolean, uParams?: any, onFailCallback?: AjaxDataOnFailCallback, allowSubdomains?: boolean, maxAttempts?: number, pollDelayMS?: number, mlserverFwd?: string): void
  • Parameters

    • request: any
    • callback: ApiRequestCallback
    • Default value encode: boolean = false
    • Default value uParams: any = {}
    • Default value onFailCallback: AjaxDataOnFailCallback = null
    • Default value allowSubdomains: boolean = true
    • Default value maxAttempts: number = 200
    • Default value pollDelayMS: number = 200
    • Default value mlserverFwd: string = null

    Returns void

ProcessRequestDirectEx

Private ProcessRequestEx

QueueCallbackWithHash

Private applyDefaultPerformRequestOptions

Private applyDefaultProcessRequestOptions

Private applyDefaultVerifyRequestOptions

createAuthInfo

  • createAuthInfo(): string
  • Returns string

getBingTileUrl

  • getBingTileUrl(uParams: string, requestJson?: string): string
  • Parameters

    • uParams: string
    • Default value requestJson: string = "{"action":"tile/getstreettile"}"

    Returns string

Private getCacheUrl

  • getCacheUrl(): string
  • Returns string

Private getCacheUrlOldIE

  • getCacheUrlOldIE(): string
  • Returns string

getDirectUrl

  • getDirectUrl(requestJson: string, uncachableParams: any): string
  • Parameters

    • requestJson: string
    • uncachableParams: any

    Returns string

getDirectUrlOldIE

  • getDirectUrlOldIE(disallowSubdomains: any): string
  • Parameters

    • disallowSubdomains: any

    Returns string

getImageTileUrl

  • getImageTileUrl(account: string, tileset: string, requestJson?: string, includeSubdomains?: boolean): string
  • Parameters

    • account: string
    • tileset: string
    • Default value requestJson: string = "{"action":"tile/getimagetile"}"
    • Default value includeSubdomains: boolean = false

    Returns string

getMultitileURL

  • getMultitileURL(requestJson: string, uncachableParams: any): string
  • Parameters

    • requestJson: string
    • uncachableParams: any

    Returns string

getProcessUrl

  • getProcessUrl(requestHash: string, uncachableParams: any, noPrefix?: boolean, mlserverFwd?: string): string
  • Parameters

    • requestHash: string
    • uncachableParams: any
    • Default value noPrefix: boolean = false
    • Default value mlserverFwd: string = null

    Returns string

getProxyTileShortUrl

  • getProxyTileShortUrl(proxyUrl: string, authType?: string, addParams?: string, requestJson?: string): string
  • Parameters

    • proxyUrl: string
    • Default value authType: string = "None"
    • Default value addParams: string = ""
    • Default value requestJson: string = "{"action":"tile/proxyremotetile"}"

    Returns string

getProxyTileUrl

  • getProxyTileUrl(proxyUrl: string, authType?: string, addParams?: string, customPrefix?: string, requestJson?: string): string
  • Parameters

    • proxyUrl: string
    • Default value authType: string = "None"
    • Default value addParams: string = ""
    • Default value customPrefix: string = null
    • Default value requestJson: string = "{"action":"tile/proxyremotetile"}"

    Returns string

getStreetTileUrl

  • getStreetTileUrl(append: string, customPrefix?: string, requestJson?: string): string
  • Parameters

    • append: string
    • Default value customPrefix: string = null
    • Default value requestJson: string = "{"action":"tile/getstreettile"}"

    Returns string

Private getVerifyUrl

  • getVerifyUrl(requestHash: string): string
  • Parameters

    • requestHash: string

    Returns string

isCached

  • isCached(hash: string): boolean
  • Parameters

    • hash: string

    Returns boolean

performRequest

  • performRequest(request: any, direct: boolean, cacheOnly: boolean, uParams: any, callback: ApiRequestCallback, onFailCallback?: AjaxDataOnFailCallback, allowSubdomains?: boolean, maxAttempts?: number, pollDelayMS?: number): void
  • Parameters

    • request: any
    • direct: boolean
    • cacheOnly: boolean
    • uParams: any
    • callback: ApiRequestCallback
    • Default value onFailCallback: AjaxDataOnFailCallback = null
    • Default value allowSubdomains: boolean = true
    • Default value maxAttempts: number = 200
    • Default value pollDelayMS: number = 200

    Returns void

performRequestEx

Private setAuthTokens

  • setAuthTokens(): void
  • Returns void

simpleStringifyObject

  • simpleStringifyObject(input: any): string
  • Parameters

    • input: any

    Returns string

verifyRequest

  • verifyRequest(request: any, callback: ApiRequestCallback, encode?: boolean, onFailCallback?: function, mlserverFwd?: string): void
  • Parameters

    • request: any
    • callback: ApiRequestCallback
    • Default value encode: boolean = false
    • Optional onFailCallback: function
        • (...args: Array<any>): void
        • Parameters

          • Rest ...args: Array<any>

          Returns void

    • Default value mlserverFwd: string = null

    Returns void

verifyRequestEx

Static CreateRequestHash

  • CreateRequestHash(request: any): string
  • Parameters

    • request: any

    Returns string

Static Private extractTableReferences

  • extractTableReferences(request: any, replacements: object): void
  • Parameters

    • request: any
    • replacements: object
      • obj: any
      • propname: string
      • table: string

    Returns void

Static getTableVersion

  • Parameters

    • tableName: string
    • cacheTimeout: number
    • unauthorizedCallback: function
        • (message?: string): void
        • Parameters

          • Optional message: string

          Returns void

    • Optional errorCallback: ApiManagerTableVersionErrorCallback

    Returns JQueryPromise<object>

Static processTableNames

  • Parameters

    • request: any
    • callback: function
        • (newrequest: any): void
        • Parameters

          • newrequest: any

          Returns void

    • unauthorizedCallback: function
        • (tableName?: string): void
        • Parameters

          • Optional tableName: string

          Returns void

    • Optional errorCallback: ApiManagerTableVersionErrorCallback
    • Optional cacheTimeout: number

    Returns void

Generated using TypeDoc