Class BundleManager

Builds a bundle of rules on what to do while an offline map is active and applies them to outgoing network traffic.

Hierarchy

BundleManager

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new BundleManager(app: ViewerApplication, libraryId: string): BundleManager

- Defined in Mapping.Infrastructure.ts:27410
Parameters
- app: ViewerApplication
- libraryId: string
Returns BundleManager

Properties

app

app: ViewerApplication

libraryId

libraryId: string

Methods

createBundle

createBundle(bundleId: string, basemaps: BundleBuilderContextBasemap[], progress?: function): Promise<void>

- Defined in Mapping.Infrastructure.ts:27417
Download Offline Resources.

Parameters
- bundleId: string
  
  the ID that will be given to this bundle.
- basemaps: BundleBuilderContextBasemap[]
  
  information on how to direct basemap requests.
- Optional progress: function
  - - (progress: Progress): void
    - Parameters
      - progress: Progress
      Returns void
Returns Promise<void>

deleteBundle

deleteBundle(bundleId: string): Promise<void>

- Defined in Mapping.Infrastructure.ts:27422
Delete all resources stored for the given bundle.

Parameters
- bundleId: string
  
  The ID of the existing bundle.
Returns Promise<void>

getResource

getResource(key: string): string

- Defined in Mapping.Infrastructure.ts:27483
Parameters
- key: string
Returns string

getStoreResource

getStoreResource(bundleId: string, key: string): Promise<any>

- Defined in Mapping.Infrastructure.ts:27465
Parameters
- bundleId: string
- key: string
Returns Promise<any>

loadBundle

loadBundle(bundleId: string): Promise<void>

- Defined in Mapping.Infrastructure.ts:27434
Make the bundle with the given ID the active bundle. After the returned promise resolves future offline routing and resources will come from the bundle.

Parameters
- bundleId: string
Returns Promise<void>

setStoreResource

setStoreResource(bundleId: string, key: string, value: string): Promise<void>

- Defined in Mapping.Infrastructure.ts:27466
Parameters
- bundleId: string
- key: string
- value: string
Returns Promise<void>

unloadBundle

unloadBundle(): Promise<void>

- Defined in Mapping.Infrastructure.ts:27439
Return to a default state with no active bundle available. This should always be safe.

Returns Promise<void>

updateBundle

updateBundle(bundleId: string, basemaps: BundleBuilderContextBasemap[], progress?: function): Promise<void>

- Defined in Mapping.Infrastructure.ts:27428
Update all resources stored for the given bundle.

Parameters
- bundleId: string
  
  The ID of the existing bundle.
- basemaps: BundleBuilderContextBasemap[]
  
  information on how to direct basemap requests.
- Optional progress: function
  - - (progress: Progress): void
    - Parameters
      - progress: Progress
      Returns void
Returns Promise<void>

updatePrincipal

updatePrincipal(bundleId: string, principal: Principal): Promise<any>

- Defined in Mapping.Infrastructure.ts:27443
Updates the principal in the bundle and persists it.

Parameters
- bundleId: string
- principal: Principal
Returns Promise<any>