Class TrafficPreferences

Traffic Preferences

This class should not be instantiated directly. Use the TrafficService.preferences getter to get an instance.

Hierarchy

GemAutoreleaseObject
- TrafficPreferences

Index

Constructors

Accessors

pointerId useTraffic

Methods

registerAutoReleaseObject init

Constructors

constructor

new TrafficPreferences(id?: number): TrafficPreferences
Parameters
- id: number = -1
Returns TrafficPreferences
Overrides GemAutoreleaseObject.constructor
- Defined in core/traffic.ts:725

Accessors

pointerId

get pointerId(): number
Returns number
- Defined in core/traffic.ts:737

useTraffic

get useTraffic(): TrafficUsage
Get the type of traffic service that is used.

Returns TrafficUsage
The traffic service usage type
- Defined in core/traffic.ts:745
set useTraffic(useTraffic: TrafficUsage): void
Enable/disable traffic service Default is UseOnline
Parameters
- useTraffic: TrafficUsage
  The traffic service usage type
Returns void
- Defined in core/traffic.ts:755

Methods

`Protected`registerAutoReleaseObject

registerAutoReleaseObject(pointerId: any): void
Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.
Parameters
- pointerId: any
  The pointer ID to register
Returns void
Inherited from GemAutoreleaseObject.registerAutoReleaseObject
- Defined in core/gemautoreleaseobject.ts:24

`Static`init

init(id: number): TrafficPreferences
Parameters
- id: number
Returns TrafficPreferences
- Defined in core/traffic.ts:733