Class TileDataServiceConfiguration

Groups configuration values passed to TileDataService<T> instances used when running a Pipeline. Different configuration values may be used in a regular pipeline run versus tests, editor tooling and so on.

Inheritance
object
TileDataServiceConfiguration
Implements
Namespace: Holoride.ElasticSDK
Assembly: Holoride.ElasticSDK.Library.Runtime.dll
Syntax
public class TileDataServiceConfiguration : IGenerationSettings

Constructors

TileDataServiceConfiguration()

Creates a new, uninitialized set of configuration values.

Declaration
public TileDataServiceConfiguration()

TileDataServiceConfiguration(TileDataServiceConfiguration)

Creates a copy of the specified configuration set.

Useful for creating copies of the default configuration, when only overwriting a subset of the available configuration values. 

var config = new TileDataServiceConfiguration(TileDataServiceConfiguration.Default)
{
    LogDownloadURLs = true,
};
Declaration
public TileDataServiceConfiguration(TileDataServiceConfiguration copyFrom)
Parameters
Type Name Description
TileDataServiceConfiguration copyFrom

The configuration to initialize the defaults from.

Fields

CachedFileUpdateInterval

Time to wait until a cached file will try to update itself.

Declaration
public TimeSpan CachedFileUpdateInterval
Field Value
Type Description
TimeSpan

LogDownloadURLs

Whether to log URLs of downloaded tile data for easier debugging.

Declaration
[Obsolete]
public bool LogDownloadURLs
Field Value
Type Description
bool

MapServiceCredentials

Credentials used to authenticate with the tile data server. Used in cases where we don't have an access token.

Declaration
public string MapServiceCredentials
Field Value
Type Description
string

QueryMapServiceAccessTokenFunc

Function to query the current AccessToken that is used to authenticate with the tile data server.

Declaration
public Func<string> QueryMapServiceAccessTokenFunc
Field Value
Type Description
Func<string>

ReadableCacheDirectories

A list of directories with previously downloaded tile data.

In the default configuration, this includes the mutable on-device cache as well as a set of application embedded, pre-downloaded set of data.

Usually should also contain the WritableCacheDirectory.

Declaration
public string[] ReadableCacheDirectories
Field Value
Type Description
string[]

WritableCacheDirectory

A directory to which to save downloaded tile data, typically a subdirectory of the persistentDataPath.

Usually should also be present in the ReadableCacheDirectories.

Declaration
public string WritableCacheDirectory
Field Value
Type Description
string

Properties

MapServiceAccessToken

Gets the access token used to authenticate with the tile data server.

Declaration
public string MapServiceAccessToken { get; }
Property Value
Type Description
string

Methods

WaitForMapCredentials(CancellationToken)

Declaration
public UniTask WaitForMapCredentials(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Cysharp.Threading.Tasks.UniTask

Implements