Home Manual Reference Source Repository

Variable

Static Public Summary
public

Enum containing the possible different values for RequestParameters#deleted

public

Enum containing the possible different visibilities for a JobShare

public

Enum containing the possible different values for RequestParameters#deleted

Static Public

public DeletedState: Enum source

import {DeletedState} from '@mapcreator/api/src/enums/DeletedState.js'

Enum containing the possible different values for RequestParameters#deleted

Properties:

NameTypeAttributeDescription
ALL string

Don't discriminate between deleted items and non-deleted resources

BOTH string

Don't discriminate between deleted items and non-deleted resources

NONE string

Don't return deleted resources

ONLY string

Only return deleted resources

public JobShareVisibility: Enum source

import {JobShareVisibility} from '@mapcreator/api/src/enums/JobShareVisibility.js'

Enum containing the possible different visibilities for a JobShare

Properties:

NameTypeAttributeDescription
PRIVATE string

Anyone outside of the organisation could open the map, the map is not visible within the organisation folder

PUBLIC string

Anyone who has that link can open the map

ORGANISATION string

This map only opens if a user is within the same organisation

public ResultStatus: Enum source

import {ResultStatus} from '@mapcreator/api/src/enums/ResultStatus.js'

Enum containing the possible different values for RequestParameters#deleted

Properties:

NameTypeAttributeDescription
QUEUED string

Job has been queued

PROCESSING string

Job is processing

COMPLETED string

Job has been completed

CANCELED string

Job has been canceled

FAILED string

Job has failed