Class UpdateRequest

Hierarchy (View Summary)

Constructors

constructor

Properties

editable fid? requestBounds? ALL_PERMISSIONS

Methods

arePropertiesEditable arePropertiesSuggestible canEdit changeID clone getAttribute getAttributes getCenterLonLat getCenterPoint getClonedGeometry getCreatedBy getCreatedOn getDriveDate getGeometry getID getIsInBbox getIsRead getIsStarred getLocation getMapIssueId getOLGeometry getOpenState getPermissions getPrevID getRequestBounds getResolutionState getResolvedOn getSeverity getSource getState getSuggestionPermissions getType getTypeText getUniqueID getUniqueIdentifier getUpdatedBy getUpdatedOn getVersion hasGeometry hasPermissionFlag isAllowed isAllowedForSuggestion isDeleteable isDeleted isDeleteSuggestible isGeometryEditable isGeometrySuggestible isInserted isInUse isNew isOutOfScope isRecentlyClosed isSelected isSnapped isUnchanged isUpdated merge resetOutOfScope setAttribute setAttributes setGeometry setID setIsInBboxToTrue setOLGeometry setOutOfScope setSelected setSnapped setState setVersion wasCreatedBy

Constructors

constructor

Properties

editable

editable: boolean = true

Optionalfid

fid?: ObjectId

OptionalrequestBounds

requestBounds?: BBox

StaticALL_PERMISSIONS

ALL_PERMISSIONS: number = 0x7fffffff

Methods

arePropertiesEditable

arePropertiesSuggestible

canEdit

changeID

  • changeID(newID: number): void

    Parameters

    • newID: number

    Returns void

clone

getAttribute

  • getAttribute<
        TAttributeKey extends
            | "createdBy"
            | "id"
            | "createdOn"
            | "description"
            | "permissions"
            | "updatedBy"
            | "updatedOn"
            | "suggestionPermissions"
            | "type"
            | "geoJSONGeometry"
            | "bounds"
            | "open"
            | "resolution"
            | "resolvedOn"
            | "isRead"
            | "isStarred"
            | "mapIssueId"
            | "activeHovSubscriptions"
            | "avoidDangerousTurns"
            | "avoidFerries"
            | "avoidPrimaries"
            | "avoidTolls"
            | "avoidTrails"
            | "hasEv"
            | "isEmailVerified"
            | "licensePlateSuffix"
            | "os"
            | "reporterLanguage"
            | "vehicleType"
            | "driveDate"
            | "hasComments"
            | "localDriveTime"
            | "source"
            | "typeText"
            | "resolvedBy",
    >(
        key: TAttributeKey,
    ): UpdateRequestAttributes[TAttributeKey]

    Type Parameters

    • TAttributeKey extends
          | "createdBy"
          | "id"
          | "createdOn"
          | "description"
          | "permissions"
          | "updatedBy"
          | "updatedOn"
          | "suggestionPermissions"
          | "type"
          | "geoJSONGeometry"
          | "bounds"
          | "open"
          | "resolution"
          | "resolvedOn"
          | "isRead"
          | "isStarred"
          | "mapIssueId"
          | "activeHovSubscriptions"
          | "avoidDangerousTurns"
          | "avoidFerries"
          | "avoidPrimaries"
          | "avoidTolls"
          | "avoidTrails"
          | "hasEv"
          | "isEmailVerified"
          | "licensePlateSuffix"
          | "os"
          | "reporterLanguage"
          | "vehicleType"
          | "driveDate"
          | "hasComments"
          | "localDriveTime"
          | "source"
          | "typeText"
          | "resolvedBy"

    Parameters

    Returns UpdateRequestAttributes[TAttributeKey]

getAttributes

getCenterLonLat

getCenterPoint

  • getCenterPoint(): Point

    Returns a center point of the geometry. If the geometry is not a LineString returns an absolute center. Otherwise, returns the nearest point on a line to an absolute center

    Returns Point

getClonedGeometry

getCreatedBy

getCreatedOn

getDriveDate

  • getDriveDate(): number

    Returns number

getGeometry

getID

getIsInBbox

getIsRead

getIsStarred

getLocation

getMapIssueId

getOLGeometry

  • getOLGeometry(): Point

    Returns Point

    Deprecated

    The OpenLayers.Geometry is deprecated, please use the GeoJSON getGeometry() instead.

getOpenState

getPermissions

getPrevID

getRequestBounds

getResolutionState

getResolvedOn

getSeverity

getSource

getState

getSuggestionPermissions

getType

getTypeText

  • getTypeText(): string

    Returns string

getUniqueID

getUniqueIdentifier

getUpdatedBy

getUpdatedOn

getVersion

hasGeometry

hasPermissionFlag

  • hasPermissionFlag(
        key:
            | "NO_PERMISSION"
            | "EDIT_GEOMETRY"
            | "EDIT_PROPERTIES"
            | "DELETE"
            | "EDIT_EMPTY_STREET"
            | "SPLIT_DIRECTIONS"
            | "SET_UNKNOWN_DIRECTIONS"
            | "EDIT_HOUSE_NUMBERS"
            | "FORCE_HOUSE_NUMBERS"
            | "EDIT_CONNECTIONS"
            | "EDIT_ROUTING_ROAD_TYPE"
            | "EDIT_CLOSURES"
            | "EDIT_HEADLIGHTS_REMINDER"
            | "EDIT_AVERAGE_SPEED_CAMERA"
            | "EDIT_BEACONS"
            | "EDIT_DIRECTIONS"
            | "EDIT_TURN_GUIDANCE"
            | "EDIT_OPEN_TURNS"
            | "EDIT_CLOSE_TURNS"
            | "EDIT"
            | "FORCE_CLOSE"
            | "PUBLISH"
            | "SET_READY"
            | "EDIT_UPDATE_REQUESTS"
            | "EDIT_EXTERNAL_PROVIDERS",
    ): boolean

    Parameters

    • key:
          | "NO_PERMISSION"
          | "EDIT_GEOMETRY"
          | "EDIT_PROPERTIES"
          | "DELETE"
          | "EDIT_EMPTY_STREET"
          | "SPLIT_DIRECTIONS"
          | "SET_UNKNOWN_DIRECTIONS"
          | "EDIT_HOUSE_NUMBERS"
          | "FORCE_HOUSE_NUMBERS"
          | "EDIT_CONNECTIONS"
          | "EDIT_ROUTING_ROAD_TYPE"
          | "EDIT_CLOSURES"
          | "EDIT_HEADLIGHTS_REMINDER"
          | "EDIT_AVERAGE_SPEED_CAMERA"
          | "EDIT_BEACONS"
          | "EDIT_DIRECTIONS"
          | "EDIT_TURN_GUIDANCE"
          | "EDIT_OPEN_TURNS"
          | "EDIT_CLOSE_TURNS"
          | "EDIT"
          | "FORCE_CLOSE"
          | "PUBLISH"
          | "SET_READY"
          | "EDIT_UPDATE_REQUESTS"
          | "EDIT_EXTERNAL_PROVIDERS"

    Returns boolean

isAllowed

  • isAllowed(permission: number): boolean

    Parameters

    • permission: number

    Returns boolean

isAllowedForSuggestion

isDeleteable

isDeleted

isDeleteSuggestible

isGeometryEditable

isGeometrySuggestible

  • isGeometrySuggestible(): boolean

    Whether the current user can suggest a geometry change for the object

    Returns boolean

isInserted

isInUse

  • isInUse(
        options?: { keepSelected?: boolean; keepUnsaved?: boolean },
    ): undefined | boolean

    Returns true if object is currently in use and should not be deleted.

    Parameters

    • options: { keepSelected?: boolean; keepUnsaved?: boolean } = ...

      See DataModelRepository.clear for available options

    Returns undefined | boolean

    true if object is in use

isNew

isOutOfScope

isRecentlyClosed

isSelected

isSnapped

isUnchanged

isUpdated

merge

resetOutOfScope

setAttribute

  • setAttribute<
        TAttributeKey extends
            | "createdBy"
            | "id"
            | "createdOn"
            | "description"
            | "permissions"
            | "updatedBy"
            | "updatedOn"
            | "suggestionPermissions"
            | "type"
            | "geoJSONGeometry"
            | "bounds"
            | "open"
            | "resolution"
            | "resolvedOn"
            | "isRead"
            | "isStarred"
            | "mapIssueId"
            | "activeHovSubscriptions"
            | "avoidDangerousTurns"
            | "avoidFerries"
            | "avoidPrimaries"
            | "avoidTolls"
            | "avoidTrails"
            | "hasEv"
            | "isEmailVerified"
            | "licensePlateSuffix"
            | "os"
            | "reporterLanguage"
            | "vehicleType"
            | "driveDate"
            | "hasComments"
            | "localDriveTime"
            | "source"
            | "typeText"
            | "resolvedBy",
    >(
        key: TAttributeKey,
        value: UpdateRequestAttributes[TAttributeKey],
    ): void

    Type Parameters

    • TAttributeKey extends
          | "createdBy"
          | "id"
          | "createdOn"
          | "description"
          | "permissions"
          | "updatedBy"
          | "updatedOn"
          | "suggestionPermissions"
          | "type"
          | "geoJSONGeometry"
          | "bounds"
          | "open"
          | "resolution"
          | "resolvedOn"
          | "isRead"
          | "isStarred"
          | "mapIssueId"
          | "activeHovSubscriptions"
          | "avoidDangerousTurns"
          | "avoidFerries"
          | "avoidPrimaries"
          | "avoidTolls"
          | "avoidTrails"
          | "hasEv"
          | "isEmailVerified"
          | "licensePlateSuffix"
          | "os"
          | "reporterLanguage"
          | "vehicleType"
          | "driveDate"
          | "hasComments"
          | "localDriveTime"
          | "source"
          | "typeText"
          | "resolvedBy"

    Parameters

    Returns void

setAttributes

setGeometry

setID

  • setID(id: number): void

    Parameters

    • id: number

    Returns void

setIsInBboxToTrue

setOLGeometry

  • setOLGeometry(olGeometry: Point): void

    Parameters

    Returns void

    Deprecated

    The OpenLayers.Geometry is deprecated, please use the GeoJSON setGeometry() instead.

setOutOfScope

setSelected

  • setSelected(isSelected: boolean): void

    Parameters

    • isSelected: boolean

    Returns void

setSnapped

  • setSnapped(isSnapped: boolean): void

    Parameters

    • isSnapped: boolean

    Returns void

setState

setVersion

  • setVersion(version: number): void

    Parameters

    • version: number

    Returns void

wasCreatedBy

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
arePropertiesEditablearePropertiesSuggestiblecanEditchangeIDclonegetAttributegetAttributesgetCenterLonLatgetCenterPointgetClonedGeometrygetCreatedBygetCreatedOngetDriveDategetGeometrygetIDgetIsInBboxgetIsReadgetIsStarredgetLocationgetMapIssueIdgetOLGeometrygetOpenStategetPermissionsgetPrevIDgetRequestBoundsgetResolutionStategetResolvedOngetSeveritygetSourcegetStategetSuggestionPermissionsgetTypegetTypeTextgetUniqueIDgetUniqueIdentifiergetUpdatedBygetUpdatedOngetVersionhasGeometryhasPermissionFlagisAllowedisAllowedForSuggestionisDeleteableisDeletedisDeleteSuggestibleisGeometryEditableisGeometrySuggestibleisInsertedisInUseisNewisOutOfScopeisRecentlyClosedisSelectedisSnappedisUnchangedisUpdatedmergeresetOutOfScopesetAttributesetAttributessetGeometrysetIDsetIsInBboxToTruesetOLGeometrysetOutOfScopesetSelectedsetSnappedsetStatesetVersionwasCreatedBy