PlayermoderationApi class
Properties
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
clearAllPlayerModerations({CancelToken? cancelToken, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress})
→ Future<Response<Success>>
-
Clear All Player Moderations
⚠️ This will delete every single player moderation you've ever made.
-
deletePlayerModeration({required String playerModerationId, CancelToken? cancelToken, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress})
→ Future<Response<Success>>
-
Delete Player Moderation
Deletes a specific player moderation based on it's `pmod_` ID. The website uses `unmoderateUser` instead. You can delete the same player moderation multiple times successfully.
-
getPlayerModeration({required String playerModerationId, CancelToken? cancelToken, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress})
→ Future<Response<PlayerModeration>>
-
Get Player Moderation
Returns a single Player Moderation. This returns the exact same amount of information as the more generalised `getPlayerModerations`.
-
getPlayerModerations({String? type, String? targetUserId, CancelToken? cancelToken, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress})
→ Future<Response<List<PlayerModeration>>>
-
Search Player Moderations
Returns a list of all player moderations made by you. This endpoint does not have pagination, and will return all results. Use query parameters to limit your query if needed.
-
moderateUser({required ModerateUserRequest moderateUserRequest, CancelToken? cancelToken, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress})
→ Future<Response<PlayerModeration>>
-
Moderate User
Moderate a user, e.g. unmute them or show their avatar. Please see the Player Moderation docs on what playerModerations are, and how they differ from staff moderations.
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
toString()
→ String
-
A string representation of this object.
inherited
-
unmoderateUser({required ModerateUserRequest moderateUserRequest, CancelToken? cancelToken, ValidateStatus? validateStatus, ProgressCallback? onSendProgress, ProgressCallback? onReceiveProgress})
→ Future<Response<Success>>
-
Unmoderate User
Removes a player moderation previously added through `moderateUser`. E.g if you previously have shown their avatar, but now want to reset it to default.