mirror of
https://github.com/VCMP-SqMod/SqMod.git
synced 2024-11-08 08:47:17 +01:00
115 lines
3.3 KiB
C++
115 lines
3.3 KiB
C++
/************************************************************************************
|
|
*
|
|
* D++, A Lightweight C++ library for Discord
|
|
*
|
|
* Copyright 2021 Craig Edwards and D++ contributors
|
|
* (https://github.com/brainboxdotcc/DPP/graphs/contributors)
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*
|
|
************************************************************************************/
|
|
#pragma once
|
|
#include <dpp/export.h>
|
|
#include <dpp/snowflake.h>
|
|
#include <dpp/json_fwd.h>
|
|
#include <dpp/stage_instance.h>
|
|
#include <unordered_map>
|
|
#include <dpp/json_interface.h>
|
|
|
|
namespace dpp {
|
|
|
|
/**
|
|
* @brief Represents an invite to a discord guild or channel
|
|
*/
|
|
class DPP_EXPORT invite : public json_interface<invite> {
|
|
public:
|
|
/** Invite code
|
|
*/
|
|
std::string code;
|
|
/** Readonly expiration timestamp of this invite or 0 if the invite doesn't expire
|
|
* @note Only returned from cluster::invite_get
|
|
*/
|
|
time_t expires_at;
|
|
/** Guild ID this invite is for
|
|
*/
|
|
snowflake guild_id;
|
|
/** Channel ID this invite is for
|
|
*/
|
|
snowflake channel_id;
|
|
/** User ID who created this invite
|
|
*/
|
|
snowflake inviter_id;
|
|
/** The user ID whose stream to display for this voice channel stream invite
|
|
*/
|
|
snowflake target_user_id;
|
|
/** Target type
|
|
*/
|
|
uint8_t target_type;
|
|
/** Approximate number of online users
|
|
* @note Only returned from cluster::invite_get
|
|
*/
|
|
uint32_t approximate_presence_count;
|
|
/** Approximate number of total users online and offline
|
|
* @note Only returned from cluster::invite_get
|
|
*/
|
|
uint32_t approximate_member_count;
|
|
/** Duration (in seconds) after which the invite expires, or 0 for no expiration. Must be between 0 and 604800 (7 days). Defaults to 86400 (1 day)
|
|
*/
|
|
uint32_t max_age;
|
|
/** Maximum number of uses, or 0 for unlimited. Must be between 0 and 100. Defaults to 0
|
|
*/
|
|
uint32_t max_uses;
|
|
/** Whether this invite only grants temporary membership
|
|
*/
|
|
bool temporary;
|
|
/** True if this invite should not replace or "attach to" similar invites
|
|
*/
|
|
bool unique;
|
|
/** How many times this invite has been used
|
|
*/
|
|
uint32_t uses;
|
|
/** The stage instance data if there is a public stage instance in the stage channel this invite is for
|
|
* @deprecated Deprecated
|
|
*/
|
|
stage_instance stage;
|
|
/** Timestamp at which the invite was created
|
|
*/
|
|
time_t created_at;
|
|
|
|
/** Constructor
|
|
*/
|
|
invite();
|
|
|
|
/** Destructor
|
|
*/
|
|
virtual ~invite() = default;
|
|
|
|
/** Read class values from json object
|
|
* @param j A json object to read from
|
|
* @return A reference to self
|
|
*/
|
|
invite& fill_from_json(nlohmann::json* j);
|
|
|
|
/** Build JSON from this object.
|
|
* @param with_id Include ID in JSON
|
|
* @return The JSON text of the invite
|
|
*/
|
|
virtual std::string build_json(bool with_id = false) const;
|
|
|
|
};
|
|
|
|
/** A container of invites */
|
|
typedef std::unordered_map<std::string, invite> invite_map;
|
|
|
|
};
|