0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-25 06:53:58 +01:00
construct/include/ircd/m/app.h
2019-01-18 14:54:04 -08:00

87 lines
2.6 KiB
C++

// Matrix Construct
//
// Copyright (C) Matrix Construct Developers, Authors & Contributors
// Copyright (C) 2016-2018 Jason Volk <jason@zemos.net>
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice is present in all copies. The
// full license for this software is available in the LICENSE file.
#pragma once
#define HAVE_IRCD_M_APP_H
namespace ircd::m::app
{
struct namespace_;
struct namespaces;
struct registration;
}
struct ircd::m::app::namespace_
:json::tuple
<
/// Required. A true or false value stating whether this application
/// service has exclusive access to events within this namespace.
json::property<name::exclusive, bool>,
/// Required. A regular expression defining which values this namespace
/// includes.
json::property<name::regex, json::string>
>
{
using super_type::tuple;
};
struct ircd::m::app::namespaces
:json::tuple
<
/// Events which are sent from certain users.
json::property<name::users, namespace_>,
/// Events which are sent in rooms with certain room aliases.
json::property<name::aliases, namespace_>,
/// Events which are sent in rooms with certain room IDs.
json::property<name::rooms, namespace_>
>
{
using super_type::tuple;
};
struct ircd::m::app::registration
:json::tuple
<
/// Required. A unique, user-defined ID of the application service which
/// will never change.
json::property<name::id, json::string>,
/// Required. The URL for the application service. May include a path
/// after the domain name. Optionally set to null if no traffic is
/// required.
json::property<name::url, json::string>,
/// Required. A unique token for application services to use to
/// authenticate requests to Homeservers.
json::property<name::as_token, json::string>,
/// Required. A unique token for Homeservers to use to authenticate
/// requests to application services.
json::property<name::hs_token, json::string>,
/// Required. The localpart of the user associated with the application
/// service.
json::property<name::sender_localpart, json::string>,
/// Required. A list of users, aliases and rooms namespaces that the application service controls.
json::property<name::namespaces, namespaces>,
/// Whether requests from masqueraded users are rate-limited. The sender is excluded.
json::property<name::rate_limited, bool>,
/// The external protocols which the application service provides (e.g. IRC).
json::property<name::protocols, json::array>
>
{
using super_type::tuple;
};