Activity Feeds v3 is in beta — try it out!

Moderation

Stream Feeds has support for moderation, allowing you to manage user interactions, content moderation, and platform safety. It’s accessible through the client.moderation property.

Overview

let client = FeedsClient(apiKey: apiKey, user: user, token: token)
let moderation = client.moderation

User Moderation

Ban Users

Ban a user from the platform with various options including timeout, shadow bans, and IP bans.

let banRequest = BanRequest(
    targetUserId: "user-123",
    reason: "Violation of community guidelines",
    timeout: 3600, // 1 hour in seconds
    shadow: false,
    ipBan: false
)

let response = try await client.moderation.ban(banRequest: banRequest)
print("User banned for: \(response.duration)")

Parameters:

  • targetUserId: The ID of the user to ban
  • reason: Optional reason for the ban
  • timeout: Optional timeout in seconds (null for permanent ban)
  • shadow: Whether to perform a shadow ban (user doesn’t know they’re banned)
  • ipBan: Whether to ban the user’s IP address
  • bannedBy: Optional user who performed the ban
  • deleteMessages: Whether to delete user’s messages

Mute Users

Mute one or more users to prevent them from interacting with your content.

let muteRequest = MuteRequest(
    targetIds: ["user-123", "user-456"],
    timeout: 86400 // 24 hours in seconds
)

let response = try await client.moderation.mute(muteRequest: muteRequest)

Parameters:

  • targetIds: Array of user IDs to mute
  • timeout: Optional timeout in seconds (null for permanent mute)

Block Users

Block a user to prevent them from following you or seeing your content.

let blockRequest = BlockUsersRequest(blockedUserId: "user-123")
let response = try await client.moderation.blockUsers(blockUsersRequest: blockRequest)

Unblock Users

Unblock a previously blocked user.

let unblockRequest = UnblockUsersRequest(blockedUserId: "user-123")
let response = try await client.moderation.unblockUsers(unblockUsersRequest: unblockRequest)

Get Blocked Users

Retrieve a list of users you have blocked.

let blockedUsers = try await client.moderation.getBlockedUsers()
for user in blockedUsers.users {
    print("Blocked user: \(user.id)")
}

Content Moderation

Flag Content

Flag inappropriate content for moderation review.

let flagRequest = FlagRequest(
    entityId: "activity-123",
    entityType: "activity",
    reason: "Inappropriate content",
    entityCreatorId: "user-456"
)

let response = try await client.moderation.flag(flagRequest: flagRequest)

Parameters:

  • entityId: The ID of the content to flag
  • entityType: The type of content (e.g., “activity”, “comment”)
  • reason: Optional reason for flagging
  • entityCreatorId: Optional ID of the content creator
  • custom: Optional custom data for the flag

Submit Moderation Actions

Submit moderation actions for flagged content.

let actionRequest = SubmitActionRequest(
    // Action details for moderation
)

let response = try await client.moderation.submitAction(submitActionRequest: actionRequest)

Review Queue

Query Review Queue

Retrieve items in the moderation review queue.

let queryRequest = QueryReviewQueueRequest(
    // Query parameters for filtering and pagination
)

let reviewQueue = try await client.moderation.queryReviewQueue(queryReviewQueueRequest: queryRequest)

Configuration Management

Upsert Moderation Configuration

Create or update moderation configuration settings.

let configRequest = UpsertConfigRequest(
    // Configuration details
)

let response = try await client.moderation.upsertConfig(upsertConfigRequest: configRequest)

Get Moderation Configuration

Retrieve a specific moderation configuration.

let config = try await client.moderation.getConfig(key: "automod_settings", team: "team-123")

Parameters:

  • key: The configuration key to retrieve
  • team: Optional team identifier

Delete Moderation Configuration

Remove a moderation configuration.

let response = try await client.moderation.deleteConfig(key: "automod_settings", team: "team-123")

Query Moderation Configurations

Search and filter moderation configurations.

let queryRequest = QueryModerationConfigsRequest(
    // Query parameters for filtering and pagination
)

let configs = try await client.moderation.queryModerationConfigs(queryModerationConfigsRequest: queryRequest)

Moderation Config Queryable Built-In Fields

nametypedescriptionsupported operationsexample
keystring or list of stringsThe configuration key identifier$eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists, $autocomplete{ key: { $autocomplete: 'spam' } }
teamstring or list of stringsThe team identifier for multi-tenant applications$eq, $ne, $gt, $gte, $lt, $lte, $in, $nin, $exists{ team: { $eq: 'team_123' } }
created_atstring, must be formatted as an RFC3339 timestampThe time the configuration was created$eq, $gt, $gte, $lt, $lte{ created_at: { $gte: '2023-12-04T09:30:20.45Z' } }
updated_atstring, must be formatted as an RFC3339 timestampThe time the configuration was last updated$eq, $gt, $gte, $lt, $lte{ updated_at: { $gte: '2023-12-04T09:30:20.45Z' } }

Error Handling

All moderation methods can throw errors. Handle them appropriately:

do {
    let response = try await client.moderation.ban(banRequest: banRequest)
    print("User banned successfully")
} catch {
    print("Failed to ban user: \(error)")
}
© Getstream.io, Inc. All Rights Reserved.