adsapi.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2017 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/ads/adtypes.h"
#include "twitchsdk/core/coreapi.h"
#include "twitchsdk/core/module.h"


namespace ttv
{
    class TaskRunner;

    namespace ads
    {
        class AdsAPI;
    }
}


class ttv::ads::AdsAPI : public ttv::ModuleBase
{
public:
    using FetchAdsCallback = std::function<void(TTV_ErrorCode ec, std::vector<Ad>&& result)>;
    using ReportAdEventsCallback = std::function<void(TTV_ErrorCode ec)>;

public:
    AdsAPI();
    virtual ~AdsAPI();

    // IModule implementation
    virtual std::string GetModuleName() const override;
    virtual TTV_ErrorCode Initialize(const InitializeCallback& callback) override;
    virtual TTV_ErrorCode Shutdown(const ShutdownCallback& callback) override;
    virtual TTV_ErrorCode Update() override; 

    TTV_ErrorCode SetCoreApi(const std::shared_ptr<CoreAPI>& coreApi);

    TTV_ErrorCode FetchAds(const AdConfiguration& config, const AdFetchRequestInfo& info, const FetchAdsCallback& callback);

    TTV_ErrorCode ReportAdEvent(const std::string& url, const std::map<std::string, std::string>& macroSubstitutions, const ReportAdEventsCallback& callback);

    TTV_ErrorCode ReportAdEvents(const std::vector<std::string>& urls, const std::map<std::string, std::string>& macroSubstitutions);

protected:
    // ModuleBase overrides
    virtual bool CheckShutdown() override;
    virtual void CompleteShutdown() override;

private:
    class CoreApiClient : public ICoreApiClient
    {
    public:
        // ICoreApiClient implementation
        virtual std::string GetClientName();
    };
        
    std::shared_ptr<CoreAPI> mCoreApi;
    std::shared_ptr<TaskRunner> mTaskRunner;
    std::shared_ptr<CoreApiClient> mCoreApiClient;
};