class CoverageClientFactory (Niantic.ARDK.VPSCoverage.CoverageClientFactory)

Overview

Factory to create CoverageClient instances. More…

class CoverageClientFactory {
public:
    // methods

    static ICoverageClient Create();

    static ICoverageClient Create(
        RuntimeEnvironment env,
        VpsCoverageResponses mockResponses = null
    );
};

Detailed Documentation

Factory to create CoverageClient instances.

Methods

static ICoverageClient Create()

Create an ICoverageLoader implementation appropriate for the current device.

On a mobile device, the attempted order will be LiveDevice, Remote, and finally Mock. In the Unity Editor, the attempted order will be Remote, then Mock.

Returns:

The created loader, or throws if it was not possible to create a loader.

static ICoverageClient Create(
    RuntimeEnvironment env,
    VpsCoverageResponses mockResponses = null
)

Create an ICoverageLoader with the specified RuntimeEnvironment.

Parameters:

env	The env used to create the loader for.
mockResponses	A ScriptableObject containing the data that a Mock implementation of the ICoverageClient will return. This is a required argument for using the mock client on a mobile device. It is optional in the Unity Editor; the mock client will simply use the data provided in the ARDK/VirtualStudio/VpsCoverage/VPS Coverage Responses.asset file.

Returns:

The created loader, or null if it was not possible to create a loader.