Class Utils

Constructors

constructor

Methods

attemptResourceWithToken authorize checkStatus createAuthorizationFailedError createError createInternalServerError createRestrictedError doAuthChain generateTreeNodeIds getImageQuality getInexactLocale getLocalisedValue getMediaType getResourceById getService getServices getTemporalComponent isImageProfile isImageServiceType isLevel0ImageProfile isLevel1ImageProfile isLevel2ImageProfile loadExternalResourceAuth09 loadExternalResourceAuth1 loadExternalResourcesAuth09 loadExternalResourcesAuth1 loadManifest normaliseType normaliseUrl normalisedUrlsMatch parseManifest showAuthInteraction traverseAndFind

Constructors

constructor

Methods

Static attemptResourceWithToken

Static authorize

  • authorize(resource, tokenStorageStrategy, clickThrough, restricted, login, getAccessToken, storeAccessToken, getStoredAccessToken): Promise<IExternalResource>

  • Parameters

    • resource: IExternalResource
    • tokenStorageStrategy: string
    • clickThrough: ((resource) => Promise<any>)
    • restricted: ((resource) => Promise<any>)
    • login: ((resource) => Promise<any>)
    • getAccessToken: ((resource, rejectOnError) => Promise<IAccessToken>)
    • storeAccessToken: ((resource, token, tokenStorageStrategy) => Promise<any>)
        • (resource, token, tokenStorageStrategy): Promise<any>

        • Parameters

          Returns Promise<any>

    • getStoredAccessToken: ((resource, tokenStorageStrategy) => Promise<IAccessToken>)

    Returns Promise<IExternalResource>

Static checkStatus

  • checkStatus(response): any

  • Parameters

    • response: any

    Returns any

Static createAuthorizationFailedError

Static createError

Static createInternalServerError

  • createInternalServerError(message): Error

  • Parameters

    • message: string

    Returns Error

Static createRestrictedError

Static doAuthChain

  • doAuthChain(resource, openContentProviderInteraction, openTokenService, userInteractedWithContentProvider, getContentProviderInteraction, handleMovedTemporarily, showOutOfOptionsMessages): Promise<void | IExternalResource>

  • Parameters

    • resource: IExternalResource
    • openContentProviderInteraction: ((service) => any)
        • (service): any

        • Parameters

          Returns any

    • openTokenService: ((resource, tokenService) => Promise<any>)
    • userInteractedWithContentProvider: ((contentProviderInteraction) => Promise<any>)
        • (contentProviderInteraction): Promise<any>

        • Parameters

          • contentProviderInteraction: any

          Returns Promise<any>

    • getContentProviderInteraction: ((resource, service) => Promise<any>)
    • handleMovedTemporarily: ((resource) => Promise<any>)
    • showOutOfOptionsMessages: ((resource, service) => void)

    Returns Promise<void | IExternalResource>

Static generateTreeNodeIds

  • generateTreeNodeIds(treeNode, index?): void

  • Parameters

    Returns void

Static getImageQuality

  • getImageQuality(profile): string

  • Parameters

    • profile: ServiceProfile

    Returns string

Static getInexactLocale

  • getInexactLocale(locale): string

  • Parameters

    • locale: string

    Returns string

Static getLocalisedValue

  • getLocalisedValue(resource, locale): null | string

  • Parameters

    • resource: any
    • locale: string

    Returns null | string

Static getMediaType

  • getMediaType(type): MediaType

  • Parameters

    • type: string

    Returns MediaType

Static getResourceById

Static getService

Static getServices

  • getServices(resource, __namedParameters?): Service[]

  • Parameters

    • resource: any
    • __namedParameters: {
          onlyService?: boolean;
          onlyServices?: boolean;
          skipParentResources?: boolean;
      } = {}
      • Optional onlyService?: boolean
      • Optional onlyServices?: boolean
      • Optional skipParentResources?: boolean

    Returns Service[]

Static getTemporalComponent

  • getTemporalComponent(target): null | number[]

  • Parameters

    • target: string

    Returns null | number[]

Static isImageProfile

  • isImageProfile(profile): boolean

  • Parameters

    • profile: ServiceProfile

    Returns boolean

Static isImageServiceType

  • isImageServiceType(type): boolean

  • Parameters

    • type: null | string

    Returns boolean

Static isLevel0ImageProfile

  • isLevel0ImageProfile(profile): boolean

  • Parameters

    • profile: ServiceProfile

    Returns boolean

Static isLevel1ImageProfile

  • isLevel1ImageProfile(profile): boolean

  • Parameters

    • profile: ServiceProfile

    Returns boolean

Static isLevel2ImageProfile

  • isLevel2ImageProfile(profile): boolean

  • Parameters

    • profile: ServiceProfile

    Returns boolean

Static loadExternalResourceAuth09

  • loadExternalResourceAuth09(resource, tokenStorageStrategy, clickThrough, restricted, login, getAccessToken, storeAccessToken, getStoredAccessToken, handleResourceResponse, options?): Promise<IExternalResource>

  • Parameters

    • resource: IExternalResource
    • tokenStorageStrategy: string
    • clickThrough: ((resource) => Promise<any>)
    • restricted: ((resource) => Promise<any>)
    • login: ((resource) => Promise<any>)
    • getAccessToken: ((resource, rejectOnError) => Promise<IAccessToken>)
    • storeAccessToken: ((resource, token, tokenStorageStrategy) => Promise<any>)
        • (resource, token, tokenStorageStrategy): Promise<any>

        • Parameters

          Returns Promise<any>

    • getStoredAccessToken: ((resource, tokenStorageStrategy) => Promise<IAccessToken>)
    • handleResourceResponse: ((resource) => Promise<any>)
    • Optional options: IManifestoOptions

    Returns Promise<IExternalResource>

Static loadExternalResourceAuth1

  • loadExternalResourceAuth1(resource, openContentProviderInteraction, openTokenService, getStoredAccessToken, userInteractedWithContentProvider, getContentProviderInteraction, handleMovedTemporarily, showOutOfOptionsMessages): Promise<IExternalResource>

  • Parameters

    • resource: IExternalResource
    • openContentProviderInteraction: ((service) => any)
        • (service): any

        • Parameters

          Returns any

    • openTokenService: ((resource, tokenService) => Promise<void>)
    • getStoredAccessToken: ((resource) => Promise<null | IAccessToken>)
    • userInteractedWithContentProvider: ((contentProviderInteraction) => Promise<any>)
        • (contentProviderInteraction): Promise<any>

        • Parameters

          • contentProviderInteraction: any

          Returns Promise<any>

    • getContentProviderInteraction: ((resource, service) => Promise<any>)
    • handleMovedTemporarily: ((resource) => Promise<any>)
    • showOutOfOptionsMessages: ((resource, service) => void)

    Returns Promise<IExternalResource>

Static loadExternalResourcesAuth09

  • loadExternalResourcesAuth09(resources, tokenStorageStrategy, clickThrough, restricted, login, getAccessToken, storeAccessToken, getStoredAccessToken, handleResourceResponse, options?): Promise<IExternalResource[]>

  • Parameters

    • resources: IExternalResource[]
    • tokenStorageStrategy: string
    • clickThrough: ((resource) => Promise<any>)
    • restricted: ((resource) => Promise<any>)
    • login: ((resource) => Promise<any>)
    • getAccessToken: ((resource, rejectOnError) => Promise<IAccessToken>)
    • storeAccessToken: ((resource, token, tokenStorageStrategy) => Promise<any>)
        • (resource, token, tokenStorageStrategy): Promise<any>

        • Parameters

          Returns Promise<any>

    • getStoredAccessToken: ((resource, tokenStorageStrategy) => Promise<IAccessToken>)
    • handleResourceResponse: ((resource) => Promise<any>)
    • Optional options: IManifestoOptions

    Returns Promise<IExternalResource[]>

Static loadExternalResourcesAuth1

  • loadExternalResourcesAuth1(resources, openContentProviderInteraction, openTokenService, getStoredAccessToken, userInteractedWithContentProvider, getContentProviderInteraction, handleMovedTemporarily, showOutOfOptionsMessages): Promise<IExternalResource[]>

  • Parameters

    • resources: IExternalResource[]
    • openContentProviderInteraction: ((service) => any)
        • (service): any

        • Parameters

          Returns any

    • openTokenService: ((resource, tokenService) => Promise<any>)
    • getStoredAccessToken: ((resource) => Promise<null | IAccessToken>)
    • userInteractedWithContentProvider: ((contentProviderInteraction) => Promise<any>)
        • (contentProviderInteraction): Promise<any>

        • Parameters

          • contentProviderInteraction: any

          Returns Promise<any>

    • getContentProviderInteraction: ((resource, service) => Promise<any>)
    • handleMovedTemporarily: ((resource) => Promise<any>)
    • showOutOfOptionsMessages: ((resource, service) => void)

    Returns Promise<IExternalResource[]>

Static loadManifest

  • loadManifest(url): Promise<any>

  • Parameters

    • url: string

    Returns Promise<any>

Static normaliseType

  • normaliseType(type): string

  • Parameters

    • type: string

    Returns string

Static normaliseUrl

  • normaliseUrl(url): string

  • Parameters

    • url: string

    Returns string

Static normalisedUrlsMatch

  • normalisedUrlsMatch(url1, url2): boolean

  • Parameters

    • url1: string
    • url2: string

    Returns boolean

Static parseManifest

Static Private showAuthInteraction

  • showAuthInteraction(resource, tokenStorageStrategy, clickThrough, restricted, login, getAccessToken, storeAccessToken, resolve, reject): void

  • Parameters

    • resource: IExternalResource
    • tokenStorageStrategy: any
    • clickThrough: any
    • restricted: any
    • login: any
    • getAccessToken: any
    • storeAccessToken: any
    • resolve: any
    • reject: any

    Returns void

Static traverseAndFind

  • traverseAndFind(object, k, v): undefined | object

  • Does a depth first traversal of an Object, returning an Object that matches provided k and v arguments

    Parameters

    • object: any
    • k: string
    • v: string

    Returns undefined | object

    Example

    Utils.traverseAndFind({foo: 'bar'}, 'foo', 'bar')

Settings

Member Visibility

Theme

On This Page

constructorattemptResourceWithTokenauthorizecheckStatuscreateAuthorizationFailedErrorcreateErrorcreateInternalServerErrorcreateRestrictedErrordoAuthChaingenerateTreeNodeIdsgetImageQualitygetInexactLocalegetLocalisedValuegetMediaTypegetResourceByIdgetServicegetServicesgetTemporalComponentisImageProfileisImageServiceTypeisLevel0ImageProfileisLevel1ImageProfileisLevel2ImageProfileloadExternalResourceAuth09loadExternalResourceAuth1loadExternalResourcesAuth09loadExternalResourcesAuth1loadManifestnormaliseTypenormaliseUrlnormalisedUrlsMatchparseManifestshowAuthInteractiontraverseAndFind