Class FlackleClient

Unofficial Flackle client.

const client = new FlackleClient();
await client.login({ email: "...", password: "..." });
client.on("messageCreate", (event) => console.log(event.message.content));
await client.connect();

Hierarchy (View Summary)

TypedEmitter<ClientEvents>
- FlackleClient

Index

Constructors

constructor

new FlackleClient(options?: FlackleClientOptions): FlackleClient
Parameters
- options: FlackleClientOptions = {}
Returns FlackleClient
Overrides TypedEmitter.constructor
- Defined in src/client.ts:158

Methods

login(options: LoginOptions): Promise<SelfUser>
Logs in with email/password, handling TOTP MFA when required.
Parameters
- options: LoginOptions
Returns Promise<SelfUser>
- Defined in src/client.ts:185

refreshSession

refreshSession(): Promise<SelfUser>
Refreshes the session and returns the current account.

Returns Promise<SelfUser>
- Defined in src/client.ts:231

fetchMe

fetchMe(): Promise<SelfUser>
Returns Promise<SelfUser>
- Defined in src/client.ts:237

connect

connect(): Promise<void>
Connects to the gateway and subscribes to all joined servers.

Returns Promise<void>
- Defined in src/client.ts:243

destroy

destroy(): Promise<void>
Returns Promise<void>
- Defined in src/client.ts:256

fetchEntry

fetchEntry(): Promise<BootstrapPayload>
Returns Promise<BootstrapPayload>
- Defined in src/client.ts:267

fetchServers

fetchServers(): Promise<Server[]>
Returns Promise<Server[]>
- Defined in src/client.ts:271

fetchServer

fetchServer(serverId: string): Promise<Server>
Parameters
- serverId: string
Returns Promise<Server>
- Defined in src/client.ts:276

fetchChannels

fetchChannels(serverId: string): Promise<ChannelBundle>
Parameters
- serverId: string
Returns Promise<ChannelBundle>
- Defined in src/client.ts:280

fetchConversations

fetchConversations(): Promise<Conversation[]>
Returns Promise<Conversation[]>
- Defined in src/client.ts:284

fetchUnreadSummary

fetchUnreadSummary(): Promise<{ channels: UnreadChannel[] }>
Returns Promise<{ channels: UnreadChannel[] }>
- Defined in src/client.ts:288

fetchServerSettings

fetchServerSettings(): Promise<ServerFolders>
Returns Promise<ServerFolders>
- Defined in src/client.ts:292

fetchVoiceStates

fetchVoiceStates(): Promise<{ voice_states: Record<Snowflake, VoiceState[]> }>
Returns Promise<{ voice_states: Record<Snowflake, VoiceState[]> }>
- Defined in src/client.ts:296

fetchStatus

fetchStatus(): Promise<{ status: PresenceStatus }>
Returns Promise<{ status: PresenceStatus }>
- Defined in src/client.ts:300

setStatus

setStatus(status: PresenceStatus): Promise<void>
Parameters
- status: PresenceStatus
Returns Promise<void>
- Defined in src/client.ts:304

fetchSessions

fetchSessions(): Promise<{ sessions: SessionInfo[] }>
Returns Promise<{ sessions: SessionInfo[] }>
- Defined in src/client.ts:308

fetchSavedMedia

fetchSavedMedia(
options?: { serverId?: string; cursor?: string },
): Promise<SavedMediaPage>
Parameters
- options: { serverId?: string; cursor?: string } = {}
Returns Promise<SavedMediaPage>
- Defined in src/client.ts:312

logout

logout(): Promise<void>
Returns Promise<void>
- Defined in src/client.ts:318

fetchMessages

fetchMessages(
target: MessageTarget,
options?: FetchMessagesOptions,
): Promise<Page<Message>>
Parameters
- target: MessageTarget
- options: FetchMessagesOptions = {}
Returns Promise<Page<Message>>
- Defined in src/client.ts:331

sendMessage

sendMessage(
    target: MessageTarget,
    content: string,
    options?: SendMessageOptions,
): Promise<Message>
Sends a message over the gateway and resolves with the echoed message. The gateway must be connected; Flackle's web client does not POST messages.
Parameters
- target: MessageTarget
- content: string
- options: SendMessageOptions = {}
Returns Promise<Message>
- Defined in src/client.ts:347

editMessage

editMessage(
    target: MessageTarget,
    messageId: string,
    content: string,
): Promise<void>
Parameters
- target: MessageTarget
- messageId: string
- content: string
Returns Promise<void>
- Defined in src/client.ts:374

deleteMessage

deleteMessage(
    target: MessageTarget,
    messageId: string,
    reason?: string,
): Promise<void>
Parameters
- target: MessageTarget
- messageId: string
- Optionalreason: string
Returns Promise<void>
- Defined in src/client.ts:402

sendTyping

sendTyping(target: MessageTarget): Promise<void>
Starts a typing indicator (the server expires it after ~5 seconds).
Parameters
- target: MessageTarget
Returns Promise<void>
- Defined in src/client.ts:431

stopTyping

stopTyping(target: MessageTarget): Promise<void>
Parameters
- target: MessageTarget
Returns Promise<void>
- Defined in src/client.ts:443

markRead

markRead(target: MessageTarget, messageId: string): Promise<void>
Parameters
- target: MessageTarget
- messageId: string
Returns Promise<void>
- Defined in src/client.ts:455

react

react(target: MessageTarget, messageId: string, emoji: string): Promise<void>
Adds the current account's reaction.
Parameters
- target: MessageTarget
- messageId: string
- emoji: string
Returns Promise<void>
- Defined in src/client.ts:472

unreact

unreact(target: MessageTarget, messageId: string, emoji: string): Promise<void>
Removes the current account's reaction.
Parameters
- target: MessageTarget
- messageId: string
- emoji: string
Returns Promise<void>
- Defined in src/client.ts:477

fetchReactions

fetchReactions(
    target: MessageTarget,
    messageId: string,
    emoji: string,
): Promise<User[]>
Fetches every user who reacted with emoji.
Parameters
- target: MessageTarget
- messageId: string
- emoji: string
Returns Promise<User[]>
- Defined in src/client.ts:482

fetchReactionUsers

fetchReactionUsers(
    target: MessageTarget,
    messageId: string,
    emoji: string,
): Promise<ReactionUsersPage>
Fetches the reaction-user page, including the total count when supplied.
Parameters
- target: MessageTarget
- messageId: string
- emoji: string
Returns Promise<ReactionUsersPage>
- Defined in src/client.ts:492

uploadAttachment

uploadAttachment(file: Blob, fileName?: string): Promise<Attachment>
Uploads a file with Flackle's multipart protocol and returns the attachment descriptor accepted by sendMessage.
Parameters
- file: Blob
- OptionalfileName: string
Returns Promise<Attachment>
- Defined in src/client.ts:510

uploadAttachmentDirect

uploadAttachmentDirect(
    target: MessageTarget,
    file: Blob,
    fileName?: string,
    direct?: boolean,
): Promise<Attachment[]>
Uploads through the direct attachment endpoint (multipart file field). This is a simpler alternative to the presigned /api/uploads flow and is what the web client uses for channel and conversation attachments.
Parameters
- target: MessageTarget
- file: Blob
- OptionalfileName: string
- direct: boolean = false
Returns Promise<Attachment[]>
- Defined in src/client.ts:540

fetchFriends

fetchFriends(search?: string): Promise<User[]>
Parameters
- Optionalsearch: string
Returns Promise<User[]>
- Defined in src/client.ts:560

fetchFriendRequests

fetchFriendRequests(): Promise<FriendRequests>
Returns Promise<FriendRequests>
- Defined in src/client.ts:564

fetchBlocked

fetchBlocked(): Promise<User[]>
Returns Promise<User[]>
- Defined in src/client.ts:568

addFriend

addFriend(username: string): Promise<void>
Parameters
- username: string
Returns Promise<void>
- Defined in src/client.ts:572

acceptFriendRequest

acceptFriendRequest(requestId: string): Promise<void>
Parameters
- requestId: string
Returns Promise<void>
- Defined in src/client.ts:576

rejectFriendRequest

rejectFriendRequest(requestId: string): Promise<void>
Parameters
- requestId: string
Returns Promise<void>
- Defined in src/client.ts:580

cancelFriendRequest

cancelFriendRequest(requestId: string): Promise<void>
Parameters
- requestId: string
Returns Promise<void>
- Defined in src/client.ts:584

removeFriend

removeFriend(userId: string): Promise<void>
Parameters
- userId: string
Returns Promise<void>
- Defined in src/client.ts:588

blockUser

blockUser(userId: string): Promise<void>
Parameters
- userId: string
Returns Promise<void>
- Defined in src/client.ts:592

unblockUser

unblockUser(userId: string): Promise<void>
Parameters
- userId: string
Returns Promise<void>
- Defined in src/client.ts:596

createServer

createServer(name: string): Promise<CreateServerResult>
Parameters
- name: string
Returns Promise<CreateServerResult>
- Defined in src/client.ts:604

updateServer

updateServer(serverId: string, patch: ServerUpdate): Promise<Server>
Parameters
- serverId: string
- patch: ServerUpdate
Returns Promise<Server>
- Defined in src/client.ts:608

deleteServer

deleteServer(serverId: string): Promise<void>
Deletes a server. The account must be the owner.
Parameters
- serverId: string
Returns Promise<void>
- Defined in src/client.ts:613

leaveServer

leaveServer(serverId: string): Promise<void>
Parameters
- serverId: string
Returns Promise<void>
- Defined in src/client.ts:617

uploadServerIcon

uploadServerIcon(serverId: string, image: Blob): Promise<string>
Parameters
- serverId: string
- image: Blob
Returns Promise<string>
- Defined in src/client.ts:621

uploadServerBanner

uploadServerBanner(serverId: string, image: Blob): Promise<string>
Parameters
- serverId: string
- image: Blob
Returns Promise<string>
- Defined in src/client.ts:625

fetchChannelKinds

fetchChannelKinds(): Promise<string[]>
Returns Promise<string[]>
- Defined in src/client.ts:629

createChannel

createChannel(serverId: string, options: CreateChannelOptions): Promise<Channel>
Parameters
- serverId: string
- options: CreateChannelOptions
Returns Promise<Channel>
- Defined in src/client.ts:634

updateChannel

updateChannel(
    serverId: string,
    channelId: string,
    patch: ChannelUpdate,
): Promise<Channel>
Parameters
- serverId: string
- channelId: string
- patch: ChannelUpdate
Returns Promise<Channel>
- Defined in src/client.ts:638

deleteChannel

deleteChannel(serverId: string, channelId: string): Promise<void>
Parameters
- serverId: string
- channelId: string
Returns Promise<void>
- Defined in src/client.ts:648

createCategory

createCategory(serverId: string, name: string): Promise<Category>
Parameters
- serverId: string
- name: string
Returns Promise<Category>
- Defined in src/client.ts:652

updateCategory

updateCategory(
    serverId: string,
    categoryId: string,
    patch: string | CategoryUpdate,
): Promise<Category>
Parameters
- serverId: string
- categoryId: string
- patch: string | CategoryUpdate
Returns Promise<Category>
- Defined in src/client.ts:656

deleteCategory

deleteCategory(serverId: string, categoryId: string): Promise<void>
Parameters
- serverId: string
- categoryId: string
Returns Promise<void>
- Defined in src/client.ts:665

updateChannelPositions

updateChannelPositions(
serverId: string,
positions: ChannelPositionUpdate[],
): Promise<void>
Parameters
- serverId: string
- positions: ChannelPositionUpdate[]
Returns Promise<void>
- Defined in src/client.ts:669

updateCategoryPositions

updateCategoryPositions(
serverId: string,
positions: CategoryPositionUpdate[],
): Promise<void>
Parameters
- serverId: string
- positions: CategoryPositionUpdate[]
Returns Promise<void>
- Defined in src/client.ts:678

fetchChannelSettings

fetchChannelSettings(serverId: string): Promise<ChannelSettings[]>
Parameters
- serverId: string
Returns Promise<ChannelSettings[]>
- Defined in src/client.ts:687

updateChannelSettings

updateChannelSettings(
    serverId: string,
    channelId: string,
    patch: ChannelSettingsPatch,
): Promise<void>
Parameters
- serverId: string
- channelId: string
- patch: ChannelSettingsPatch
Returns Promise<void>
- Defined in src/client.ts:694

fetchServerUserSettings

fetchServerUserSettings(
serverId: string,
): Promise<ServerUserSettings | undefined>
Reads per-server notification settings from the account settings bundle.
Parameters
- serverId: string
Returns Promise<ServerUserSettings | undefined>
- Defined in src/client.ts:703

updateServerUserSettings

updateServerUserSettings(
serverId: string,
patch: ServerUserSettings,
): Promise<void>
Parameters
- serverId: string
- patch: ServerUserSettings
Returns Promise<void>
- Defined in src/client.ts:714

markServerRead

markServerRead(serverId: string): Promise<void>
Parameters
- serverId: string
Returns Promise<void>
- Defined in src/client.ts:721

updateServerPositions

updateServerPositions(servers: ServerPositionUpdate[]): Promise<void>
Parameters
- servers: ServerPositionUpdate[]
Returns Promise<void>
- Defined in src/client.ts:725

createFolder

createFolder(name: string, color?: string): Promise<{ folder?: unknown }>
Parameters
- name: string
- Optionalcolor: string
Returns Promise<{ folder?: unknown }>
- Defined in src/client.ts:729

updateFolder

updateFolder(
folderId: string,
patch: { name?: string; color?: string | null },
): Promise<{ folder?: unknown }>
Parameters
- folderId: string
- patch: { name?: string; color?: string | null }
Returns Promise<{ folder?: unknown }>
- Defined in src/client.ts:735

deleteFolder

deleteFolder(folderId: string): Promise<void>
Parameters
- folderId: string
Returns Promise<void>
- Defined in src/client.ts:745

updateFolderPositions

updateFolderPositions(
positions: { id: string; position: number }[],
): Promise<void>
Parameters
- positions: { id: string; position: number }[]
Returns Promise<void>
- Defined in src/client.ts:749

fetchMembersPage

fetchMembersPage(
serverId: string,
options?: { limit?: number; offset?: number },
): Promise<MemberPage>
Parameters
- serverId: string
- options: { limit?: number; offset?: number } = {}
Returns Promise<MemberPage>
- Defined in src/client.ts:759

fetchMembers

fetchMembers(
serverId: string,
options?: { limit?: number; offset?: number },
): Promise<Member[]>
Parameters
- serverId: string
- options: { limit?: number; offset?: number } = {}
Returns Promise<Member[]>
- Defined in src/client.ts:768

fetchAllMembers

fetchAllMembers(
serverId: string,
options?: { pageSize?: number; maxPages?: number },
): Promise<Member[]>
Walks the member list until it is exhausted or maxPages is reached.
Parameters
- serverId: string
- options: { pageSize?: number; maxPages?: number } = {}
Returns Promise<Member[]>
- Defined in src/client.ts:777

fetchMember

fetchMember(serverId: string, userId: string): Promise<Member>
Parameters
- serverId: string
- userId: string
Returns Promise<Member>
- Defined in src/client.ts:806

fetchChannelMembers

fetchChannelMembers(serverId: string, channelId: string): Promise<string[]>
Parameters
- serverId: string
- channelId: string
Returns Promise<string[]>
- Defined in src/client.ts:810

updateMember

updateMember(
    serverId: string,
    userId: string,
    patch: { nickname?: string | null; [key: string]: unknown },
): Promise<Member>
Parameters
- serverId: string
- userId: string
- patch: { nickname?: string | null; [key: string]: unknown }
Returns Promise<Member>
- Defined in src/client.ts:820

setNickname

setNickname(
    serverId: string,
    userId: string,
    nickname: string | null,
): Promise<Member>
Parameters
- serverId: string
- userId: string
- nickname: string | null
Returns Promise<Member>
- Defined in src/client.ts:830

setMemberRoles

setMemberRoles(
    serverId: string,
    userId: string,
    add?: string[],
    remove?: string[],
): Promise<Member>
Parameters
- serverId: string
- userId: string
- add: string[] = []
- remove: string[] = []
Returns Promise<Member>
- Defined in src/client.ts:840

addMemberRole

addMemberRole(serverId: string, userId: string, roleId: string): Promise<Member>
Parameters
- serverId: string
- userId: string
- roleId: string
Returns Promise<Member>
- Defined in src/client.ts:851

removeMemberRole

removeMemberRole(
    serverId: string,
    userId: string,
    roleId: string,
): Promise<Member>
Parameters
- serverId: string
- userId: string
- roleId: string
Returns Promise<Member>
- Defined in src/client.ts:859

timeoutMember

timeoutMember(
    serverId: string,
    userId: string,
    durationSeconds: number,
    reason?: string,
): Promise<TimeoutResult>
Parameters
- serverId: string
- userId: string
- durationSeconds: number
- Optionalreason: string
Returns Promise<TimeoutResult>
- Defined in src/client.ts:867

removeTimeout

removeTimeout(serverId: string, userId: string): Promise<void>
Parameters
- serverId: string
- userId: string
Returns Promise<void>
- Defined in src/client.ts:879

kickMember

kickMember(serverId: string, userId: string, reason?: string): Promise<void>
Parameters
- serverId: string
- userId: string
- Optionalreason: string
Returns Promise<void>
- Defined in src/client.ts:883

banMember

banMember(serverId: string, userId: string, reason?: string): Promise<void>
Parameters
- serverId: string
- userId: string
- Optionalreason: string
Returns Promise<void>
- Defined in src/client.ts:893

fetchBans

fetchBans(serverId: string): Promise<ServerBan[]>
Parameters
- serverId: string
Returns Promise<ServerBan[]>
- Defined in src/client.ts:903

unbanMember

unbanMember(serverId: string, userId: string): Promise<void>
Parameters
- serverId: string
- userId: string
Returns Promise<void>
- Defined in src/client.ts:908

fetchRolesResponse

fetchRolesResponse(serverId: string): Promise<RolesResponse>
Parameters
- serverId: string
Returns Promise<RolesResponse>
- Defined in src/client.ts:912

fetchRoles

fetchRoles(serverId: string): Promise<Role[]>
Parameters
- serverId: string
Returns Promise<Role[]>
- Defined in src/client.ts:916

updateRoles

updateRoles(
    serverId: string,
    batch: RoleBatchPayload,
    iconFiles?: Record<string, Blob>,
): Promise<RoleBatchResponse>
Applies a role batch. Role icons can be uploaded by passing blobs keyed by role ID; the request is then sent as multipart changes + icon_<id>.
Parameters
- serverId: string
- batch: RoleBatchPayload
- iconFiles: Record<string, Blob> = {}
Returns Promise<RoleBatchResponse>
- Defined in src/client.ts:925

fetchServerPermissions

fetchServerPermissions(serverId: string): Promise<string>
Parameters
- serverId: string
Returns Promise<string>
- Defined in src/client.ts:956

fetchChannelPermissions

fetchChannelPermissions(serverId: string, channelId: string): Promise<string>
Parameters
- serverId: string
- channelId: string
Returns Promise<string>
- Defined in src/client.ts:963

fetchCategoryPermissions

fetchCategoryPermissions(serverId: string, categoryId: string): Promise<string>
Parameters
- serverId: string
- categoryId: string
Returns Promise<string>
- Defined in src/client.ts:973

fetchPermissionOverwrites

fetchPermissionOverwrites(
serverId: string,
target: PermissionTarget,
): Promise<PermissionOverwritesResponse>
Parameters
- serverId: string
- target: PermissionTarget
Returns Promise<PermissionOverwritesResponse>
- Defined in src/client.ts:983

updatePermissionOverwrites

updatePermissionOverwrites(
    serverId: string,
    target: PermissionTarget,
    payload: PermissionOverwritesInput,
): Promise<PermissionOverwritesResponse>
Parameters
- serverId: string
- target: PermissionTarget
- payload: PermissionOverwritesInput
Returns Promise<PermissionOverwritesResponse>
- Defined in src/client.ts:992

fetchInvites

fetchInvites(): Promise<GlobalInvites>
Returns Promise<GlobalInvites>
- Defined in src/client.ts:1007

createInvite

createInvite(
options?: { max_uses?: number; grants_root?: boolean },
): Promise<Invite>
Parameters
- options: { max_uses?: number; grants_root?: boolean } = {}
Returns Promise<Invite>
- Defined in src/client.ts:1011

deleteInvite

deleteInvite(code: string): Promise<void>
Parameters
- code: string
Returns Promise<void>
- Defined in src/client.ts:1015

validateInvite

validateInvite(code: string): Promise<unknown>
Parameters
- code: string
Returns Promise<unknown>
- Defined in src/client.ts:1019

fetchServerInvites

fetchServerInvites(serverId: string): Promise<ServerInvite[]>
Parameters
- serverId: string
Returns Promise<ServerInvite[]>
- Defined in src/client.ts:1023

createServerInvite

createServerInvite(
    serverId: string,
    options?: {
        max_uses?: number;
        expires_at?: string;
        channel_id?: string;
        force_new?: boolean;
    },
): Promise<Invite>
Parameters
- serverId: string
- options: {
      max_uses?: number;
      expires_at?: string;
      channel_id?: string;
      force_new?: boolean;
  } = {}
Returns Promise<Invite>
- Defined in src/client.ts:1030

deleteServerInvite

deleteServerInvite(serverId: string, code: string): Promise<void>
Parameters
- serverId: string
- code: string
Returns Promise<void>
- Defined in src/client.ts:1042

fetchServerInvite

fetchServerInvite(code: string): Promise<InvitePreview>
Parameters
- code: string
Returns Promise<InvitePreview>
- Defined in src/client.ts:1048

acceptServerInvite

acceptServerInvite(
code: string,
): Promise<
{ server?: Server; landing_channel_id?: string; [key: string]: unknown },
>
Parameters
- code: string
Returns Promise<
{ server?: Server; landing_channel_id?: string; [key: string]: unknown },
>
- Defined in src/client.ts:1054

fetchAuditLog

fetchAuditLog(
serverId: string,
options?: AuditLogOptions,
): Promise<AuditLogPage>
Parameters
- serverId: string
- options: AuditLogOptions = {}
Returns Promise<AuditLogPage>
- Defined in src/client.ts:1064

transferServer

transferServer(serverId: string, input: ServerTransferInput): Promise<unknown>
Parameters
- serverId: string
- input: ServerTransferInput
Returns Promise<unknown>
- Defined in src/client.ts:1079

acceptServerTransfer

acceptServerTransfer(serverId: string): Promise<void>
Parameters
- serverId: string
Returns Promise<void>
- Defined in src/client.ts:1086

denyServerTransfer

denyServerTransfer(serverId: string): Promise<void>
Parameters
- serverId: string
Returns Promise<void>
- Defined in src/client.ts:1090

cancelServerTransfer

cancelServerTransfer(serverId: string): Promise<void>
Parameters
- serverId: string
Returns Promise<void>
- Defined in src/client.ts:1094

fetchMessagesByIds

fetchMessagesByIds(ids: string[]): Promise<ConversationMessagesByIds>
Parameters
- ids: string[]
Returns Promise<ConversationMessagesByIds>
- Defined in src/client.ts:1102

searchMessages

searchMessages(
target: MessageTarget,
options: MessageSearchOptions,
): Promise<MessageSearchPage>
Streams a channel/conversation search. Flackle emits NDJSON by default but serves the same result as JSON when Accept: application/json is set.
Parameters
- target: MessageTarget
- options: MessageSearchOptions
Returns Promise<MessageSearchPage>
- Defined in src/client.ts:1112

bulkDeleteMessages

bulkDeleteMessages(
    serverId: string,
    channelId: string,
    count: number,
    reason?: string,
): Promise<BulkDeleteResult>
Parameters
- serverId: string
- channelId: string
- count: number
- Optionalreason: string
Returns Promise<BulkDeleteResult>
- Defined in src/client.ts:1124

fetchLatestMessageId

fetchLatestMessageId(
serverId: string,
channelId: string,
): Promise<string | null>
Parameters
- serverId: string
- channelId: string
Returns Promise<string | null>
- Defined in src/client.ts:1136

updateMessageEmbeds

updateMessageEmbeds(
    target: MessageTarget,
    messageId: string,
    embeds: Embed[],
): Promise<Message>
Parameters
- target: MessageTarget
- messageId: string
- embeds: Embed[]
Returns Promise<Message>
- Defined in src/client.ts:1146

saveMedia

saveMedia(url: string): Promise<MediaStorageSnapshot>
Parameters
- url: string
Returns Promise<MediaStorageSnapshot>
- Defined in src/client.ts:1156

unsaveMedia

unsaveMedia(url: string): Promise<MediaStorageSnapshot>
Parameters
- url: string
Returns Promise<MediaStorageSnapshot>
- Defined in src/client.ts:1160

createLinkPreview

createLinkPreview(url: string): Promise<unknown>
Parameters
- url: string
Returns Promise<unknown>
- Defined in src/client.ts:1164

fetchConversation

fetchConversation(conversationId: string): Promise<Conversation>
Parameters
- conversationId: string
Returns Promise<Conversation>
- Defined in src/client.ts:1172

createDM

createDM(userId: string): Promise<Conversation>
Parameters
- userId: string
Returns Promise<Conversation>
- Defined in src/client.ts:1176

createGroup

createGroup(memberIds: string[], name?: string): Promise<Conversation>
Parameters
- memberIds: string[]
- Optionalname: string
Returns Promise<Conversation>
- Defined in src/client.ts:1182

updateConversation

updateConversation(
conversationId: string,
patch: ConversationUpdate,
): Promise<Conversation>
Parameters
- conversationId: string
- patch: ConversationUpdate
Returns Promise<Conversation>
- Defined in src/client.ts:1188

deleteConversation

deleteConversation(conversationId: string): Promise<void>
Hides the conversation for the current account.
Parameters
- conversationId: string
Returns Promise<void>
- Defined in src/client.ts:1198

unhideConversation

unhideConversation(conversationId: string): Promise<void>
Parameters
- conversationId: string
Returns Promise<void>
- Defined in src/client.ts:1202

muteConversation

muteConversation(conversationId: string): Promise<void>
Parameters
- conversationId: string
Returns Promise<void>
- Defined in src/client.ts:1206

unmuteConversation

unmuteConversation(conversationId: string): Promise<void>
Parameters
- conversationId: string
Returns Promise<void>
- Defined in src/client.ts:1210

addConversationMembers

addConversationMembers(
conversationId: string,
memberIds: string[],
): Promise<{ members?: ConversationMember[]; [key: string]: unknown }>
Parameters
- conversationId: string
- memberIds: string[]
Returns Promise<{ members?: ConversationMember[]; [key: string]: unknown }>
- Defined in src/client.ts:1214

removeConversationMember

removeConversationMember(conversationId: string, userId: string): Promise<void>
Parameters
- conversationId: string
- userId: string
Returns Promise<void>
- Defined in src/client.ts:1223

leaveConversation

leaveConversation(conversationId: string, silent?: boolean): Promise<void>
Parameters
- conversationId: string
- silent: boolean = false
Returns Promise<void>
- Defined in src/client.ts:1230

uploadConversationIcon

uploadConversationIcon(conversationId: string, image: Blob): Promise<string>
Parameters
- conversationId: string
- image: Blob
Returns Promise<string>
- Defined in src/client.ts:1236

fetchConversationVoiceState

fetchConversationVoiceState(
conversationId: string,
): Promise<ConversationVoiceState>
Parameters
- conversationId: string
Returns Promise<ConversationVoiceState>
- Defined in src/client.ts:1244

declineConversationCall

declineConversationCall(conversationId: string): Promise<void>
Parameters
- conversationId: string
Returns Promise<void>
- Defined in src/client.ts:1252

stopConversationRinging

stopConversationRinging(conversationId: string, userId: string): Promise<void>
Parameters
- conversationId: string
- userId: string
Returns Promise<void>
- Defined in src/client.ts:1256

fetchBlockedWarning

fetchBlockedWarning(
conversationId: string,
): Promise<{ should_show?: boolean; blocked_members?: unknown[] }>
Parameters
- conversationId: string
Returns Promise<{ should_show?: boolean; blocked_members?: unknown[] }>
- Defined in src/client.ts:1265

dismissBlockedWarning

dismissBlockedWarning(conversationId: string): Promise<void>
Parameters
- conversationId: string
Returns Promise<void>
- Defined in src/client.ts:1271

fetchUserByUsername

fetchUserByUsername(username: string): Promise<User>
Parameters
- username: string
Returns Promise<User>
- Defined in src/client.ts:1279

fetchUserById

fetchUserById(userId: string): Promise<User>
Parameters
- userId: string
Returns Promise<User>
- Defined in src/client.ts:1283

fetchUserCard

fetchUserCard(username: string, serverId?: string): Promise<UserCard>
Parameters
- username: string
- OptionalserverId: string
Returns Promise<UserCard>
- Defined in src/client.ts:1287

fetchUserBento

fetchUserBento(username: string): Promise<BentoCard[]>
Parameters
- username: string
Returns Promise<BentoCard[]>
- Defined in src/client.ts:1294

fetchUserBlocks

fetchUserBlocks(username: string): Promise<BlockEntry[]>
Parameters
- username: string
Returns Promise<BlockEntry[]>
- Defined in src/client.ts:1301

updateBento

updateBento(cards: BentoCard[]): Promise<BentoResponse>
Parameters
- cards: BentoCard[]
Returns Promise<BentoResponse>
- Defined in src/client.ts:1308

updateBlocks

updateBlocks(blocks: BlockEntry[]): Promise<BlocksResponse>
Parameters
- blocks: BlockEntry[]
Returns Promise<BlocksResponse>
- Defined in src/client.ts:1312

uploadBlockImage

uploadBlockImage(image: Blob): Promise<string>
Parameters
- image: Blob
Returns Promise<string>
- Defined in src/client.ts:1316

updateProfile

updateProfile(
    patch: {
        display_name?: string | null;
        username?: string;
        password?: string;
    },
): Promise<User>
Parameters
- patch: { display_name?: string | null; username?: string; password?: string }
Returns Promise<User>
- Defined in src/client.ts:1320

uploadAvatar

uploadAvatar(image: Blob): Promise<string>
Parameters
- image: Blob
Returns Promise<string>
- Defined in src/client.ts:1328

uploadBanner

uploadBanner(image: Blob): Promise<string>
Parameters
- image: Blob
Returns Promise<string>
- Defined in src/client.ts:1332

checkUsername

checkUsername(
username: string,
): Promise<{ available?: boolean; [key: string]: unknown }>
Parameters
- username: string
Returns Promise<{ available?: boolean; [key: string]: unknown }>
- Defined in src/client.ts:1336

updateTypingIndicator

updateTypingIndicator(
settings: TypingIndicatorSettings,
): Promise<TypingIndicatorSettings>
Parameters
- settings: TypingIndicatorSettings
Returns Promise<TypingIndicatorSettings>
- Defined in src/client.ts:1342

changePassword

changePassword(
currentPassword: string,
newPassword: string,
): Promise<{ message?: string; [key: string]: unknown }>
Parameters
- currentPassword: string
- newPassword: string
Returns Promise<{ message?: string; [key: string]: unknown }>
- Defined in src/client.ts:1354

changeEmail

changeEmail(newEmail: string, password: string): Promise<unknown>
Parameters
- newEmail: string
- password: string
Returns Promise<unknown>
- Defined in src/client.ts:1363

fetch2FAStatus

fetch2FAStatus(): Promise<TwoFactorStatus>
Returns Promise<TwoFactorStatus>
- Defined in src/client.ts:1369

setup2FA

setup2FA(password: string): Promise<TwoFactorSetup>
Parameters
- password: string
Returns Promise<TwoFactorSetup>
- Defined in src/client.ts:1373

confirm2FA

confirm2FA(code: string): Promise<unknown>
Parameters
- code: string
Returns Promise<unknown>
- Defined in src/client.ts:1377

disable2FA

disable2FA(
options: { password: string; code?: string; backupCode?: string },
): Promise<void>
Parameters
- options: { password: string; code?: string; backupCode?: string }
Returns Promise<void>
- Defined in src/client.ts:1381

createBackupCodes

createBackupCodes(password: string, code: string): Promise<BackupCodes>
Parameters
- password: string
- code: string
Returns Promise<BackupCodes>
- Defined in src/client.ts:1394

revokeSession

revokeSession(sessionId: string, code?: string): Promise<void>
Parameters
- sessionId: string
- Optionalcode: string
Returns Promise<void>
- Defined in src/client.ts:1400

revokeAllSessions

revokeAllSessions(code?: string): Promise<void>
Parameters
- Optionalcode: string
Returns Promise<void>
- Defined in src/client.ts:1406

fetchSecurityEvents

fetchSecurityEvents(): Promise<SecurityEvent[]>
Returns Promise<SecurityEvent[]>
- Defined in src/client.ts:1410

clearSecurityEvents

clearSecurityEvents(code?: string): Promise<void>
Parameters
- Optionalcode: string
Returns Promise<void>
- Defined in src/client.ts:1417

fetchGdprRequests

fetchGdprRequests(): Promise<GdprRequest[]>
Returns Promise<GdprRequest[]>
- Defined in src/client.ts:1423

submitGdprRequest

submitGdprRequest(type: string & {} | "data" | "delete"): Promise<void>
Parameters
- type: string & {} | "data" | "delete"
Returns Promise<void>
- Defined in src/client.ts:1428

cancelAccountDeletion

cancelAccountDeletion(): Promise<void>
Returns Promise<void>
- Defined in src/client.ts:1432

acceptLegal

acceptLegal(version: string): Promise<void>
Parameters
- version: string
Returns Promise<void>
- Defined in src/client.ts:1436

createBillingPortal

createBillingPortal(): Promise<BillingSession>
Returns Promise<BillingSession>
- Defined in src/client.ts:1440

fetchServerVoiceState

fetchServerVoiceState(serverId: string, channelId: string): Promise<unknown>
Parameters
- serverId: string
- channelId: string
Returns Promise<unknown>
- Defined in src/client.ts:1448

fetchServerVoiceStates

fetchServerVoiceStates(serverId: string): Promise<ServerVoiceStatesResponse>
Parameters
- serverId: string
Returns Promise<ServerVoiceStatesResponse>
- Defined in src/client.ts:1452

warmVoice

warmVoice(serverId: string, channelId: string): Promise<void>
Parameters
- serverId: string
- channelId: string
Returns Promise<void>
- Defined in src/client.ts:1458

serverMuteVoiceMember

serverMuteVoiceMember(
    serverId: string,
    channelId: string,
    userId: string,
    muted: boolean,
): Promise<void>
Parameters
- serverId: string
- channelId: string
- userId: string
- muted: boolean
Returns Promise<void>
- Defined in src/client.ts:1462

serverDeafenVoiceMember

serverDeafenVoiceMember(
    serverId: string,
    channelId: string,
    userId: string,
    deafened: boolean,
): Promise<void>
Parameters
- serverId: string
- channelId: string
- userId: string
- deafened: boolean
Returns Promise<void>
- Defined in src/client.ts:1474

moveVoiceMember

moveVoiceMember(
    serverId: string,
    channelId: string,
    userId: string,
): Promise<void>
Moves a member into the moderator's current voice channel.
Parameters
- serverId: string
- channelId: string
- userId: string
Returns Promise<void>
- Defined in src/client.ts:1487

disconnectVoiceMember

disconnectVoiceMember(
    serverId: string,
    channelId: string,
    userId: string,
): Promise<void>
Parameters
- serverId: string
- channelId: string
- userId: string
Returns Promise<void>
- Defined in src/client.ts:1497

submitReport

submitReport(input: ReportInput): Promise<unknown>
Parameters
- input: ReportInput
Returns Promise<unknown>
- Defined in src/client.ts:1511

reportUser

reportUser(
userId: string,
options: Omit<ReportInput, "report_type" | "reported_user_id">,
): Promise<unknown>
Parameters
- userId: string
- options: Omit<ReportInput, "report_type" | "reported_user_id">
Returns Promise<unknown>
- Defined in src/client.ts:1515

reportMessage

reportMessage(
    target: MessageTarget,
    messageId: string,
    options: Omit<
        ReportInput,
        | "report_type"
        | "reported_message_id"
        | "reported_channel_id"
        | "reported_conversation_id",
    >,
): Promise<unknown>
Parameters
- target: MessageTarget
- messageId: string
- options: Omit<
      ReportInput,
      | "report_type"
      | "reported_message_id"
      | "reported_channel_id"
      | "reported_conversation_id",
  >
Returns Promise<unknown>
- Defined in src/client.ts:1526

fetchServerLifts

fetchServerLifts(serverId: string): Promise<unknown>
Parameters
- serverId: string
Returns Promise<unknown>
- Defined in src/client.ts:1548

fetchServerLiftSupporters

fetchServerLiftSupporters(serverId: string): Promise<unknown>
Parameters
- serverId: string
Returns Promise<unknown>
- Defined in src/client.ts:1552

setSupporterRole

setSupporterRole(
serverId: string,
roleId: string | null,
): Promise<SupporterRoleResponse>
Parameters
- serverId: string
- roleId: string | null
Returns Promise<SupporterRoleResponse>
- Defined in src/client.ts:1556

fetchChannelAnalytics

fetchChannelAnalytics(
    serverId: string,
    channelId: string,
    scope: string,
): Promise<unknown>
Parameters
- serverId: string
- channelId: string
- scope: string
Returns Promise<unknown>
- Defined in src/client.ts:1566

fetchChannelAnalyticsBundle

fetchChannelAnalyticsBundle(
serverId: string,
channelId: string,
): Promise<unknown>
Parameters
- serverId: string
- channelId: string
Returns Promise<unknown>
- Defined in src/client.ts:1577

fetchChannelAnalyticsCalendar

fetchChannelAnalyticsCalendar(
    serverId: string,
    channelId: string,
    query?: Record<string, unknown>,
): Promise<unknown>
Parameters
- serverId: string
- channelId: string
- query: Record<string, unknown> = {}
Returns Promise<unknown>
- Defined in src/client.ts:1586

fetchChannelAnalyticsPunchcard

fetchChannelAnalyticsPunchcard(
    serverId: string,
    channelId: string,
    days?: number,
): Promise<unknown>
Parameters
- serverId: string
- channelId: string
- days: number = 30
Returns Promise<unknown>
- Defined in src/client.ts:1597

fetchSpotify

fetchSpotify(url: string): Promise<unknown>
Parameters
- url: string
Returns Promise<unknown>
- Defined in src/client.ts:1608

searchGames

searchGames(query: string): Promise<Game[]>
Looks up game metadata used by rich presence embeds.
Parameters
- query: string
Returns Promise<Game[]>
- Defined in src/client.ts:1613

fetchGame

fetchGame(gameId: string): Promise<Game>
Parameters
- gameId: string
Returns Promise<Game>
- Defined in src/client.ts:1620

fetchTweet

fetchTweet(url: string): Promise<unknown>
Parameters
- url: string
Returns Promise<unknown>
- Defined in src/client.ts:1624

fetchWeather

fetchWeather(location: string): Promise<unknown>
Parameters
- location: string
Returns Promise<unknown>
- Defined in src/client.ts:1628

searchWeather

searchWeather(query: string): Promise<unknown>
Parameters
- query: string
Returns Promise<unknown>
- Defined in src/client.ts:1632

on

on<K extends keyof GatewayEvents>(
event: K,
listener: Listener<GatewayEvents[K]>,
): this
Type Parameters
- K extends keyof GatewayEvents
Parameters
- event: K
- listener: Listener<GatewayEvents[K]>
Returns this
Inherited from TypedEmitter.on
- Defined in src/events.ts:15

once

once<K extends keyof GatewayEvents>(
event: K,
listener: Listener<GatewayEvents[K]>,
): this
Type Parameters
- K extends keyof GatewayEvents
Parameters
- event: K
- listener: Listener<GatewayEvents[K]>
Returns this
Inherited from TypedEmitter.once
- Defined in src/events.ts:25

off

off<K extends keyof GatewayEvents>(
event: K,
listener: Listener<GatewayEvents[K]>,
): this
Type Parameters
- K extends keyof GatewayEvents
Parameters
- event: K
- listener: Listener<GatewayEvents[K]>
Returns this
Inherited from TypedEmitter.off
- Defined in src/events.ts:33

emit

emit<K extends keyof GatewayEvents>(
event: K,
payload: GatewayEvents[K],
): boolean
Type Parameters
- K extends keyof GatewayEvents
Parameters
- event: K
- payload: GatewayEvents[K]
Returns boolean
Inherited from TypedEmitter.emit
- Defined in src/events.ts:38

listenerCount

listenerCount(event: keyof GatewayEvents): number
Parameters
- event: keyof GatewayEvents
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in src/events.ts:52

removeAllListeners

removeAllListeners(event?: keyof GatewayEvents): this
Parameters
- Optionalevent: keyof GatewayEvents
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in src/events.ts:56

Properties

`Readonly`rest

rest: RestClient

`Readonly`gateway

gateway: Gateway

`Readonly`autoSubscribe

autoSubscribe: boolean

`Optional`user

user?: SelfUser

Class FlackleClient

Hierarchy (View Summary)

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns FlackleClient

Methods

login

Parameters

Returns Promise<SelfUser>

refreshSession

Returns Promise<SelfUser>

fetchMe

Returns Promise<SelfUser>

connect

Returns Promise<void>

destroy

Returns Promise<void>

fetchEntry

Returns Promise<BootstrapPayload>

fetchServers

Returns Promise<Server[]>

fetchServer

Parameters

Returns Promise<Server>

fetchChannels

Parameters

Returns Promise<ChannelBundle>

fetchConversations

Returns Promise<Conversation[]>

fetchUnreadSummary

Returns Promise<{ channels: UnreadChannel[] }>

fetchServerSettings

Returns Promise<ServerFolders>

fetchVoiceStates

Returns Promise<{ voice_states: Record<Snowflake, VoiceState[]> }>

fetchStatus

Returns Promise<{ status: PresenceStatus }>

setStatus

Parameters

Returns Promise<void>

fetchSessions

Returns Promise<{ sessions: SessionInfo[] }>

fetchSavedMedia

Parameters

Returns Promise<SavedMediaPage>

logout

Returns Promise<void>

fetchMessages

Parameters

Returns Promise<Page<Message>>

sendMessage

Parameters

Returns Promise<Message>

editMessage

Parameters

Returns Promise<void>

deleteMessage

Parameters

Returns Promise<void>

sendTyping

Parameters

Returns Promise<void>

stopTyping

Parameters

Returns Promise<void>

markRead

Parameters

Returns Promise<void>

react

Parameters

Returns Promise<void>

unreact

Parameters

Returns Promise<void>

fetchReactions