IOrganizationGeoCollectionsService
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Service for managing organization-level custom geo collections.
export interface IOrganizationGeoCollectionsService
Remarks
Importing geo data into a collection follows a three-step workflow: 1. Upload a file via IOrganizationGeoCollectionsService.uploadGeoCollectionFile() 2. Convert it via IOrganizationGeoCollectionsService.convertGeoCollectionFile() 3. Import it via IOrganizationGeoCollectionsService.importGeoCollectionFile()
Methods
Method | Description |
|---|---|
(ALPHA) Convert a staged geo file into an importable format. | |
(ALPHA) Create a new custom geo collection. | |
(ALPHA) Delete a custom geo collection. | |
(ALPHA) Get all custom geo collections. | |
(ALPHA) Get a single custom geo collection by its identifier. | |
(ALPHA) Import a staged and converted file into a geo collection. | |
(ALPHA) Update an existing custom geo collection. | |
(ALPHA) Upload a file to staging for subsequent import into a geo collection. |
Method details
IOrganizationGeoCollectionsService.convertGeoCollectionFile()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Convert a staged geo file into an importable format.
convertGeoCollectionFile(location: string): Promise<IGeoCollectionFileUploadResult>;
Parameters
Parameter | Type | Description |
|---|---|---|
location | string | staging location from a previous upload |
Returns
Promise<IGeoCollectionFileUploadResult>
Promise resolved with the converted file location reference.
IOrganizationGeoCollectionsService.createGeoCollection()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Create a new custom geo collection.
createGeoCollection(definition: IGeoCollectionDefinition): Promise<IGeoCollection>;
Parameters
Parameter | Type | Description |
|---|---|---|
definition | definition of the geo collection to create |
Returns
Promise<IGeoCollection>
Promise resolved with created geo collection including its generated id.
IOrganizationGeoCollectionsService.deleteGeoCollection()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Delete a custom geo collection.
deleteGeoCollection(id: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | identifier of the geo collection to delete |
Returns
Promise<void>
IOrganizationGeoCollectionsService.getAll()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get all custom geo collections.
getAll(): Promise<IGeoCollection[]>;
Returns
Promise<IGeoCollection[]>
Promise resolved with array of geo collections.
IOrganizationGeoCollectionsService.getGeoCollection()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Get a single custom geo collection by its identifier.
getGeoCollection(id: string): Promise<IGeoCollection | undefined>;
Parameters
Parameter | Type | Description |
|---|---|---|
id | string | identifier of the geo collection |
Returns
Promise<IGeoCollection | undefined>
Promise resolved with the geo collection, or undefined if not found.
IOrganizationGeoCollectionsService.importGeoCollectionFile()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Import a staged and converted file into a geo collection.
importGeoCollectionFile(collectionId: string, location: string): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
collectionId | string | identifier of the target geo collection |
location | string | location of the converted file to import |
Returns
Promise<void>
IOrganizationGeoCollectionsService.updateGeoCollection()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Update an existing custom geo collection.
updateGeoCollection(geoCollection: IGeoCollection): Promise<IGeoCollection>;
Parameters
Parameter | Type | Description |
|---|---|---|
geoCollection | geo collection with updated properties |
Returns
Promise<IGeoCollection>
Promise resolved with updated geo collection.
IOrganizationGeoCollectionsService.uploadGeoCollectionFile()methodAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
Upload a file to staging for subsequent import into a geo collection.
uploadGeoCollectionFile(file: File): Promise<IGeoCollectionFileUploadResult>;
Parameters
Parameter | Type | Description |
|---|---|---|
file | File | geo data file to upload |
Returns
Promise<IGeoCollectionFileUploadResult>
Promise resolved with the staging location reference.