Package-level declarations

Types

Link copied to clipboard
typealias ConvoKind = String
Link copied to clipboard
Link copied to clipboard
class ConvoService(client: <Error class: unknown class>)
Link copied to clipboard
typealias ConvoStatus = String
Link copied to clipboard
data class ConvoView(val id: String, val kind: ConvoViewKindUnion? = null, val lastMessage: ConvoViewLastMessageUnion? = null, val lastReaction: ConvoViewLastReactionUnion? = null, val members: List<ProfileViewBasic>, val muted: Boolean, val rev: String, val status: ConvoStatus? = null, val unreadCount: Long)
Link copied to clipboard

Union field that has data specific to different kinds of convos.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here.

Link copied to clipboard
data class GetMessagesRequest(val convoId: String, val cursor: String? = null, val limit: Long? = null)

Returns a page of messages from a conversation.

Link copied to clipboard
data class GetMessagesResponse(val cursor: String? = null, val messages: List<GetMessagesResponseMessagesUnion>)
Link copied to clipboard
data class GroupConvo(val joinLink: JoinLinkView? = null, val lockStatus: ConvoLockStatus, val name: String) : ConvoViewKindUnion

NOTE: This is under active development and should be considered unstable while this note is here.

Link copied to clipboard
data class ListConvosRequest(val cursor: String? = null, val kind: String? = null, val limit: Long? = null, val readState: String? = null, val status: String? = null)

Returns a page of conversations (direct or group) for the user.

Link copied to clipboard
data class ListConvosResponse(val convos: List<ConvoView>, val cursor: String? = null)
Link copied to clipboard
data class LogAcceptConvo(val convoId: String, val rev: String)

Event indicating the viewer accepted a convo, and it can be moved out of the request inbox. Can be direct or group.

Link copied to clipboard
data class LogAddMember(val convoId: String, val message: SystemMessageDataAddMember, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a member was added to a group convo. The member who was added gets a logBeginConvo (to create the convo) but also a logAddMember (to show the system message as the first message the user sees).

Link copied to clipboard
data class LogAddReaction(val convoId: String, val message: LogAddReactionMessageUnion, val reaction: ReactionView, val rev: String)

Event indicating a reaction was added to a message.

Link copied to clipboard
Link copied to clipboard
data class LogApproveJoinRequest(val convoId: String, val member: ProfileViewBasic, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join request was approved by the viewer. Only the owner gets this. The approved member gets a logBeginConvo.

Link copied to clipboard
data class LogBeginConvo(val convoId: String, val rev: String)

Event indicating a convo containing the viewer was started. Can be direct or group. When a member is added to a group convo, they also get this event.

Link copied to clipboard
data class LogCreateJoinLink(val convoId: String, val message: SystemMessageDataCreateJoinLink, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join link was created for a group convo.

Link copied to clipboard
data class LogCreateMessage(val convoId: String, val message: LogCreateMessageMessageUnion, val rev: String)

Event indicating a user-originated message was created. Is not emitted for system messages.

Link copied to clipboard
Link copied to clipboard
data class LogDeleteMessage(val convoId: String, val message: LogDeleteMessageMessageUnion, val rev: String)

Event indicating a user-originated message was deleted. Is not emitted for system messages.

Link copied to clipboard
Link copied to clipboard
data class LogDisableJoinLink(val convoId: String, val message: SystemMessageDataDisableJoinLink, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join link was disabled for a group convo.

Link copied to clipboard
data class LogEditGroup(val convoId: String, val message: SystemMessageDataEditGroup, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating info about group convo was edited.

Link copied to clipboard
data class LogEditJoinLink(val convoId: String, val message: SystemMessageDataEditJoinLink, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a settings about a join link for a group convo were edited.

Link copied to clipboard
data class LogEnableJoinLink(val convoId: String, val message: SystemMessageDataEnableJoinLink, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join link was enabled for a group convo.

Link copied to clipboard
data class LogIncomingJoinRequest(val convoId: String, val member: ProfileViewBasic, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join request was made to a group the viewer owns. Only the owner gets this.

Link copied to clipboard
data class LogLeaveConvo(val convoId: String, val rev: String)

Event indicating the viewer left a convo. Can be direct or group.

Link copied to clipboard
data class LogLockConvo(val convoId: String, val message: SystemMessageDataLockConvo, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a group convo was locked.

Link copied to clipboard
data class LogLockConvoPermanently(val convoId: String, val message: SystemMessageDataLockConvoPermanently, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a group convo was locked permanently.

Link copied to clipboard
data class LogMemberJoin(val convoId: String, val message: SystemMessageDataMemberJoin, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a member joined a group convo via join link. The member who was added gets a logBeginConvo (to create the convo) but also a logMemberJoin (to show the system message as the first message the user sees).

Link copied to clipboard
data class LogMemberLeave(val convoId: String, val message: SystemMessageDataMemberLeave, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a member voluntarily left a group convo. The member who was removed gets a logLeaveConvo (to leave the convo) but not a logMemberLeave (because they already left, so can't see the system message).

Link copied to clipboard
data class LogMuteConvo(val convoId: String, val rev: String)

Event indicating the viewer muted a convo. Can be direct or group.

Link copied to clipboard
data class LogOutgoingJoinRequest(val convoId: String, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join request was made by the viewer.

Link copied to clipboard
data class LogReadConvo(val convoId: String, val message: LogReadConvoMessageUnion, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a convo was read up to a certain message.

Link copied to clipboard
Link copied to clipboard
data class LogReadMessage(val convoId: String, val message: LogReadMessageMessageUnion, val rev: String)

DEPRECATED: use logReadConvo instead. Event indicating a convo was read up to a certain message.

Link copied to clipboard
Link copied to clipboard
data class LogRejectJoinRequest(val convoId: String, val member: ProfileViewBasic, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a join request was rejected by the viewer. Only the owner gets this.

Link copied to clipboard
data class LogRemoveMember(val convoId: String, val message: SystemMessageDataRemoveMember, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a member was removed from a group convo. The member who was removed gets a logLeaveConvo (to leave the convo) but not a logRemoveMember (because they already left, so can't see the system message).

Link copied to clipboard
data class LogRemoveReaction(val convoId: String, val message: LogRemoveReactionMessageUnion, val reaction: ReactionView, val rev: String)

Event indicating a reaction was removed from a message.

Link copied to clipboard
data class LogUnlockConvo(val convoId: String, val message: SystemMessageDataUnlockConvo, val rev: String)

NOTE: This is under active development and should be considered unstable while this note is here. Event indicating a group convo was unlocked.

Link copied to clipboard
data class LogUnmuteConvo(val convoId: String, val rev: String)

Event indicating the viewer unmuted a convo. Can be direct or group.

Link copied to clipboard
Link copied to clipboard
data class MessageInput(val embed: <Error class: unknown class><MessageInputEmbedUnion> = AtField.Missing, val facets: <Error class: unknown class><List<Facet>> = AtField.Missing, val text: String)
Link copied to clipboard
Link copied to clipboard
data class MessageRef(val convoId: String, val did: <Error class: unknown class>, val messageId: String)
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class MessageViewSender(val did: <Error class: unknown class>)
Link copied to clipboard
data class ReactionView(val createdAt: <Error class: unknown class>, val sender: ReactionViewSender, val value: String)
Link copied to clipboard
data class ReactionViewSender(val did: <Error class: unknown class>)
Link copied to clipboard
data class SendMessageRequest(val convoId: String, val message: MessageInput)

Sends a message to a conversation.

Link copied to clipboard
Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating a user was added to the group convo.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group join link was created.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group join link was disabled.

Link copied to clipboard
data class SystemMessageDataEditGroup(val newName: String? = null, val oldName: String? = null) : SystemMessageViewDataUnion

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group info was edited.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group join link was edited.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group join link was enabled.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group convo was locked.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group convo was locked permanently.

Link copied to clipboard
data class SystemMessageDataMemberJoin(val approvedBy: ProfileViewBasic? = null, val member: ProfileViewBasic, val role: MemberRole) : SystemMessageViewDataUnion

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating a user joined the group convo via join link.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating a user voluntarily left the group convo.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating a user was removed from the group convo.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here. System message indicating the group convo was unlocked.

Link copied to clipboard

NOTE: This is under active development and should be considered unstable while this note is here.

Link copied to clipboard

Functions

Link copied to clipboard
fun ConvoService.listConvosFlow(request: ListConvosRequest = ListConvosRequest()): <Error class: unknown class><ConvoView>

Returns a page of conversations (direct or group) for the user.

Link copied to clipboard
fun ConvoService.listConvosPageFlow(request: ListConvosRequest = ListConvosRequest()): <Error class: unknown class><List<ConvoView>>

Returns a page of conversations (direct or group) for the user.

Link copied to clipboard

Returns a page of messages from a conversation.

Link copied to clipboard

Returns a page of messages from a conversation.