Class MapUpdateRequests

Methods for dealing with MapUpdateRequests.

Hierarchy

SdkModule
- MapUpdateRequests

Index

Methods

addComment getAll getById getUpdateRequestDetails updateResolutionState

Methods

addComment

addComment(
args: { mapUpdateRequestId: number; text: string },
): Promise<ConversationElement>
Adds a comment to the map update request.
Parameters
- args: { mapUpdateRequestId: number; text: string }
Returns Promise<ConversationElement>
A promise that resolves to a created conversation element representing the comment.

Throws
DataModelNotFoundError if there is no comments session in the WME data model.

getAll

getAll(): MapUpdateRequest[]
Returns MapUpdateRequest[]
an array of all the map update requests in the WME data model

getById

getById(args: { mapUpdateRequestId: number }): null | MapUpdateRequest
Parameters
- args: { mapUpdateRequestId: number }
  - mapUpdateRequestId: number
    An id of the map update request to find.
Returns null | MapUpdateRequest
map update request with id, or null if not found in the WME data model

getUpdateRequestDetails

getUpdateRequestDetails(
args: { mapUpdateRequestId: number },
): Promise<null | UpdateRequestDetails>
Parameters
- args: { mapUpdateRequestId: number }
Returns Promise<null | UpdateRequestDetails>
map update request details. If details are not present in the WME data model, they will be fetched. Returns null if not found in the WME data model.

Throws
WMEError if fetching details fails.

updateResolutionState

updateResolutionState(
    args: {
        mapUpdateRequestId: number;
        resolutionState: UpdateableMapProblemState;
    },
): void
Updates the problem resolution state of a map update request.
Parameters
- args: { mapUpdateRequestId: number; resolutionState: UpdateableMapProblemState }
Returns void
Throws
DataModelNotFoundError if the map update request is not found.