Package 

Interface Moderation

  • 
public interface Moderation

    Controller exposing moderation functionalities.

    • Method Summary

      Modifier and Type Method Description
      abstract Result<BanResponse> ban(BanRequest banRequest) Bans a user from the platform.
      abstract Result<MuteResponse> mute(MuteRequest muteRequest) Mutes one or more users.
      abstract Result<BlockUsersResponse> blockUser(BlockUsersRequest blockUserRequest) Blocks a user.
      abstract Result<UnblockUsersResponse> unblockUser(UnblockUsersRequest unblockUserRequest) Unblocks a user.
      abstract Result<GetBlockedUsersResponse> getBlockedUsers() Gets the list of blocked users.
      abstract Result<FlagResponse> flag(FlagRequest flagRequest) Flags content for moderation review.
      abstract Result<SubmitActionResponse> submitAction(SubmitActionRequest submitActionRequest) Submits a moderation action.
      abstract Result<QueryReviewQueueResponse> queryReviewQueue(QueryReviewQueueRequest queryReviewQueueRequest) Queries the moderation review queue.
      abstract Result<UpsertConfigResponse> upsertConfig(UpsertConfigRequest upsertConfigRequest) Upserts a moderation configuration.
      abstract Result<DeleteModerationConfigResponse> deleteConfig(String key, String team) Deletes a moderation configuration.
      abstract Result<GetConfigResponse> getConfig(String key, String team) Gets a moderation configuration.
      abstract Result<QueryModerationConfigsResponse> queryModerationConfigs(QueryModerationConfigsRequest queryModerationConfigsRequest) Queries moderation configurations.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • ban

         abstract Result<BanResponse> ban(BanRequest banRequest)

        Bans a user from the platform.

        Parameters:
        banRequest - The ban request containing details about the user to ban and ban parameters.

      • mute

         abstract Result<MuteResponse> mute(MuteRequest muteRequest)

        Mutes one or more users.

        Parameters:
        muteRequest - The mute request containing target user IDs and optional timeout.

      • blockUser

         abstract Result<BlockUsersResponse> blockUser(BlockUsersRequest blockUserRequest)

        Blocks a user.

        Parameters:
        blockUserRequest - The request containing the user ID to block.

      • unblockUser

         abstract Result<UnblockUsersResponse> unblockUser(UnblockUsersRequest unblockUserRequest)

        Unblocks a user.

        Parameters:
        unblockUserRequest - The request containing the user ID to unblock.

      • getBlockedUsers

         abstract Result<GetBlockedUsersResponse> getBlockedUsers()

        Gets the list of blocked users.

      • flag

         abstract Result<FlagResponse> flag(FlagRequest flagRequest)

        Flags content for moderation review.

        Parameters:
        flagRequest - The flag request containing details about the content to flag.

      • submitAction

         abstract Result<SubmitActionResponse> submitAction(SubmitActionRequest submitActionRequest)

        Submits a moderation action.

        Parameters:
        submitActionRequest - The action request containing details about the moderation action.

      • queryReviewQueue

         abstract Result<QueryReviewQueueResponse> queryReviewQueue(QueryReviewQueueRequest queryReviewQueueRequest)

        Queries the moderation review queue.

        Parameters:
        queryReviewQueueRequest - The query request containing filters and pagination parameters.

      • upsertConfig

         abstract Result<UpsertConfigResponse> upsertConfig(UpsertConfigRequest upsertConfigRequest)

        Upserts a moderation configuration.

        Parameters:
        upsertConfigRequest - The configuration request containing the config to upsert.

      • deleteConfig

         abstract Result<DeleteModerationConfigResponse> deleteConfig(String key, String team)

        Deletes a moderation configuration.

        Parameters:
        key - The key of the configuration to delete.
        team - Optional team identifier.

      • getConfig

         abstract Result<GetConfigResponse> getConfig(String key, String team)

        Gets a moderation configuration.

        Parameters:
        key - The key of the configuration to retrieve.
        team - Optional team identifier.

      • queryModerationConfigs

         abstract Result<QueryModerationConfigsResponse> queryModerationConfigs(QueryModerationConfigsRequest queryModerationConfigsRequest)

        Queries moderation configurations.

        Parameters:
        queryModerationConfigsRequest - The query request containing filters and pagination parameters.