bluesky/chat.bsky.moderation

Package-level declarations

Types

data class ConvoView(val id: String, val rev: String, val kind: ConvoViewKindUnion? = null)

NOTE: This is under active development and should be considered unstable while this note is here. A view of a conversation for moderation purposes. Unlike chat.bsky.convo.defs#convoView, it does not include viewer-specific data (such as muted, unreadCount, status, lastMessage, lastReaction), since the requester is a moderator and not a member of the conversation. The member list is not included; use chat.bsky.moderation.getConvoMembers to list members.

ConvoViewKindUnion

sealed interface ConvoViewKindUnion

object DirectConvo

NOTE: This is under active development and should be considered unstable while this note is here. Data specific to a direct conversation, for moderation purposes.

GetActorMetadataMetadata

data class GetActorMetadataMetadata(val messagesSent: Long, val messagesReceived: Long, val convos: Long, val convosStarted: Long)

GetActorMetadataQueryParams

data class GetActorMetadataQueryParams(val actor: Did)

GetActorMetadataResponse

data class GetActorMetadataResponse(val day: GetActorMetadataMetadata, val month: GetActorMetadataMetadata, val all: GetActorMetadataMetadata)

GetConvoMembersQueryParams

data class GetConvoMembersQueryParams(val convoId: String, val limit: Long? = 50, val cursor: String? = null)

GetConvoMembersResponse

data class GetConvoMembersResponse(val cursor: String? = null, val members: List<ProfileViewBasic>)

GetConvoQueryParams

data class GetConvoQueryParams(val convoId: String)

GetConvoResponse

data class GetConvoResponse(val convo: ConvoView)

GetConvosQueryParams

data class GetConvosQueryParams(val convoIds: List<String>)

GetConvosResponse

data class GetConvosResponse(val convos: List<ConvoView>)

GetMessageContextQueryParams

data class GetMessageContextQueryParams(val convoId: String? = null, val messageId: String, val before: Long? = 5, val after: Long? = 5, val maxInterleavedSystemMessages: Long? = 10)

GetMessageContextResponse

data class GetMessageContextResponse(val messages: List<GetMessageContextResponseMessageUnion>)

GetMessageContextResponseMessageUnion

sealed interface GetMessageContextResponseMessageUnion

data class GroupConvo(val createdAt: Timestamp, val joinLink: JoinLinkView? = null, val joinRequestCount: Long, val lockStatus: ConvoLockStatus, val memberCount: Long, val memberLimit: Long, val name: String)

NOTE: This is under active development and should be considered unstable while this note is here. Data specific to a group conversation, for moderation purposes. Unlike chat.bsky.convo.defs#groupConvo, it does not include viewer-specific data (such as unreadJoinRequestCount), since the requester is a moderator and not a member of the conversation.

SubscribeModEventsEventChatAccepted

data class SubscribeModEventsEventChatAccepted(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long? = null, val groupName: String? = null, val method: SubscribeModEventsEventChatAcceptedMethod, val ownerDid: Did? = null, val rev: String)

Fired when a user accepts a chat convo, either explicitly or by sending a message.

SubscribeModEventsEventChatAcceptedMethod

@Serializable(with = SubscribeModEventsEventChatAcceptedMethodSerializer::class)

sealed class SubscribeModEventsEventChatAcceptedMethod : AtpEnum

How the convo was accepted.

SubscribeModEventsEventChatAcceptedMethodSerializer

class SubscribeModEventsEventChatAcceptedMethodSerializer : KSerializer<SubscribeModEventsEventChatAcceptedMethod>

SubscribeModEventsEventConvoFirstMessage

data class SubscribeModEventsEventConvoFirstMessage(val convoId: String, val createdAt: Timestamp, val messageId: String? = null, val recipients: List<Did>, val rev: String, val user: Did)

Fired when the first message was sent on a convo.

SubscribeModEventsEventGroupChatCreated

data class SubscribeModEventsEventGroupChatCreated(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long, val groupName: String, val initialMemberDids: List<Did>, val ownerDid: Did, val rev: String)

Fire when a group chat is created.

SubscribeModEventsEventGroupChatJoinRequest

data class SubscribeModEventsEventGroupChatJoinRequest(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long, val groupName: String, val joinLinkCode: String, val ownerDid: Did, val rev: String, val subjectFollowsOwner: Boolean)

Fired when a user requests to join a group chat via an join link that requires approval.

SubscribeModEventsEventGroupChatJoinRequestApproved

data class SubscribeModEventsEventGroupChatJoinRequestApproved(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long, val groupName: String, val ownerDid: Did, val rev: String, val subjectDid: Did)

Fired when a join request is approved by the group owner.

SubscribeModEventsEventGroupChatJoinRequestRejected

data class SubscribeModEventsEventGroupChatJoinRequestRejected(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long, val groupName: String, val ownerDid: Did, val rev: String, val subjectDid: Did)

Fired when a join request is rejected by the group owner.

SubscribeModEventsEventGroupChatMemberAdded

data class SubscribeModEventsEventGroupChatMemberAdded(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long, val groupName: String, val ownerDid: Did, val requestMembersCount: Long, val rev: String, val subjectDid: Did, val subjectFollowsOwner: Boolean)

Fired when a member is added to a group chat. Note that members are added in the 'request' state.

SubscribeModEventsEventGroupChatMemberJoined

data class SubscribeModEventsEventGroupChatMemberJoined(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long, val groupName: String, val joinLinkCode: String, val ownerDid: Did, val rev: String, val subjectFollowsOwner: Boolean)

Fired when a member joins a group chat via an join link that does not require approval.

SubscribeModEventsEventGroupChatMemberLeft

data class SubscribeModEventsEventGroupChatMemberLeft(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long, val groupName: String, val leaveMethod: SubscribeModEventsEventGroupChatMemberLeftLeaveMethod, val ownerDid: Did, val rev: String, val subjectDid: Did)

Fired when a member leaves or is removed from a group chat.

SubscribeModEventsEventGroupChatMemberLeftLeaveMethod

@Serializable(with = SubscribeModEventsEventGroupChatMemberLeftLeaveMethodSerializer::class)

sealed class SubscribeModEventsEventGroupChatMemberLeftLeaveMethod : AtpEnum

How the member left.

SubscribeModEventsEventGroupChatMemberLeftLeaveMethodSerializer

class SubscribeModEventsEventGroupChatMemberLeftLeaveMethodSerializer : KSerializer<SubscribeModEventsEventGroupChatMemberLeftLeaveMethod>

SubscribeModEventsEventGroupChatUpdated

data class SubscribeModEventsEventGroupChatUpdated(val actorDid: Did, val convoCreatedAt: Timestamp, val convoId: String, val createdAt: Timestamp, val groupMemberCount: Long, val groupName: String, val joinLinkCode: String? = null, val joinLinkFollowersOnly: Boolean? = null, val joinLinkRequiresApproval: Boolean? = null, val lockReason: SubscribeModEventsEventGroupChatUpdatedLockReason? = null, val newName: String? = null, val oldName: String? = null, val ownerDid: Did, val rev: String, val updateType: SubscribeModEventsEventGroupChatUpdatedUpdateType)

Fired when a group chat's metadata or status changes.

SubscribeModEventsEventGroupChatUpdatedLockReason

@Serializable(with = SubscribeModEventsEventGroupChatUpdatedLockReasonSerializer::class)

sealed class SubscribeModEventsEventGroupChatUpdatedLockReason : AtpEnum

Why the group was locked. Only present when updateType is 'locked'.

SubscribeModEventsEventGroupChatUpdatedLockReasonSerializer

class SubscribeModEventsEventGroupChatUpdatedLockReasonSerializer : KSerializer<SubscribeModEventsEventGroupChatUpdatedLockReason>

SubscribeModEventsEventGroupChatUpdatedUpdateType

@Serializable(with = SubscribeModEventsEventGroupChatUpdatedUpdateTypeSerializer::class)

sealed class SubscribeModEventsEventGroupChatUpdatedUpdateType : AtpEnum

What changed.

SubscribeModEventsEventGroupChatUpdatedUpdateTypeSerializer

class SubscribeModEventsEventGroupChatUpdatedUpdateTypeSerializer : KSerializer<SubscribeModEventsEventGroupChatUpdatedUpdateType>

SubscribeModEventsEventRateLimitExceeded

data class SubscribeModEventsEventRateLimitExceeded(val actorDid: Did, val createdAt: Timestamp, val endpoint: String, val rev: String)

Fired when a user exceeds a rate limit.

SubscribeModEventsMessage

typealias SubscribeModEventsMessage = SubscribeModEventsMessageUnion

SubscribeModEventsMessageUnion

sealed interface SubscribeModEventsMessageUnion

SubscribeModEventsQueryParams

data class SubscribeModEventsQueryParams(val cursor: String? = null)

UpdateActorAccessRequest

data class UpdateActorAccessRequest(val actor: Did, val allowAccess: Boolean, val ref: String? = null)