Class TrafficService

Traffic service. Adds support to update traffic information.

Index

Constructors

Accessors

persistentRoadblockListener persistentRoadblocks preferences transferStatistics

Methods

addAntiPersistentRoadblockByArea addPersistentRoadblockByArea addPersistentRoadblockByCoordinates getOnlineServiceRestrictions getPersistentRoadblock getPersistentRoadblockPathPreview removeAllPersistentRoadblocks removePersistentRoadblockByCoordinates removePersistentRoadblockById removeUserRoadblock

Constructors

constructor

new TrafficService(): TrafficService
Returns TrafficService

Accessors

`Static`persistentRoadblockListener

set persistentRoadblockListener(listener: PersistentRoadblockListener): void
Set persistent roadblocks listener
Parameters
- listener: PersistentRoadblockListener
  The listener to be set
Returns void
- Defined in core/traffic.ts:1118

`Static`persistentRoadblocks

get persistentRoadblocks(): TrafficEvent[]
Get all persistent user roadblocks

Returns TrafficEvent[]
The list of persistent user roadblocks
- Defined in core/traffic.ts:1056

`Static`preferences

get preferences(): TrafficPreferences
Gets access to the traffic service preferences.

Returns TrafficPreferences
The traffic service preferences
- Defined in core/traffic.ts:836

`Static`transferStatistics

get transferStatistics(): TransferStatistics
Gets data transfer statistics for this service.

Returns TransferStatistics
The data transfer statistics
- Defined in core/traffic.ts:859

Methods

`Static`addAntiPersistentRoadblockByArea

addAntiPersistentRoadblockByArea(
    params: {
        area: GeographicArea;
        expireTime: Date;
        id: string;
        startTime: Date;
        transportMode: RouteTransportMode;
    },
): Pair<TrafficEvent | null, GemError>
Add a user persistent anti-area roadblock to collection.
Parameters
- params: {
      area: GeographicArea;
      expireTime: Date;
      id: string;
      startTime: Date;
      transportMode: RouteTransportMode;
  }
  The roadblock parameters.
  - area: GeographicArea
    The geographic area not affected by the roadblock, i.e. the anti-area (world wide - area) is the roadblock.
  - expireTime: Date
    The roadblock expire time.
  - id: string
    The user roadblock id. Can be used to get / delete a defined roadblock.
  - startTime: Date
    The roadblock start time.
  - transportMode: RouteTransportMode
    The transport mode for which the roadblock applies.
Returns Pair<TrafficEvent | null, GemError>
The TrafficEvent object and GemError.success if successful, or null with error code if failed.
- Defined in core/traffic.ts:964

`Static`addPersistentRoadblockByArea

addPersistentRoadblockByArea(
    params: {
        area: GeographicArea;
        expireTime: Date;
        id: string;
        startTime: Date;
        transportMode: RouteTransportMode;
    },
): Pair<TrafficEvent | null, GemError>
Add a user persistent roadblock to collection (area impact zone type).
Parameters
- params: {
      area: GeographicArea;
      expireTime: Date;
      id: string;
      startTime: Date;
      transportMode: RouteTransportMode;
  }
  The roadblock parameters.
  - area: GeographicArea
    The geographic area affected by the roadblock.
  - expireTime: Date
    The roadblock expire time.
  - id: string
    The user roadblock id. Can be used to get / delete a defined roadblock.
  - startTime: Date
    The roadblock start time.
  - transportMode: RouteTransportMode
    The transport mode for which the roadblock applies.
Returns Pair<TrafficEvent | null, GemError>
The TrafficEvent object and GemError.success if successful, or null with error code if failed.
- Defined in core/traffic.ts:923

`Static`addPersistentRoadblockByCoordinates

addPersistentRoadblockByCoordinates(
    params: {
        coords: Coordinates[];
        expireTime: Date;
        id: string;
        startTime: Date;
        transportMode: RouteTransportMode;
    },
): Pair<TrafficEvent | null, GemError>
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.
Parameters
- params: {
      coords: Coordinates[];
      expireTime: Date;
      id: string;
      startTime: Date;
      transportMode: RouteTransportMode;
  }
  The roadblock parameters.
  - coords: Coordinates[]
    The roadblock coordinates list.
  - expireTime: Date
    The roadblock expire time.
  - id: string
    The user roadblock id. Can be used to get / delete a defined roadblock.
  - startTime: Date
    The roadblock start time.
  - transportMode: RouteTransportMode
    The transport mode for which the roadblock applies.
Returns Pair<TrafficEvent | null, GemError>
The TrafficEvent object and GemError.success if successful, or null with error code if failed.
- Defined in core/traffic.ts:882

`Static`getOnlineServiceRestrictions

getOnlineServiceRestrictions(coords: Coordinates): TrafficOnlineRestrictions
Gets the online traffic service restrictions for the given position
Parameters
- coords: Coordinates
  The position
Returns TrafficOnlineRestrictions
The online traffic service restrictions
- Defined in core/traffic.ts:846

`Static`getPersistentRoadblock

getPersistentRoadblock(id: string): TrafficEvent | null
Get an user persistent roadblock identified by id
Parameters
- id: string
  The roadblock id as it was provided in addPersistentRoadblock function
Returns TrafficEvent | null
The roadblock if found, null otherwise
- Defined in core/traffic.ts:1037

`Static`getPersistentRoadblockPathPreview

getPersistentRoadblockPathPreview(
    params: {
        from: UserRoadblockPathPreviewCoordinate;
        to: Coordinates;
        transportMode: RouteTransportMode;
    },
): [Coordinates[], UserRoadblockPathPreviewCoordinate, GemError]
Get persistent roadblock path preview.
Parameters
- params: {
      from: UserRoadblockPathPreviewCoordinate;
      to: Coordinates;
      transportMode: RouteTransportMode;
  }
  The preview parameters.
  - from: UserRoadblockPathPreviewCoordinate
    The previous defined coordinates in roadblock path from where to start the preview.
  - to: Coordinates
    The movable coordinate in roadblock path to where the preview ends.
  - transportMode: RouteTransportMode
    The transport mode.
Returns [Coordinates[], UserRoadblockPathPreviewCoordinate, GemError]
A tuple containing: the coordinates list preview of the roadblock path, the next roadblock point match suggestion, and the error code.
- Defined in core/traffic.ts:1088

`Static`removeAllPersistentRoadblocks

removeAllPersistentRoadblocks(): void
Remove all user persistent roadblock

Returns void
- Defined in core/traffic.ts:1027

`Static`removePersistentRoadblockByCoordinates

removePersistentRoadblockByCoordinates(coords: Coordinates): GemError
Remove an user persistent roadblock identified by a reference coordinate ( for path impact zone type )
Parameters
- coords: Coordinates
  The roadblock start coordinates. Must be equal with first coordinate in coords list provided when the roadblock was defined
Returns GemError
GemError.success on success, GemError.notFound if the roadblock does not exist
- Defined in core/traffic.ts:1015

`Static`removePersistentRoadblockById

removePersistentRoadblockById(id: string): GemError
Remove an user persistent roadblock identified by id
Parameters
- id: string
  The roadblock id as it was provided in addPersistentRoadblock function
Returns GemError
GemError.success on success, GemError.notFound if the roadblock does not exist
- Defined in core/traffic.ts:1000

`Static`removeUserRoadblock

removeUserRoadblock(event: TrafficEvent): void
Remove an user roadblock ( persistent or non-persistent )
Parameters
- event: TrafficEvent
  The roadblock to be removed
Returns void
- Defined in core/traffic.ts:1071

Class TrafficService

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns TrafficService

Accessors

StaticpersistentRoadblockListener

Parameters

Returns void

StaticpersistentRoadblocks

Returns TrafficEvent[]

Staticpreferences

Returns TrafficPreferences

StatictransferStatistics

Returns TransferStatistics

Methods

StaticaddAntiPersistentRoadblockByArea

Parameters

area: GeographicArea

expireTime: Date

id: string

startTime: Date

transportMode: RouteTransportMode

Returns Pair<TrafficEvent | null, GemError>

StaticaddPersistentRoadblockByArea

Parameters

area: GeographicArea

expireTime: Date

id: string

startTime: Date

transportMode: RouteTransportMode

Returns Pair<TrafficEvent | null, GemError>

StaticaddPersistentRoadblockByCoordinates

Parameters

coords: Coordinates[]

expireTime: Date

id: string

startTime: Date

transportMode: RouteTransportMode

Returns Pair<TrafficEvent | null, GemError>

StaticgetOnlineServiceRestrictions

Parameters

Returns TrafficOnlineRestrictions

StaticgetPersistentRoadblock

Parameters

Returns TrafficEvent | null

StaticgetPersistentRoadblockPathPreview

Parameters

from: UserRoadblockPathPreviewCoordinate

to: Coordinates

transportMode: RouteTransportMode

Returns [Coordinates[], UserRoadblockPathPreviewCoordinate, GemError]

StaticremoveAllPersistentRoadblocks

Returns void

StaticremovePersistentRoadblockByCoordinates

Parameters

Returns GemError

StaticremovePersistentRoadblockById

Parameters

Returns GemError

StaticremoveUserRoadblock

Parameters

Returns void

Settings

On This Page

`Static`persistentRoadblockListener

`Static`persistentRoadblocks

`Static`preferences

`Static`transferStatistics

`Static`addAntiPersistentRoadblockByArea

`Static`addPersistentRoadblockByArea

`Static`addPersistentRoadblockByCoordinates

`Static`getOnlineServiceRestrictions

`Static`getPersistentRoadblock

`Static`getPersistentRoadblockPathPreview

`Static`removeAllPersistentRoadblocks

`Static`removePersistentRoadblockByCoordinates

`Static`removePersistentRoadblockById

`Static`removeUserRoadblock