eventrelation.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2022 Kitsune Ral <kitsune-ral@users.sf.net>
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <Quotient/converters.h>
 
namespace Quotient {
 
constexpr inline auto RelatesToKey = "m.relates_to"_L1;
constexpr inline auto RelTypeKey = "rel_type"_L1;
constexpr inline auto IsFallingBackKey = "is_falling_back"_L1;
constexpr inline auto NewContentKey = "m.new_content"_L1;
constexpr inline auto RelationsKey = "m.relations"_L1;
 
//! \brief Data about one relation of an event to an upstream event (e.g. a reply or a reaction)
//!
//! This structure contains all information pertaining to a single event relation. In terms of
//! CS API it corresponds to the contents of `m.relates_to` and `m.in_reply_to` JSON objects.
struct QUOTIENT_API EventRelation {
    using typeid_t = QLatin1String;
    using reltypeid_t [[deprecated("Use typeid_t")]] = typeid_t;
 
    QString type;
    QString eventId;
    QString key = {}; // Only used for m.annotation for now
    bool isFallingBack = false;
    // Only used for m.thread to provide the reply event fallback for non-threaded clients
    // or to allow a reply within the thread.
    QString inThreadReplyEventId = {};
 
    static constexpr auto ReplyType = "m.in_reply_to"_L1;
    static constexpr auto AnnotationType = "m.annotation"_L1;
    static constexpr auto ReplacementType = "m.replace"_L1;
    static constexpr auto ThreadType = "m.thread"_L1;
 
    static EventRelation replyTo(QString eventId)
    {
        return { ReplyType, std::move(eventId) };
    }
    static EventRelation annotate(QString eventId, QString key)
    {
        return { AnnotationType, std::move(eventId), std::move(key) };
    }
    static EventRelation replace(QString eventId)
    {
        return { ReplacementType, std::move(eventId) };
    }
    static EventRelation replyInThread(QString threadRootId, bool isFallingBack,
                                       QString inThreadReplyEventId)
    {
        return {
            ThreadType, std::move(threadRootId), {}, isFallingBack, std::move(inThreadReplyEventId)
        };
    }
};
 
template <>
struct QUOTIENT_API JsonObjectConverter<EventRelation> {
    static void dumpTo(QJsonObject& jo, const EventRelation& pod);
    static void fillFrom(const QJsonObject& jo, EventRelation& pod);
};
 
} // namespace Quotient