ModerationClient class

Controller exposing moderation functionalities.

Provides comprehensive moderation capabilities including user management, content flagging, review queue operations, and configuration management. All operations are performed through the Stream Feeds API.

Example usage:

final client = StreamFeedsClient(/*...*/);

// Ban a user
final banResult = await client.moderation.ban(
  api.BanRequest(
    targetUserId: 'user-123',
    reason: 'Violation of community guidelines',
  ),
);

// Flag content for review
final flagResult = await client.moderation.flag(
  api.FlagRequest(
    targetId: 'activity-456',
    reason: 'inappropriate content',
  ),
);

Constructors

ModerationClient(ModerationRepository _moderationRepository)

Creates a new ModerationClient instance.

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

appeal({required AppealRequest appealRequest}) → Future<Result<AppealResponse>>

Submits an appeal for a moderation decision.

ban({required BanRequest banRequest}) → Future<Result<BanResponse>>

Bans a user from the platform.

blockUsers({required BlockUsersRequest blockUsersRequest}) → Future<Result<BlockUsersResponse>>

Blocks a user.

deleteConfig({required String key, String? team}) → Future<Result<DeleteModerationConfigResponse>>

Deletes a moderation configuration.

flag({required FlagRequest flagRequest}) → Future<Result<FlagResponse>>

Flags content for moderation review.

getAppeal({required String id}) → Future<Result<GetAppealResponse>>

Gets an appeal by ID.

getBlockedUsers() → Future<Result<GetBlockedUsersResponse>>

Gets the list of blocked users.

getConfig({required String key, String? team}) → Future<Result<GetConfigResponse>>

Gets a moderation configuration.

mute({required MuteRequest muteRequest}) → Future<Result<MuteResponse>>

Mutes one or more users.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

queryAppeals({QueryAppealsRequest? queryAppealsRequest}) → Future<Result<QueryAppealsResponse>>

Queries appeals.

queryModerationConfigs({required ModerationConfigsQuery queryModerationConfigsRequest}) → Future<Result<PaginationResult<ModerationConfigData>>>

Queries the moderation configurations.

queryReviewQueue({required QueryReviewQueueRequest queryReviewQueueRequest}) → Future<Result<QueryReviewQueueResponse>>

Queries the moderation review queue.

submitAction({required SubmitActionRequest submitActionRequest}) → Future<Result<SubmitActionResponse>>

Submits a moderation action.

toString() → String

A string representation of this object.

inherited

unblockUsers({required UnblockUsersRequest unblockUsersRequest}) → Future<Result<UnblockUsersResponse>>

Unblocks a user.

upsertConfig(UpsertConfigRequest upsertConfigRequest) → Future<Result<UpsertConfigResponse>>

Upserts a moderation configuration.

Operators

operator ==(Object other) → bool

The equality operator.

inherited