public static class

TelemetryConfig.Builder

extends Object
java.lang.Object
   ↳ com.steerpath.sdk.telemetry.TelemetryConfig.Builder

Class Overview

Implements standard Builder for TelemetryConfig.

Summary

Public Constructors
Builder(Context context)
Default constructor.
Public Methods
TelemetryConfig.Builder accessToken(String apiKey)
Access token for telemetry services.
TelemetryConfig.Builder backgroundPolicy(TelemetryConfig.BackgroundPolicy backgroundPolicy)
Keep or don't keep Telemetry alive when hosting Activity is stopped.
TelemetryConfig.Builder baseUrl(String baseUrl)
Remote URL for telemetry services.
TelemetryConfig.Builder beaconLevel(TelemetryConfig.BeaconLevel level)
The level of beacon information that is collected.
TelemetryConfig build()
Builds new TelemetryConfig instance.
TelemetryConfig.Builder captureUri(String uri)
Sets capture-uri.
TelemetryConfig.Builder listsUri(String uri)
Sets lists-uri.
TelemetryConfig.Builder locationInterval(int intervalInSeconds)
Limits the frequency of collecting location data eg.
TelemetryConfig.Builder locationLevel(TelemetryConfig.LocationLevel level)
The level of location information that is collected.
TelemetryConfig.Builder transmissionInterval(int intervalInSeconds)
Frequency for sending telemetry data to remote services in seconds.
TelemetryConfig.Builder userId(String userId)
Identifier that will be sent along with telemetry data.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public Builder (Context context)

Default constructor.

Public Methods

public TelemetryConfig.Builder accessToken (String apiKey)

Access token for telemetry services.
Contact support@steerpath.com to learn how to gather telemetry data.

public TelemetryConfig.Builder backgroundPolicy (TelemetryConfig.BackgroundPolicy backgroundPolicy)

Keep or don't keep Telemetry alive when hosting Activity is stopped.
By default ACTIVITY. If PROCESS is used, TelemetryService will be alive even if application is backgrounded and application is responsible to stop when it sees fit.

public TelemetryConfig.Builder baseUrl (String baseUrl)

Remote URL for telemetry services. Base url can end with "/". Method name will be appended by the sdk.

Throws
IllegalArgumentException if uri is null

public TelemetryConfig.Builder beaconLevel (TelemetryConfig.BeaconLevel level)

The level of beacon information that is collected.
By default KNOWN

public TelemetryConfig build ()

Builds new TelemetryConfig instance.

public TelemetryConfig.Builder captureUri (String uri)

Sets capture-uri. You don't need to call this if you use baseUrl();

Throws
IllegalArgumentException if uri is null

public TelemetryConfig.Builder listsUri (String uri)

Sets lists-uri. You don't need to call this if you use baseUrl();

Throws
IllegalArgumentException if uri is null

public TelemetryConfig.Builder locationInterval (int intervalInSeconds)

Limits the frequency of collecting location data eg. users current location in seconds.
By default 30 seconds.

public TelemetryConfig.Builder locationLevel (TelemetryConfig.LocationLevel level)

The level of location information that is collected.
By default INDOOR

public TelemetryConfig.Builder transmissionInterval (int intervalInSeconds)

Frequency for sending telemetry data to remote services in seconds.
By default 30 minutes (1800 seconds)

public TelemetryConfig.Builder userId (String userId)

Identifier that will be sent along with telemetry data.
By default uses Secure.ANDROID_ID