Home > @magiclane/maps-sdk > TrafficService > addPersistentRoadblockByCoordinates
TrafficService.addPersistentRoadblockByCoordinates() method
Add a user persistent roadblock to collection (path impact zone type).
If params.coords size == 1, a point located roadblock is defined - this may result in 2 real roadblocks for matched road both ways. If params.coords size > 1, a path located roadblock is defined - this will result in 1 map roadblock in start -> end way.
Signature:
static addPersistentRoadblockByCoordinates(params: {
coords: Coordinates[];
startTime: Date;
expireTime: Date;
transportMode: RouteTransportMode;
id: string;
}): Pair<TrafficEvent | null, GemError>;Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
params |
{ coords: Coordinates[]; startTime: Date; expireTime: Date; transportMode: RouteTransportMode; id: string; } |
The roadblock parameters. |
params properties:
- coords: Coordinates[]
The roadblock coordinates list.
- startTime: Date
The roadblock start time.
- expireTime: Date
The roadblock expire time.
- transportMode: RouteTransportMode
The transport mode for which the roadblock applies.
- id: string
The user roadblock id. Can be used to get / delete a defined roadblock.
Returns:
Pair<TrafficEvent | null, GemError>
The TrafficEvent object and GemError.success if successful, or null with error code if failed.