Constructors
Methods
StaticattemptResourceWithToken
- attemptResourceWithToken(resource, openTokenService, authService): Promise<void | IExternalResource>
Staticauthorize
- authorize(resource, tokenStorageStrategy, clickThrough, restricted, login, getAccessToken, storeAccessToken, getStoredAccessToken): Promise<IExternalResource>
StaticcheckStatus
- checkStatus(response): any
Returns any
StaticcreateAuthorizationFailedError
- createAuthorizationFailedError(): Error
Returns Error
StaticcreateError
- createError(name, message): Error
Returns Error
StaticcreateInternalServerError
- createInternalServerError(message): Error
Returns Error
StaticcreateRestrictedError
- createRestrictedError(): Error
Returns Error
StaticdoAuthChain
- doAuthChain(resource, openContentProviderInteraction, openTokenService, userInteractedWithContentProvider, getContentProviderInteraction, handleMovedTemporarily, showOutOfOptionsMessages): Promise<void | IExternalResource>
Parameters
- resource: IExternalResource
- openContentProviderInteraction: ((service: Service) => any)
- (service): any
Returns any
- openTokenService: ((resource: IExternalResource, tokenService: Service) => Promise<any>)
- (resource, tokenService): Promise<any>
Returns Promise<any>
- userInteractedWithContentProvider: ((contentProviderInteraction: any) => Promise<any>)
- (contentProviderInteraction): Promise<any>
Parameters
- contentProviderInteraction: any
Returns Promise<any>
- getContentProviderInteraction: ((resource: IExternalResource, service: Service) => Promise<any>)
- (resource, service): Promise<any>
Returns Promise<any>
- handleMovedTemporarily: ((resource: IExternalResource) => Promise<any>)
- (resource): Promise<any>
Returns Promise<any>
- showOutOfOptionsMessages: ((resource: IExternalResource, service: Service) => void)
- (resource, service): void
Returns void
StaticgenerateTreeNodeIds
- generateTreeNodeIds(treeNode, index?): void
Returns void
StaticgetImageQuality
- getImageQuality(profile): string
Returns string
StaticgetInexactLocale
- getInexactLocale(locale): string
Returns string
StaticgetLocalisedValue
- getLocalisedValue(resource, locale): null | string
Parameters
- resource: any
- locale: string
Returns null | string
StaticgetMediaType
- getMediaType(type): MediaType
Returns MediaType
StaticgetService
- getService(resource, profile): null | Service
Parameters
- resource: any
- profile: ServiceProfile
Returns null | Service
StaticgetServices
- getServices(resource, __namedParameters?): Service[]
Parameters
- resource: any
- __namedParameters: {
onlyService?: boolean;
onlyServices?: boolean;
skipParentResources?: boolean;
} = {}OptionalonlyService?: boolean
OptionalonlyServices?: boolean
OptionalskipParentResources?: boolean
StaticgetTemporalComponent
- getTemporalComponent(target): null | number[]
Returns null | number[]
StaticisImageProfile
- isImageProfile(profile): boolean
Returns boolean
StaticisImageServiceType
- isImageServiceType(type): boolean
Returns boolean
StaticisLevel0ImageProfile
- isLevel0ImageProfile(profile): boolean
Returns boolean
StaticisLevel1ImageProfile
- isLevel1ImageProfile(profile): boolean
Returns boolean
StaticisLevel2ImageProfile
- isLevel2ImageProfile(profile): boolean
Returns boolean
StaticloadExternalResourceAuth09
- loadExternalResourceAuth09(resource, tokenStorageStrategy, clickThrough, restricted, login, getAccessToken, storeAccessToken, getStoredAccessToken, handleResourceResponse, options?): Promise<IExternalResource>
StaticloadExternalResourceAuth1
- loadExternalResourceAuth1(resource, openContentProviderInteraction, openTokenService, getStoredAccessToken, userInteractedWithContentProvider, getContentProviderInteraction, handleMovedTemporarily, showOutOfOptionsMessages): Promise<IExternalResource>
Parameters
- resource: IExternalResource
- openContentProviderInteraction: ((service: Service) => any)
- (service): any
Returns any
- openTokenService: ((resource: IExternalResource, tokenService: Service) => Promise<void>)
- (resource, tokenService): Promise<void>
Returns Promise<void>
- getStoredAccessToken: ((resource: IExternalResource) => Promise<null | IAccessToken>)
- userInteractedWithContentProvider: ((contentProviderInteraction: any) => Promise<any>)
- (contentProviderInteraction): Promise<any>
Parameters
- contentProviderInteraction: any
Returns Promise<any>
- getContentProviderInteraction: ((resource: IExternalResource, service: Service) => Promise<any>)
- (resource, service): Promise<any>
Returns Promise<any>
- handleMovedTemporarily: ((resource: IExternalResource) => Promise<any>)
- (resource): Promise<any>
Returns Promise<any>
- showOutOfOptionsMessages: ((resource: IExternalResource, service: Service) => void)
- (resource, service): void
Returns void
StaticloadExternalResourcesAuth09
- loadExternalResourcesAuth09(resources, tokenStorageStrategy, clickThrough, restricted, login, getAccessToken, storeAccessToken, getStoredAccessToken, handleResourceResponse, options?): Promise<IExternalResource[]>
StaticloadExternalResourcesAuth1
- loadExternalResourcesAuth1(resources, openContentProviderInteraction, openTokenService, getStoredAccessToken, userInteractedWithContentProvider, getContentProviderInteraction, handleMovedTemporarily, showOutOfOptionsMessages): Promise<IExternalResource[]>
Parameters
- resources: IExternalResource[]
- openContentProviderInteraction: ((service: Service) => any)
- (service): any
Returns any
- openTokenService: ((resource: IExternalResource, tokenService: Service) => Promise<any>)
- (resource, tokenService): Promise<any>
Returns Promise<any>
- getStoredAccessToken: ((resource: IExternalResource) => Promise<null | IAccessToken>)
- userInteractedWithContentProvider: ((contentProviderInteraction: any) => Promise<any>)
- (contentProviderInteraction): Promise<any>
Parameters
- contentProviderInteraction: any
Returns Promise<any>
- getContentProviderInteraction: ((resource: IExternalResource, service: Service) => Promise<any>)
- (resource, service): Promise<any>
Returns Promise<any>
- handleMovedTemporarily: ((resource: IExternalResource) => Promise<any>)
- (resource): Promise<any>
Returns Promise<any>
- showOutOfOptionsMessages: ((resource: IExternalResource, service: Service) => void)
- (resource, service): void
Returns void
StaticloadManifest
- loadManifest(url): Promise<any>
Returns Promise<any>
StaticnormalisedUrlsMatch
- normalisedUrlsMatch(url1, url2): boolean
Returns boolean
StaticnormaliseType
- normaliseType(type): string
Returns string
StaticnormaliseUrl
- normaliseUrl(url): string
Returns string
StatictraverseAndFind
- traverseAndFind(object, k, v): undefined | object
Parameters
- object: any
- k: string
- v: string
Returns undefined | object
Does a depth first traversal of an Object, returning an Object that matches provided k and v arguments