socialapi.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-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/core/coreapi.h"
#include "twitchsdk/core/module.h"
#include "twitchsdk/social/socialtypes.h"
#include "twitchsdk/social/socialerrortypes.h"

#include <memory>

namespace ttv
{
    class TaskRunner;
    class UserRepository;

    namespace social
    {
        class SocialAPI;
        class ISocialAPIListener;
        class FriendList;
        class Presence;

        struct SocialAPIInternalData;
    }
}


class ttv::social::SocialAPI : public ModuleBase
{
public:
    using PostPresenceCallback = std::function<void(TTV_ErrorCode ec)>;
    using FetchPresenceSettingsCallback = std::function<void(TTV_ErrorCode ec, const PresenceSettings& settings)>;
    using SetPresenceSettingsCallback = std::function<void(TTV_ErrorCode ec)>;
    using FetchFriendListCallback = std::function<void(TTV_ErrorCode ec, const std::vector<Friend>& friends)>;
    using UpdateFriendshipCallback = std::function<void(TTV_ErrorCode ec, UpdateFriendResult result, FriendStatus status)>;
    using FetchFriendRequestsCallback = std::function<void(TTV_ErrorCode ec, const std::vector<FriendRequest>& requests)>;
    using FetchUnreadFriendRequestCountCallback = std::function<void(TTV_ErrorCode ec, uint32_t requestCount)>;
    using MarkAllFriendRequestsReadCallback = std::function<void(TTV_ErrorCode ec)>;
    using FetchFriendStatusCallback = std::function<void(TTV_ErrorCode ec, FriendStatus status)>;
    using FetchRecommendedFriendsCallback = std::function<void(TTV_ErrorCode ec, const std::vector<UserInfo>& recommendedFriends)>;
    using DismissRecommendedFriendCallback = std::function<void(TTV_ErrorCode ec)>;
    
    SocialAPI();
    virtual ~SocialAPI();

    // 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 SetListener(const std::shared_ptr<ISocialAPIListener>& listener);
    TTV_ErrorCode SetEnabledFeatures(const FeatureFlags& features);

    TTV_ErrorCode PostPresence(UserId userId, const PostPresenceCallback& callback);
    
    TTV_ErrorCode SetPresenceSessionAvailability(UserId userId, PresenceSessionAvailability availability);
    
    TTV_ErrorCode AddWatchingActivity(UserId userId, ChannelId channelId, PresenceActivityToken& activityToken);
    
    TTV_ErrorCode AddPlayingActivity(UserId userId, GameId gameId, const std::string& gameDisplayContext, PresenceActivityToken& activityToken);
    
    TTV_ErrorCode RemoveActivity(UserId userId, PresenceActivityToken activityToken);
    
    TTV_ErrorCode FetchPresenceSettings(UserId userId, const FetchPresenceSettingsCallback& callback);
    
    TTV_ErrorCode SetPresenceSettings(UserId userId, const PresenceSettings& settings, const SetPresenceSettingsCallback& callback);
    
    TTV_ErrorCode SetAutomaticPresencePostingEnabled(UserId userId, bool enabled);
    
    TTV_ErrorCode GetAutomaticPresencePostingEnabled(UserId userId, bool& enabled);
    
    TTV_ErrorCode FetchFriendList(UserId userId, const FetchFriendListCallback& callback);
    
    TTV_ErrorCode UpdateFriendship(UserId userId, UserId otherUserId, FriendAction action, const UpdateFriendshipCallback& callback);
    
    TTV_ErrorCode FetchFriendRequests(UserId userId, const FetchFriendRequestsCallback& callback);
    
    TTV_ErrorCode FetchUnreadFriendRequestCount(UserId userId, const FetchUnreadFriendRequestCountCallback& callback);
    
    TTV_ErrorCode MarkAllFriendRequestsRead(UserId userId, const MarkAllFriendRequestsReadCallback& callback);
    
    TTV_ErrorCode FetchFriendStatus(UserId userId, UserId otherUserId, const FetchFriendStatusCallback& callback);
    
    TTV_ErrorCode FetchRecommendedFriends(UserId userId, const FetchRecommendedFriendsCallback& callback);
    
    TTV_ErrorCode DismissRecommendedFriend(UserId userId, UserId dismissUserId, const DismissRecommendedFriendCallback& callback);

private:
    class CoreApiClient : public ICoreApiClient
    {
    public:
        CoreApiClient(SocialAPI* api);

        // ICoreApiClient implementation
        virtual std::string GetClientName();
        virtual void GetRequiredOAuthScopes(std::vector<std::string>& scopes);
        virtual void CoreUserLoggedIn(std::shared_ptr<User> user);
        virtual void CoreUserLoggedOut(std::shared_ptr<User> user);

    private:
        SocialAPI* mApi;
    };

    // ICoreApiClient implementation
    void CoreUserLoggedIn(std::shared_ptr<User> user);
    void CoreUserLoggedOut(std::shared_ptr<User> user);

    TTV_ErrorCode GetPresenceForUser(UserId userId, std::shared_ptr<Presence>& presence);
    TTV_ErrorCode GetFriendListForUser(UserId userId, std::shared_ptr<FriendList>& friendList);
    
    void CreateFriendListListener();
    void CreatePresenceListener();

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

    std::shared_ptr<CoreAPI> mCoreApi;
    std::shared_ptr<ICoreApiClient> mCoreApiClient;
    
    std::shared_ptr<SocialAPIInternalData> mInternalData;
    std::shared_ptr<UserRepository> mUserRepository;
    std::shared_ptr<TaskRunner> mTaskRunner;

    FeatureFlags mEnabledFeatures;
};