Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-04-06 22:43:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add docs for ban functionality.

Browse source
This commit is contained in:
Kalila L 2021-03-19 04:44:58 -04:00
parent fd592dfb06
commit f067feb37a
2 changed files with 23 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
libraries/script-engine/src/UsersScriptingInterface.h
View file

@ -33,6 +33,10 @@
* <code>false</code>. <em>Read-only.</em>
* @property {boolean} requestsDomainListData - <code>true</code> if the client requests extra data from the mixers (such as
* positional data of an avatar they've ignored). <em>Read-only.</em>
* @property {BanFlags} NO_BAN - Do not ban person. <em>Read-only.</em>
* @property {BanFlags} BAN_BY_USERNAME - Ban person by username. <em>Read-only.</em>
* @property {BanFlags} BAN_BY_FINGERPRINT - Ban person by fingerprint. <em>Read-only.</em>
* @property {BanFlags} BAN_BY_IP - Ban person by IP address. <em>Read-only.</em>
*/
class UsersScriptingInterface : public QObject, public Dependency {
Q_OBJECT
@ -118,8 +122,8 @@ public slots:
float getAvatarGain(const QUuid& nodeID);
/**jsdoc
* Kicks and bans a user. This removes them from the server and prevents them from returning. The ban is by user name if
* available and by machine fingerprint. The ban functionality can be controlled with flags.
* Kicks and bans a user. This removes them from the server and prevents them from returning. The ban is by user name (if
* available) and by machine fingerprint. The ban functionality can be controlled with flags.
* <p>This function only works if you're an administrator of the domain you're in.</p>
* @function Users.kick
* @param {Uuid} sessionID - The session ID of the user to kick and ban.

17
libraries/shared/src/ModerationFlags.h
View file

@ -14,6 +14,23 @@
class ModerationFlags {
public:
/**jsdoc
* <p>A set of flags for moderation ban actions. The value is constructed by using the <code>|</code> (bitwise OR) operator on the
* individual flag values.</p>
* <table>
* <thead>
* <tr><th>Flag Name</th><th>Value</th><th>Description</th></tr>
* </thead>
* <tbody>
* <tr><td>NO_BAN</td><td><code>0</code></td><td>Don't ban user when kicking. <em>This does not currently have an effect.</em></td></tr>
* <tr><td>BAN_BY_USERNAME</td><td><code>1</code></td><td>Ban the person by their username.</td></tr>
* <tr><td>BAN_BY_FINGERPRINT</td><td><code>2</code></td><td>Ban the person by their machine fingerprint.</td></tr>
* <tr><td>BAN_BY_IP</td><td><code>4</code></td><td>Ban the person by their IP address.</td></tr>
* </tbody>
* </table>
* @typedef {number} BanFlags
*/
enum BanFlags
{
NO_BAN = 0,