Package io.getstream.chat.java.services

Interface ModerationService

public interface ModerationService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Moderation.AppealResponse>	appeal(@NotNull Moderation.AppealRequestData appealRequestData)
retrofit2.Call<Moderation.BanResponse>	ban(@NotNull Moderation.BanRequestData banRequestData)
retrofit2.Call<Moderation.BlockResponse>	block(@NotNull Moderation.BlockRequestData blockRequestData)
retrofit2.Call<Moderation.BulkImageModerationResponse>	bulkImageModeration(@NotNull Moderation.BulkImageModerationRequestData bulkImageModerationRequestData)
retrofit2.Call<Moderation.BulkSubmitActionResponse>	bulkSubmitAction(@NotNull Moderation.BulkSubmitActionRequestData bulkSubmitActionRequestData)
retrofit2.Call<Moderation.CheckResponse>	check(@NotNull Moderation.CheckRequestData checkRequestData)
retrofit2.Call<Moderation.CustomCheckResponse>	customCheck(@NotNull Moderation.CustomCheckRequestData customCheckRequestData)
retrofit2.Call<StreamResponseObject>	deleteConfig(@NotNull java.lang.String key)
retrofit2.Call<StreamResponseObject>	deleteModerationRule(@NotNull java.lang.String id)
retrofit2.Call<StreamResponseObject>	deleteModerationTemplate(@NotNull java.lang.String name, @Nullable java.lang.String team)
retrofit2.Call<Moderation.ExportModerationLogsResponse>	exportModerationLogs(@NotNull Moderation.ExportModerationLogsRequestData exportModerationLogsRequestData)
retrofit2.Call<Moderation.FlagResponse>	flag(@NotNull Moderation.FlagRequestData flagRequestData)
retrofit2.Call<Moderation.GetAppealResponse>	getAppeal(@NotNull java.lang.String id)
retrofit2.Call<Moderation.ConfigGetResponse>	getConfig(@NotNull java.lang.String key)
retrofit2.Call<Moderation.GetModerationAnalyticsResponse>	getModerationAnalytics(@NotNull Moderation.GetModerationAnalyticsRequestData getModerationAnalyticsRequestData)
retrofit2.Call<Moderation.GetModerationRuleResponse>	getModerationRule(@NotNull java.lang.String id)
retrofit2.Call<Moderation.ModeratorStatsResponse>	getModeratorStats(@Nullable java.lang.String userId, @Nullable java.lang.String startTime, @Nullable java.lang.String endTime)
retrofit2.Call<Moderation.QueueStatsResponse>	getQueueStats(@Nullable java.lang.String startTime, @Nullable java.lang.String endTime)
retrofit2.Call<Moderation.GetReviewQueueItemResponse>	getReviewQueueItem(@NotNull java.lang.String id)
retrofit2.Call<Moderation.GetUserReportResponse>	getUserReport(@NotNull java.lang.String userId, @Nullable java.lang.Boolean createUserIfNotExists, @Nullable java.lang.Boolean includeUserBlocks, @Nullable java.lang.Boolean includeUserMutes)
retrofit2.Call<Moderation.MuteResponse>	mute(@NotNull Moderation.MuteRequestData muteRequestData)
retrofit2.Call<Moderation.QueryAppealsResponse>	queryAppeals(@NotNull Moderation.QueryAppealsRequestData queryAppealsRequestData)
retrofit2.Call<Moderation.QueryConfigsResponse>	queryConfigs(@NotNull Moderation.QueryConfigsRequestData queryConfigsRequestData)
retrofit2.Call<Moderation.QueryFeedModerationTemplatesResponse>	queryFeedModerationTemplates(@Nullable java.lang.String filter, @Nullable java.lang.Integer limit, @Nullable java.lang.Integer offset)
retrofit2.Call<Moderation.QueryModerationFlagsResponse>	queryModerationFlags(@NotNull Moderation.QueryModerationFlagsRequestData queryModerationFlagsRequestData)
retrofit2.Call<Moderation.QueryModerationLogsResponse>	queryModerationLogs(@NotNull Moderation.QueryModerationLogsRequestData queryModerationLogsRequestData)
retrofit2.Call<Moderation.QueryModerationRulesResponse>	queryModerationRules(@NotNull Moderation.QueryModerationRulesRequestData queryModerationRulesRequestData)
retrofit2.Call<Moderation.QueryReviewQueueResponse>	queryReviewQueue(@NotNull Moderation.QueryReviewQueueRequestData queryReviewQueueRequestData)
retrofit2.Call<Moderation.QueryUsageStatsResponse>	queryUsageStats(@NotNull Moderation.QueryUsageStatsRequestData queryUsageStatsRequestData)
retrofit2.Call<Moderation.SubmitActionResponse>	submitAction(@NotNull Moderation.SubmitActionRequestData submitActionRequestData)
retrofit2.Call<Moderation.UnbanResponse>	unban(@NotNull Moderation.UnbanRequestData unbanRequestData)
retrofit2.Call<Moderation.UnmuteResponse>	unmute(@NotNull Moderation.UnmuteRequestData unmuteRequestData)
retrofit2.Call<Moderation.UpsertConfigResponse>	upsertConfig(@Nullable Moderation.UpsertConfigRequestData upsertConfig)
retrofit2.Call<Moderation.UpsertModerationRuleResponse>	upsertModerationRule(@NotNull Moderation.UpsertModerationRuleRequestData upsertModerationRuleRequestData)
retrofit2.Call<Moderation.UpsertTemplateResponse>	upsertTemplate(@NotNull Moderation.UpsertTemplateRequestData upsertTemplateRequestData)

Method Detail

getConfig

@GET("api/v2/moderation/config/{key}")
retrofit2.Call<Moderation.ConfigGetResponse> getConfig(@NotNull @Path("key")
                                                       @NotNull java.lang.String key)

deleteConfig

@DELETE("api/v2/moderation/config/{key}")
retrofit2.Call<StreamResponseObject> deleteConfig(@NotNull @Path("key")
                                                  @NotNull java.lang.String key)

upsertConfig

@POST("api/v2/moderation/config")
retrofit2.Call<Moderation.UpsertConfigResponse> upsertConfig(@Nullable @Body
                                                             @Nullable Moderation.UpsertConfigRequestData upsertConfig)

flag

@POST("api/v2/moderation/flag")
retrofit2.Call<Moderation.FlagResponse> flag(@NotNull @Body
                                             @NotNull Moderation.FlagRequestData flagRequestData)

mute

@POST("api/v2/moderation/mute")
retrofit2.Call<Moderation.MuteResponse> mute(@NotNull @Body
                                             @NotNull Moderation.MuteRequestData muteRequestData)

unmute

@POST("api/v2/moderation/unmute")
retrofit2.Call<Moderation.UnmuteResponse> unmute(@NotNull @Body
                                                 @NotNull Moderation.UnmuteRequestData unmuteRequestData)

check

@POST("api/v2/moderation/check")
retrofit2.Call<Moderation.CheckResponse> check(@NotNull @Body
                                               @NotNull Moderation.CheckRequestData checkRequestData)

customCheck

@POST("api/v2/moderation/custom_check")
retrofit2.Call<Moderation.CustomCheckResponse> customCheck(@NotNull @Body
                                                           @NotNull Moderation.CustomCheckRequestData customCheckRequestData)

queryReviewQueue

@POST("api/v2/moderation/review_queue")
retrofit2.Call<Moderation.QueryReviewQueueResponse> queryReviewQueue(@NotNull @Body
                                                                     @NotNull Moderation.QueryReviewQueueRequestData queryReviewQueueRequestData)

queryConfigs

@POST("api/v2/moderation/configs")
retrofit2.Call<Moderation.QueryConfigsResponse> queryConfigs(@NotNull @Body
                                                             @NotNull Moderation.QueryConfigsRequestData queryConfigsRequestData)

submitAction

@POST("api/v2/moderation/submit_action")
retrofit2.Call<Moderation.SubmitActionResponse> submitAction(@NotNull @Body
                                                             @NotNull Moderation.SubmitActionRequestData submitActionRequestData)

getUserReport

@GET("api/v2/moderation/user_report")
retrofit2.Call<Moderation.GetUserReportResponse> getUserReport(@NotNull @Query("user_id")
                                                               @NotNull java.lang.String userId,
                                                               @Nullable @Query("create_user_if_not_exists")
                                                               @Nullable java.lang.Boolean createUserIfNotExists,
                                                               @Nullable @Query("include_user_blocks")
                                                               @Nullable java.lang.Boolean includeUserBlocks,
                                                               @Nullable @Query("include_user_mutes")
                                                               @Nullable java.lang.Boolean includeUserMutes)

block

@POST("api/v2/moderation/block")
retrofit2.Call<Moderation.BlockResponse> block(@NotNull @Body
                                               @NotNull Moderation.BlockRequestData blockRequestData)

ban

@POST("api/v2/moderation/ban")
retrofit2.Call<Moderation.BanResponse> ban(@NotNull @Body
                                           @NotNull Moderation.BanRequestData banRequestData)

unban

@POST("api/v2/moderation/unban")
retrofit2.Call<Moderation.UnbanResponse> unban(@NotNull @Body
                                               @NotNull Moderation.UnbanRequestData unbanRequestData)

appeal

@POST("api/v2/moderation/appeal")
retrofit2.Call<Moderation.AppealResponse> appeal(@NotNull @Body
                                                 @NotNull Moderation.AppealRequestData appealRequestData)

getAppeal

@GET("api/v2/moderation/appeal/{id}")
retrofit2.Call<Moderation.GetAppealResponse> getAppeal(@NotNull @Path("id")
                                                       @NotNull java.lang.String id)

queryAppeals

@POST("api/v2/moderation/appeals")
retrofit2.Call<Moderation.QueryAppealsResponse> queryAppeals(@NotNull @Body
                                                             @NotNull Moderation.QueryAppealsRequestData queryAppealsRequestData)

queryModerationFlags

@POST("api/v2/moderation/flags")
retrofit2.Call<Moderation.QueryModerationFlagsResponse> queryModerationFlags(@NotNull @Body
                                                                             @NotNull Moderation.QueryModerationFlagsRequestData queryModerationFlagsRequestData)

queryModerationLogs

@POST("api/v2/moderation/logs")
retrofit2.Call<Moderation.QueryModerationLogsResponse> queryModerationLogs(@NotNull @Body
                                                                           @NotNull Moderation.QueryModerationLogsRequestData queryModerationLogsRequestData)

queryUsageStats

@POST("api/v2/moderation/usage_stats")
retrofit2.Call<Moderation.QueryUsageStatsResponse> queryUsageStats(@NotNull @Body
                                                                   @NotNull Moderation.QueryUsageStatsRequestData queryUsageStatsRequestData)

getModerationAnalytics

@POST("api/v2/moderation/analytics")
retrofit2.Call<Moderation.GetModerationAnalyticsResponse> getModerationAnalytics(@NotNull @Body
                                                                                 @NotNull Moderation.GetModerationAnalyticsRequestData getModerationAnalyticsRequestData)

getReviewQueueItem

@GET("api/v2/moderation/review_queue/{id}")
retrofit2.Call<Moderation.GetReviewQueueItemResponse> getReviewQueueItem(@NotNull @Path("id")
                                                                         @NotNull java.lang.String id)

getModeratorStats

@GET("api/v2/moderation/moderator_stats")
retrofit2.Call<Moderation.ModeratorStatsResponse> getModeratorStats(@Nullable @Query("user_id")
                                                                    @Nullable java.lang.String userId,
                                                                    @Nullable @Query("start_time")
                                                                    @Nullable java.lang.String startTime,
                                                                    @Nullable @Query("end_time")
                                                                    @Nullable java.lang.String endTime)

getQueueStats

@GET("api/v2/moderation/queue_stats")
retrofit2.Call<Moderation.QueueStatsResponse> getQueueStats(@Nullable @Query("start_time")
                                                            @Nullable java.lang.String startTime,
                                                            @Nullable @Query("end_time")
                                                            @Nullable java.lang.String endTime)

exportModerationLogs

@POST("api/v2/moderation/logs/export")
retrofit2.Call<Moderation.ExportModerationLogsResponse> exportModerationLogs(@NotNull @Body
                                                                             @NotNull Moderation.ExportModerationLogsRequestData exportModerationLogsRequestData)

bulkImageModeration

@POST("api/v2/moderation/bulk_image_moderation")
retrofit2.Call<Moderation.BulkImageModerationResponse> bulkImageModeration(@NotNull @Body
                                                                           @NotNull Moderation.BulkImageModerationRequestData bulkImageModerationRequestData)

bulkSubmitAction

@POST("api/v2/moderation/bulk_submit_action")
retrofit2.Call<Moderation.BulkSubmitActionResponse> bulkSubmitAction(@NotNull @Body
                                                                     @NotNull Moderation.BulkSubmitActionRequestData bulkSubmitActionRequestData)

upsertTemplate

@POST("api/v2/moderation/feeds_moderation_template")
retrofit2.Call<Moderation.UpsertTemplateResponse> upsertTemplate(@NotNull @Body
                                                                 @NotNull Moderation.UpsertTemplateRequestData upsertTemplateRequestData)

queryFeedModerationTemplates

@GET("api/v2/moderation/feeds_moderation_template")
retrofit2.Call<Moderation.QueryFeedModerationTemplatesResponse> queryFeedModerationTemplates(@Nullable @Query("filter")
                                                                                             @Nullable java.lang.String filter,
                                                                                             @Nullable @Query("limit")
                                                                                             @Nullable java.lang.Integer limit,
                                                                                             @Nullable @Query("offset")
                                                                                             @Nullable java.lang.Integer offset)

deleteModerationTemplate

@DELETE("api/v2/moderation/feeds_moderation_template")
retrofit2.Call<StreamResponseObject> deleteModerationTemplate(@NotNull @Query("name")
                                                              @NotNull java.lang.String name,
                                                              @Nullable @Query("team")
                                                              @Nullable java.lang.String team)

upsertModerationRule

@POST("api/v2/moderation/moderation_rule")
retrofit2.Call<Moderation.UpsertModerationRuleResponse> upsertModerationRule(@NotNull @Body
                                                                             @NotNull Moderation.UpsertModerationRuleRequestData upsertModerationRuleRequestData)

queryModerationRules

@POST("api/v2/moderation/moderation_rules")
retrofit2.Call<Moderation.QueryModerationRulesResponse> queryModerationRules(@NotNull @Body
                                                                             @NotNull Moderation.QueryModerationRulesRequestData queryModerationRulesRequestData)

getModerationRule

@GET("api/v2/moderation/moderation_rule/{id}")
retrofit2.Call<Moderation.GetModerationRuleResponse> getModerationRule(@NotNull @Path("id")
                                                                       @NotNull java.lang.String id)

deleteModerationRule

@DELETE("api/v2/moderation/moderation_rule/{id}")
retrofit2.Call<StreamResponseObject> deleteModerationRule(@NotNull @Path("id")
                                                          @NotNull java.lang.String id)