Class IECSClientCallback

• Defined in File IECSClient.hpp

Nested Relationships

Nested Types

• Struct IECSClientCallback::ECSClientEventContext

Class Documentation

class Microsoft::Applications::Experimentation::ECS::IECSClientCallback

The IECSClientCallback class contains the callback interface for the ECS client to notify its listener of events when they occur.

Public Types

enum ECSClientEventType

The ECSClientEventType enumeration contains a set of values that specify the outcome of a configuration update.

Values:

enumerator ET_CONFIG_UPDATE_SUCCEEDED

The configuration update succeeded.

enumerator ET_CONFIG_UPDATE_FAILED

The configuration update failed.

Public Functions

virtual void OnECSClientEvent(ECSClientEventType evtType, ECSClientEventContext evtContext) = 0

A callback method for the ECSClient to notify its listener of configuration changes.

Parameters

• evtType – The type of the ECSClient event, specified using one of the ECSClientEventType enumeration values.

• evtContext – The context information of the ECSClient event, expressed as an ECSClientEventContext object.

struct ECSClientEventContext

The ECSClientEventContext structure contains the state of the ECS client event context.

Public Members

std::string clientName

A string that contains the name of the ECS client.

std::string clientVersion

A string that contains the ECS client version.

std::string userId

A string that contains the user ID.

std::string deviceId

A string that contains the device ID.

std::map<std::string, std::string> requestParameters

A key-value map that contains the list of request parameters.

unsigned int configExpiryTimeInSec

An unsigned integer that contains the configured expiry time in seconds.

bool configUpdateFromECS

A boolean that indicates whether the ECS configuration was updated from ECS.