Class RoadClosures

Methods for dealing with RoadClosures.

Hierarchy

SdkModule
- RoadClosures

Index

Methods

addClosure getAll getById

Methods

addClosure

addClosure(
    args: {
        description: string;
        endDate: number;
        fromNodeClosed: boolean;
        isForward: boolean;
        isPermanent: boolean;
        segmentId: number;
        startDate: number;
        trafficEventId: null | string;
    },
): RoadClosure
Adds a new road closure to the WME data model.
Parameters
- args: {
      description: string;
      endDate: number;
      fromNodeClosed: boolean;
      isForward: boolean;
      isPermanent: boolean;
      segmentId: number;
      startDate: number;
      trafficEventId: null | string;
  }
Returns RoadClosure
the created road closure.

Throws
DataModelNotFoundError if the specified segment cannot be found in the data model.

Throws
DataModelNotFoundError if the trafficEventId is provided and cannot be found in the data model.

getAll

getAll(): RoadClosure[]
Returns RoadClosure[]
an array of all the road closures in the WME data model

getById

getById(args: { roadClosureId: string }): null | RoadClosure
Parameters
- args: { roadClosureId: string }
  - roadClosureId: string
    An id of the road closure to find.
Returns null | RoadClosure
road closure with id, or null if not found in the WME data model