aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/directory.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/directory.h')
0 files changed, 0 insertions, 0 deletions
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-17 13:33:59 +0000
2 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 
/******************************************************************************
 * THIS FILE IS GENERATED - ANY EDITS WILL BE OVERWRITTEN
 */

#pragma once

#include "converters.h"

#include <QtCore/QHash>
#include <QtCore/QJsonObject>
#include <QtCore/QVector>

namespace Quotient
{

// Data structures

/// Definition of valid values for a field.
struct FieldType
{
    /// A regular expression for validation of a field's value. This may be
    /// relativelycoarse to verify the value as the application service
    /// providing this protocolmay apply additional validation or filtering.
    QString regexp;
    /// An placeholder serving as a valid example of the field value.
    QString placeholder;
};

template <>
struct JsonObjectConverter<FieldType>
{
    static void dumpTo(QJsonObject& jo, const FieldType& pod);
    static void fillFrom(const QJsonObject& jo, FieldType& pod);
};

struct ProtocolInstance
{
    /// A human-readable description for the protocol, such as the name.
    QString desc;
    /// An optional content URI representing the protocol. Overrides the one
    /// providedat the higher level Protocol object.
    QString icon;
    /// Preset values for ``fields`` the client may use to search by.
    QJsonObject fields;
    /// A unique identifier across all instances.
    QString networkId;
};

template <>
struct JsonObjectConverter<ProtocolInstance>
{
    static void dumpTo(QJsonObject& jo, const ProtocolInstance& pod);
    static void fillFrom(const QJsonObject& jo, ProtocolInstance& pod);
};

struct ThirdPartyProtocol
{
    /// Fields which may be used to identify a third party user. These should
    /// beordered to suggest the way that entities may be grouped, where
    /// highergroupings are ordered first. For example, the name of a network
    /// should besearched before the nickname of a user.
    QStringList userFields;
    /// Fields which may be used to identify a third party location. These
    /// should beordered to suggest the way that entities may be grouped, where
    /// highergroupings are ordered first. For example, the name of a network
    /// should besearched before the name of a channel.
    QStringList locationFields;
    /// A content URI representing an icon for the third party protocol.
    QString icon;
    /// The type definitions for the fields defined in the ``user_fields`` and
    /// ``location_fields``. Each entry in those arrays MUST have an entry here.
    /// The``string`` key for this object is field name itself.May be an empty
    /// object if no fields are defined.
    QHash<QString, FieldType> fieldTypes;
    /// A list of objects representing independent instances of
    /// configuration.For example, multiple networks on IRC if multiple are
    /// provided by thesame application service.
    QVector<ProtocolInstance> instances;
};

template <>
struct JsonObjectConverter<ThirdPartyProtocol>
{
    static void dumpTo(QJsonObject& jo, const ThirdPartyProtocol& pod);
    static void fillFrom(const QJsonObject& jo, ThirdPartyProtocol& pod);
};

} // namespace Quotient