XmppPresence.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "XmppConnection.h"
 
namespace EXmppPresenceStatus
{
    enum Type
    {
        // online while connected
        Online,
        // offline if not connected
        Offline,
        // online but away due to being afk or manually set
        Away,
        // online but away for a long period or manually set
        ExtendedAway,
        // manually set to avoid interruptions
        DoNotDisturb,
        // currently chatting. implies online
        Chat
    };
 
    inline const TCHAR* ToString(EXmppPresenceStatus::Type EnumVal)
    {
        switch (EnumVal)
        {
            case Online:
                return TEXT("Online");
            case Offline:
                return TEXT("Offline");
            case Away:
                return TEXT("Away");
            case ExtendedAway:
                return TEXT("ExtendedAway");
            case DoNotDisturb:
                return TEXT("DoNotDisturb");
            case Chat:
                return TEXT("Chat");
        }
        return TEXT("");
    }
}
 
class FXmppUserPresence
{
public:
    EXmppPresenceStatus::Type Status = EXmppPresenceStatus::Offline;
    bool bIsAvailable = true;
    FDateTime SentTime = FDateTime::MinValue();
    FDateTime ReceivedTime = FDateTime::MinValue();
    FString AppId;
    FString Platform;
    FString StatusStr;
    FXmppUserJid UserJid;
 
    inline bool operator==(const FXmppUserPresence& Presence) const
    {
        // SentTime is explicitly not checked
        return Status == Presence.Status &&
            bIsAvailable == Presence.bIsAvailable &&
            AppId == Presence.AppId &&
            Platform == Presence.Platform &&
            StatusStr == Presence.StatusStr &&
            UserJid == Presence.UserJid;
    }
    inline bool operator!=(const FXmppUserPresence& Presence) const
    {
        return !(*this == Presence);
    }
};
 
class FXmppMucPresence : public FXmppUserPresence
{
public:
    FXmppMucPresence()
        : FXmppUserPresence()
    {}
 
    FString Role;
    FString Affiliation;
    FXmppUserJid MemberJid;
 
    const FString& GetRoomId() const { return UserJid.Id; }
    const FString& GetNickName() const { return UserJid.Resource; }
};
 
class IXmppPresence
{
public:
 
    virtual ~IXmppPresence() {}
 
    virtual bool UpdatePresence(const FXmppUserPresence& Presence) = 0;
 
    virtual const FXmppUserPresence& GetPresence() const = 0;
 
    virtual bool QueryPresence(const FString& UserId) = 0;
 
    virtual void GetRosterMembers(TArray<FXmppUserJid>& OutMembers) = 0;
 
    virtual TArray<TSharedPtr<FXmppUserPresence>> GetRosterPresence(const FString& UserId) = 0;
 
    DECLARE_MULTICAST_DELEGATE_ThreeParams(FOnXmppPresenceReceived, const TSharedRef<IXmppConnection>& /*Connection*/, const FXmppUserJid& /*FromJid*/, const TSharedRef<FXmppUserPresence>& /*Presence*/);
    virtual FOnXmppPresenceReceived& OnReceivePresence() = 0;
};