CampaignsProvider

Overview

The API of the CampaignsProvider service provides functionality to request campaigns, manage campaign handlers and parameters for handling campaigns.

RegisterCampaignHandler

void RegisterCampaignHandler(ICampaignHandler handler)

Registers your custom campaign handler. See ICampaignHandler for detailed description.

GetCampaign

[CanBeNull]
ICampaign GetCampaign(
    string @event,
    Dictionary<string, object> @params = null
)

Finds a campaign based on the event and parameters.

IsCampaignAvailable

bool IsCampaignAvailable(
    string campaignName,
    string @event,
    Dictionary<string, object> @params = null
)

Checks if a campaign is available for the specified event and parameters.

SetParam

void SetParam(
    string @event,
    string param,
    object value
)

Set the parameter value for the target event. This parameter will be added to all following campaign requests.

SetParams

void SetParams(
    string @event,
    IReadOnlyDictionary<string, object> @params
)

Set all the parameters values for the target event. These parameters will be added to all following campaign requests.

SetUniversalParam

void SetUniversalParam(string param, object value)

Sets a universal parameter applicable to all events. This parameter will be added to all following campaign requests.

SetUniversalParams

void SetUniversalParams(IReadOnlyDictionary<string, object> @params)

Sets multiple universal parameters applicable to all events. These parameters will be added to all following campaign requests.

RemoveParam

void RemoveParam(string @event, string param)

Removes a parameter for a specific event.

RemoveAllParams

void RemoveAllParams(string @event)

Removes all parameters for a specific event.

RemoveUniversalParam

void RemoveUniversalParam(string param)

Removes a universal parameter.

RemoveAllUniversalParams

void RemoveAllUniversalParams()

Removes all universal parameters.