Each client method with the first sentence of its documentation
JavaScript & TypeScript#
client#
client.[asyncDispose] - Shut down this client and wait for cleanup, as
await usingdoes at the end of a block client.connect - Connect the gateway and complete when every shard assigned to this client has authenticated and received READY
client.diagnostics - Read a frozen local report of active work, queues and cache occupancy
client.observe State - Receive the current connection state, then later state updates
client.run - Start and maintain a gateway connection for the client's whole lifetime, including transient recovery, until shutdown, permanent failure or cancellation
client.schedule - Run a task later, once or repeatedly, as part of this client's lifetime instead of an event handler or command
client.shard Id For Guild - Return the ID of this client's shard that receives a community's gateway events, or undefined when another process owns that shard
client.shutdown - Permanently close this client and wait for startup, recovery, sockets and request cleanup
client.subscribe - Receive future events of one type in receive order through a bounded buffer
client.use - Add event middleware that runs around every later on handler invocation, for every event and subscription, including subscriptions registered before it, command routers and
runhandlersBot client.wait For - Wait for the first future event of one type that passes the supplied synchronous filter
client.wait For Close - Wait for this client's final shutdown or permanent connection failure, without starting or owning a connection
client.application #
client.application .fetch - Fetch this bot token's application data from /oauth2/
applications/@me
client.attachments #
client.attachments .download - Download
attachmentinto one Uint8Array.url client.attachments .refresh Urls - Ask Fluxer's bot-authenticated API to reissue signatures for 1 through 50 URL strings
client.attachments .stream - Read
attachmentas chunks without combining the file into one array.url
client.auditLogs #
client.audit Logs .fetch Page - Fetch one filtered audit page with referenced users and webhook metadata that excludes tokens
client.audit Logs .iterate - Read filtered audit entries newest first, buffering one page and never prefetching
client.cache #
client.cache .clear - Release data held by this client's caches without changing which caches are enabled
client.cache .delete - Remove one entry from a cache category by its key, without fetching, refreshing or changing the remote resource
client.cache .entries - Return frozen snapshots from one configured cache category, ordered least to most recently used
client.cache .on Change - Observe every later change to this client's local caches: Stored or replaced entries, removed entries and whole-category clears
client.channels #
client.channels .create - Create a supported community channel and return its frozen server snapshot
client.channels .create Forum Tag - Add one tag to a forum or media channel and return the frozen updated channel
client.channels .delete - Delete a community channel, succeeding with no value after HTTP
204 client.channels .delete Forum Tag - Delete one tag from a forum or media channel and return the frozen updated channel
client.channels .edit - Change only the supplied channel settings and return the frozen server snapshot
client.channels .edit Forum Tag - Replace one tag of a forum or media channel and return the frozen updated channel
client.channels .fetch - Fetch a community channel by decimal ID and return a frozen snapshot
client.channels .fetch All - Fetch the community channels currently visible to the bot, without pagination
client.channels .fetch Follower Stats - Fetch frozen channel and distinct community follower counts for a viewable announcement channel
client.channels .fetch Member Counts - Request fresh member counts for 1–25 channels in one community over the connected gateway
client.channels .follow - Follow an announcement channel into the supplied community text channel and return frozen source and webhook IDs
client.channels .get - Look up a community channel in the enabled cache, without an HTTP request or a connection
client.channels .remove Permission Overwrite - Remove one explicit permission overwrite by decimal role or member target ID
client.channels .reorder - Submit community-channel moves, succeeding with no value after HTTP
204 client.channels .set Permission Overwrite - Replace one explicit role or member permission overwrite
client.directMessages #
client.direct Messages .close - Close a one-to-one conversation for this bot, or leave a group conversation
client.direct Messages .edit Group - Change supplied settings of an existing group conversation
client.direct Messages .fetch - Fetch a private channel by decimal ID
client.direct Messages .fetch All - Fetch this bot's currently open one-to-one and group conversations
client.direct Messages .fetch Latest Messages - Fetch the latest messages for 1–100 selected, distinct private channel IDs through Fluxer's batch endpoint
client.direct Messages .get - Look up a private channel in the optional cache using its decimal ID, without a request
client.direct Messages .open - Open or reopen a one-to-one conversation with the selected user
client.direct Messages .remove Recipient - Remove a group recipient as owner, or remove the bot itself
client.direct Messages .send - Open or reopen a one-to-one conversation with a user, then send a message
client.discovery #
client.discovery .apply - Submit a community's application to the public directory
client.discovery .edit - Change supplied fields of a pending or approved directory application
client.discovery .fetch Categories - Fetch directory category IDs and Fluxer's category labels in provider order
client.discovery .fetch Status - Fetch a community's current directory eligibility and application state
client.discovery .search - Fetch one page from the current public community directory
client.discovery .withdraw - Withdraw a pending application or remove an approved directory listing
client.emojis #
client.emojis .clone - Copy an emoji into a community by its source ID, using Fluxer's server-side copy
client.emojis .create - Upload one community emoji and return its metadata
client.emojis .create Many - Upload 1–50 community emojis in one batch and return separate successes and failures
client.emojis .delete - Remove an emoji, succeeding with no value after HTTP
204 client.emojis .edit - Rename a community emoji without changing its image or fetching its old metadata first
client.emojis .fetch All - Fetch a community's emoji list in Fluxer's order, without pagination
client.emojis .fetch Metadata - Fetch minimal emoji metadata by decimal ID, without requiring source-community membership
client.emojis .fetch Source - Fetch the public presentation of the community that owns a custom emoji with this decimal ID: Its ID, name, icon hash and badges
client.emojis .get - Look up cached emoji metadata using decimal
guildand id, without an HTTP requestId
client.gateway #
client.gateway .send - Send one command frame { op, d } on a Connected local shard
client.guilds #
client.guilds .delete Own Messages - Irreversibly delete this bot's entire authored message history across one community
client.guilds .edit - Change only supplied community settings that a bot may edit
client.guilds .edit Vanity Url - Set a community's custom invite code, replace it, or pass null to remove it
client.guilds .fetch - Fetch a community's identity and settings by decimal ID
client.guilds .fetch Counts - Request fresh, visibility-filtered counts for 1–100 communities over the connected gateway
client.guilds .fetch Page - Fetch one page of communities this bot belongs to, ordered by ascending guild ID
client.guilds .fetch Vanity Url - Fetch a community's custom invite code, URL and use count with ManageGuild permission
client.guilds .get - Look up a community in the enabled guild cache, without a request or gateway connection
client.guilds .iterate - Read the bot's community memberships in ascending ID order, retaining one page and never prefetching
client.guilds .leave - Remove this bot from one community while preserving its authored messages
client.instance #
client.instance .resolve - Resolve this client's instance endpoints and its pure link and asset URL helpers
client.invites #
client.invites .create - Create an invite for an accessible channel, including an existing group direct message
client.invites .delete - Revoke an invite code, succeeding with no value after HTTP
204 client.invites .fetch - Look up an invite code without using it or joining its destination
client.invites .fetch For Channel - List a channel's management-visible invites in Fluxer's order
client.invites .fetch For Guild - List a community's management-visible invites with ManageGuild permission
client.logging #
client.logging .configure - Replace the client's log level and per-category levels, and optionally its Debug categories, effective for the next record
client.members #
client.members .add Role - Grant one role to a member without replacing their other roles
client.members .ban - Ban a user from a community, including a user who is not currently a member
client.members .clear Timeout - Clear a member's timeout and return the HTTP member snapshot
client.members .disconnect - Disconnect one observed voice connection, or all active connections if
targetis omitted.connection Id client.members .edit Self - Change this bot's community profile, not its global account or another member
client.members .fetch - Fetch one community member by decimal
guildandId userId client.members .fetch Bans - Fetch a community's current full ban list with BanMembers permission
client.members .fetch Can Manage - Check whether the bot, or the member named by
options, is above a target member in the community's role hierarchy.actor User Id client.members .fetch Page - Fetch one page of members ordered by ascending user ID
client.members .fetch Self - Fetch this bot's membership in a community without knowing its user ID
client.members .get - Look up a community member by decimal
guildandId userin the enabled cache, without a requestId client.members .get Self - Look up this bot's own membership of a community by decimal
guildin the enabled member cache, without a requestId client.members .iterate - Read community members by ascending user ID, without connecting the gateway or downloading the community eagerly
client.members .iterate Chunks - Request one community's members over the gateway and deliver frozen batches without accumulating a roster
client.members .iterate Search - Read unique indexed member-search hits with a bounded scan
client.members .kick - Remove a member from the community, succeeding with no value after HTTP
204 client.members .move - Move a member who is already in voice to a positive decimal voice-channel ID
client.members .remove Role - Remove one role from a member while leaving other roles unchanged
client.members .search - Search Fluxer's member index for a community, without using or populating the member cache
client.members .set Deaf - Set or clear the community deafen flag for a member currently connected to voice
client.members .set Mute - Set or clear the community mute flag for a member currently connected to voice
client.members .set Nickname - Set one member's nickname, or pass null to clear it
client.members .set Roles - Replace one member's entire assigned role list in a single PATCH request
client.members .timeout - Temporarily restrict a community member for
durationmillisecondsMs client.members .timeout State - Report whether a member is timed out, from the member's
communicationand a moment in timeDisabled Until client.members .unban - Remove a user's community ban, succeeding with no value after HTTP
204
client.messages #
client.messages .add Reaction - Add the bot's own reaction to a message
client.messages .cleanup - Delete the exact IDs in a plan returned by
preview, in sequential batches of at most 100Cleanup client.messages .clear Reaction - Remove all users' reactions for one emoji on the message
client.messages .clear Reactions - Remove all users' reactions for all emoji on the message, without deleting the message
client.messages .collect - Collect a bounded set of future
messageevents from one channelCreate client.messages .collect Reactions - Collect future reaction additions for one message
client.messages .delete - Delete one message, succeeding with no value after HTTP
204 client.messages .delete Attachment - Delete one attachment by its decimal ID from a message authored by this bot
client.messages .delete Many - Delete 1–100 distinct decimal message IDs from one community channel
client.messages .delete Own Messages - Irreversibly delete this bot's entire authored message history in one channel and in every thread under it, active or archived
client.messages .edit - Change a message's supplied fields and return its frozen updated snapshot after HTTP, without waiting for a gateway event
client.messages .fetch - Fetch one message from Fluxer, rather than reading the cache
client.messages .fetch Crosspost Source - Fetch frozen public source-community metadata for a published copy or a ChannelFollowAdd notice
client.messages .fetch Has Reaction - Check whether one user currently has a given reaction on a message, with one request and no cache
client.messages .fetch History - Fetch one page of channel messages from Fluxer, newest first
client.messages .fetch Pins - Fetch one frozen page of pinned messages in descending pin-time order
client.messages .fetch Reaction Users - Fetch one page of users who currently have a selected reaction on the message
client.messages .forward - Copy an accessible source message into the destination channel and return the new message
client.messages .get - Look up a message in this client's cache, without an HTTP request
client.messages .iterate History - Read older messages newest first, without connecting the gateway
client.messages .iterate Pins - Read pinned messages newest pin first, without adding message cache entries
client.messages .iterate Reaction Users - Read users who reacted with one selected emoji, in ascending user-ID order
client.messages .iterate Search - Read indexed search hits from the supplied community or channel context, following numbered pages without polling, prefetching or cache population
client.messages .keep Typing - Keep the bot's typing indicator active while a task runs, returning the task's value
client.messages .paginate - Show several pages in one message that people flip with ◀ and ▶ reactions, because Fluxer has no buttons
client.messages .pin - Pin a message using its decimal id and
channelId client.messages .preview Cleanup - Preview a bounded message-deletion selection without deleting anything
client.messages .publish - Publish an ordinary source message from an announcement channel and return its frozen updated snapshot
client.messages .remove Reaction - Remove only the bot's own reaction for the selected emoji
client.messages .remove User Reaction - Remove one user's reaction for one emoji, leaving other users and emoji groups unchanged
client.messages .reply - Send a reply that references an existing message and return the new reply
client.messages .search - Search messages in one explicit community or channel and return one page from Fluxer's search index
client.messages .send - Send text, embeds, files or stickers to a channel and return the created message
client.messages .typing - Show this bot's temporary typing indicator in a channel
client.messages .unpin - Remove a pin without deleting the message or its pin-created system message
client.permissions #
client.permissions .calculate - Calculate permission flags from supplied guild, member, role and optional channel data
client.permissions .fetch - Fetch guild, member, role and optional channel data, then calculate their permission flags
client.permissions .fetch Channels - Fetch one member's permission flags in every channel of a community, such as to see what the bot can do in each channel
client.presence #
client.presence .set - Set the bot's requested status and optional custom status, including before connecting
client.presence .set Members - Request presence updates for selected members in one community
client.rest #
client.rest .request - Send one request to a route under /v1 and resolve with its status, lower-case headers and parsed JSON body
client.roles #
client.roles .create - Create a role with a name, optional color and permission flags
client.roles .delete - Delete a role and remove its member assignments in Fluxer
client.roles .edit - Change only supplied role fields and return the server's snapshot
client.roles .fetch All - Fetch the community's current role list, including everyone, in server order
client.roles .get - Look up a role by decimal
guildand id in the enabled cache, including the everyone roleId client.roles .get All - Look up every role of a community by decimal
guildin the enabled cache, including the everyone roleId client.roles .reorder - Change role hierarchy positions using distinct role IDs and nonnegative safe-integer positions
client.roles .reset Hoist Positions - Clear display-position assignments across the community, including roles above the bot
client.roles .set Hoist Positions - Set roles' display positions without changing their permission hierarchy or enabling hoist
client.stickers #
client.stickers .clone - Copy a sticker into a community by its source ID, using Fluxer's server-side copy
client.stickers .create - Upload one community sticker and return its metadata
client.stickers .create Many - Upload 1–50 community stickers in one batch and return separate successes and failures
client.stickers .delete - Remove a sticker, succeeding with no value after HTTP
204 client.stickers .edit - Replace a sticker's name, description and tags without changing its image or fetching it first
client.stickers .fetch All - Fetch a community's sticker list in Fluxer's order, without pagination
client.stickers .fetch Metadata - Fetch minimal sticker metadata by decimal ID, without requiring source-community membership
client.stickers .fetch Source - Fetch the public presentation of the community that owns a custom sticker with this decimal ID: Its ID, name, icon hash and badges
client.stickers .get - Look up cached sticker metadata using decimal
guildand id, without an HTTP requestId
client.threads #
client.threads .add Member - Add a community member who can view the parent channel to a thread, succeeding with no value after HTTP
204 client.threads .create - Create a thread that is not attached to a message in a text or announcement channel, and return its frozen snapshot
client.threads .create From Message - Start a public thread on an existing message and return its frozen snapshot
client.threads .create Post - Create a post in a forum or media channel, a public thread with its first message, and return both frozen
client.threads .edit - Change only the supplied thread settings and return the frozen thread
client.threads .fetch Active - Fetch every active thread the bot can view in a community, newest first, as one frozen list
client.threads .fetch Archived - Fetch one frozen page of archived threads of a text, announcement, forum or media channel, as
ArchivedselectsThread Query client.threads .fetch Member - Fetch one thread member as a frozen
ThreadMember client.threads .fetch Members - Fetch one page of thread members in ascending user ID order, as frozen
ThreadvaluesMember client.threads .iterate Members - Read thread members in ascending user ID order, buffering one page and never prefetching
client.threads .join - Add the bot to a thread, succeeding with no value after HTTP
204 client.threads .leave - Remove the bot from a thread, succeeding with no value after HTTP
204 client.threads .remove Member - Remove a member from a thread, succeeding with no value after HTTP
204, and Fluxer posts a RecipientRemove notice in the thread client.threads .search - Search the threads of a text, announcement, forum or media channel by name, tags and state, and return one frozen page
client.users #
client.users .fetch - Fetch a public account snapshot by decimal user ID
client.users .fetch Profile - Fetch a user's privacy-filtered profile, optionally for the community specified in
query.guild Id client.users .fetch Self - Fetch the authenticated bot's public account data remotely
client.users .get - Look up a public account in the optional cache using its decimal ID, without a request
client.users .get Self - Look up the bot's own public account as the gateway's READY reported it, without a request
client.webhooks #
client.webhooks .create - Create an incoming webhook in a text, voice or announcement channel using the bot's permissions
client.webhooks .delete - Delete an incoming webhook and revoke its credential, or delete a follower webhook to unfollow its source
client.webhooks .edit - Change the supplied incoming or follower webhook settings, including its destination channel
client.webhooks .fetch - Fetch incoming, follower or unknown-kind metadata by decimal ID, discarding any returned token
client.webhooks .fetch For Channel - List the channel's accessible incoming, follower and unknown-kind webhook metadata without pagination
client.webhooks .fetch For Guild - List the community's accessible incoming, follower and unknown-kind webhook metadata
Effect API#
client#
client.connect - Connect the gateway and complete when every shard assigned to this client has authenticated and received READY
client.diagnostics - Read a frozen local report of active work, queues and cache occupancy
client.observe State - Receive the current connection state, then later state updates
client.run - Start and maintain a gateway connection for the client's whole lifetime, including transient recovery, until shutdown, permanent failure or cancellation
client.schedule - Run a task later, once or repeatedly, as part of this client's lifetime instead of an event handler or command
client.shard Id For Guild - Return the ID of this client's shard that receives a community's gateway events, or undefined when another process owns that shard
client.shutdown - Permanently close this client and wait for startup, recovery, sockets and request cleanup
client.subscribe - Receive future events of one type in receive order through a bounded buffer
client.use - Add event middleware that runs around every later on handler invocation, for every event and subscription, including subscriptions registered before it, command routers and
runhandlersBot client.wait For - Wait for the first future event of one type that passes the supplied synchronous filter
client.wait For Close - Wait for this client's final shutdown or permanent connection failure, without starting or owning a connection
client.application #
client.application .fetch - Fetch this bot token's application data from /oauth2/
applications/@me
client.attachments #
client.attachments .download - Download
attachmentinto one Uint8Array.url client.attachments .refresh Urls - Ask Fluxer's bot-authenticated API to reissue signatures for 1 through 50 URL strings
client.attachments .stream - Read
attachmentas chunks without combining the file into one array.url
client.auditLogs #
client.audit Logs .fetch Page - Fetch one filtered audit page with referenced users and webhook metadata that excludes tokens
client.audit Logs .iterate - Read filtered audit entries newest first, buffering one page and never prefetching
client.cache #
client.cache .clear - Release data held by this client's caches without changing which caches are enabled
client.cache .delete - Remove one entry from a cache category by its key, without fetching, refreshing or changing the remote resource
client.cache .entries - Return frozen snapshots from one configured cache category, ordered least to most recently used
client.cache .on Change - Observe every later change to this client's local caches: Stored or replaced entries, removed entries and whole-category clears
client.channels #
client.channels .create - Create a supported community channel and return its frozen server snapshot
client.channels .create Forum Tag - Add one tag to a forum or media channel and return the frozen updated channel
client.channels .delete - Delete a community channel, succeeding with no value after HTTP
204 client.channels .delete Forum Tag - Delete one tag from a forum or media channel and return the frozen updated channel
client.channels .edit - Change only the supplied channel settings and return the frozen server snapshot
client.channels .edit Forum Tag - Replace one tag of a forum or media channel and return the frozen updated channel
client.channels .fetch - Fetch a community channel by decimal ID and return a frozen snapshot
client.channels .fetch All - Fetch the community channels currently visible to the bot, without pagination
client.channels .fetch Follower Stats - Fetch frozen channel and distinct community follower counts for a viewable announcement channel
client.channels .fetch Member Counts - Request fresh member counts for 1–25 channels in one community over the connected gateway
client.channels .follow - Follow an announcement channel into the supplied community text channel and return frozen source and webhook IDs
client.channels .get - Look up a community channel in the enabled cache, without an HTTP request or a connection
client.channels .remove Permission Overwrite - Remove one explicit permission overwrite by decimal role or member target ID
client.channels .reorder - Submit community-channel moves, succeeding with no value after HTTP
204 client.channels .set Permission Overwrite - Replace one explicit role or member permission overwrite
client.directMessages #
client.direct Messages .close - Close a one-to-one conversation for this bot, or leave a group conversation
client.direct Messages .edit Group - Change supplied settings of an existing group conversation
client.direct Messages .fetch - Fetch a private channel by decimal ID
client.direct Messages .fetch All - Fetch this bot's currently open one-to-one and group conversations
client.direct Messages .fetch Latest Messages - Fetch the latest messages for 1–100 selected, distinct private channel IDs through Fluxer's batch endpoint
client.direct Messages .get - Look up a private channel in the optional cache using its decimal ID, without a request
client.direct Messages .open - Open or reopen a one-to-one conversation with the selected user
client.direct Messages .remove Recipient - Remove a group recipient as owner, or remove the bot itself
client.direct Messages .send - Open or reopen a one-to-one conversation with a user, then send a message
client.discovery #
client.discovery .apply - Submit a community's application to the public directory
client.discovery .edit - Change supplied fields of a pending or approved directory application
client.discovery .fetch Categories - Fetch directory category IDs and Fluxer's category labels in provider order
client.discovery .fetch Status - Fetch a community's current directory eligibility and application state
client.discovery .search - Fetch one page from the current public community directory
client.discovery .withdraw - Withdraw a pending application or remove an approved directory listing
client.emojis #
client.emojis .clone - Copy an emoji into a community by its source ID, using Fluxer's server-side copy
client.emojis .create - Upload one community emoji and return its metadata
client.emojis .create Many - Upload 1–50 community emojis in one batch and return separate successes and failures
client.emojis .delete - Remove an emoji, succeeding with no value after HTTP
204 client.emojis .edit - Rename a community emoji without changing its image or fetching its old metadata first
client.emojis .fetch All - Fetch a community's emoji list in Fluxer's order, without pagination
client.emojis .fetch Metadata - Fetch minimal emoji metadata by decimal ID, without requiring source-community membership
client.emojis .fetch Source - Fetch the public presentation of the community that owns a custom emoji with this decimal ID: Its ID, name, icon hash and badges
client.emojis .get - Look up cached emoji metadata using decimal
guildand id, without an HTTP requestId
client.gateway #
client.gateway .send - Send one command frame { op, d } on a Connected local shard
client.guilds #
client.guilds .delete Own Messages - Irreversibly delete this bot's entire authored message history across one community
client.guilds .edit - Change only supplied community settings that a bot may edit
client.guilds .edit Vanity Url - Set a community's custom invite code, replace it, or pass null to remove it
client.guilds .fetch - Fetch a community's identity and settings by decimal ID
client.guilds .fetch Counts - Request fresh, visibility-filtered counts for 1–100 communities over the connected gateway
client.guilds .fetch Page - Fetch one page of communities this bot belongs to, ordered by ascending guild ID
client.guilds .fetch Vanity Url - Fetch a community's custom invite code, URL and use count with ManageGuild permission
client.guilds .get - Look up a community in the enabled guild cache, without a request or gateway connection
client.guilds .iterate - Read the bot's community memberships in ascending ID order, retaining one page and never prefetching
client.guilds .leave - Remove this bot from one community while preserving its authored messages
client.instance #
client.instance .resolve - Resolve this client's instance endpoints and its pure link and asset URL helpers
client.invites #
client.invites .create - Create an invite for an accessible channel, including an existing group direct message
client.invites .delete - Revoke an invite code, succeeding with no value after HTTP
204 client.invites .fetch - Look up an invite code without using it or joining its destination
client.invites .fetch For Channel - List a channel's management-visible invites in Fluxer's order
client.invites .fetch For Guild - List a community's management-visible invites with ManageGuild permission
client.logging #
client.logging .configure - Replace the client's log level and per-category levels, and optionally its Debug categories, effective for the next record
client.members #
client.members .add Role - Grant one role to a member without replacing their other roles
client.members .ban - Ban a user from a community, including a user who is not currently a member
client.members .clear Timeout - Clear a member's timeout and return the HTTP member snapshot
client.members .disconnect - Disconnect one observed voice connection, or all active connections if
targetis omitted.connection Id client.members .edit Self - Change this bot's community profile, not its global account or another member
client.members .fetch - Fetch one community member by decimal
guildandId userId client.members .fetch Bans - Fetch a community's current full ban list with BanMembers permission
client.members .fetch Can Manage - Check whether the bot, or the member named by
options, is above a target member in the community's role hierarchy.actor User Id client.members .fetch Page - Fetch one page of members ordered by ascending user ID
client.members .fetch Self - Fetch this bot's membership in a community without knowing its user ID
client.members .get - Look up a community member by decimal
guildandId userin the enabled cache, without a requestId client.members .get Self - Look up this bot's own membership of a community by decimal
guildin the enabled member cache, without a requestId client.members .iterate - Read community members by ascending user ID, without connecting the gateway or downloading the community eagerly
client.members .iterate Chunks - Request one community's members over the gateway and deliver frozen batches without accumulating a roster
client.members .iterate Search - Read unique indexed member-search hits with a bounded scan
client.members .kick - Remove a member from the community, succeeding with no value after HTTP
204 client.members .move - Move a member who is already in voice to a positive decimal voice-channel ID
client.members .remove Role - Remove one role from a member while leaving other roles unchanged
client.members .search - Search Fluxer's member index for a community, without using or populating the member cache
client.members .set Deaf - Set or clear the community deafen flag for a member currently connected to voice
client.members .set Mute - Set or clear the community mute flag for a member currently connected to voice
client.members .set Nickname - Set one member's nickname, or pass null to clear it
client.members .set Roles - Replace one member's entire assigned role list in a single PATCH request
client.members .timeout - Temporarily restrict a community member for
durationmillisecondsMs client.members .timeout State - Report whether a member is timed out, from the member's
communicationand a moment in timeDisabled Until client.members .unban - Remove a user's community ban, succeeding with no value after HTTP
204
client.messages #
client.messages .add Reaction - Add the bot's own reaction to a message
client.messages .cleanup - Delete the exact IDs in a plan returned by
preview, in sequential batches of at most 100Cleanup client.messages .clear Reaction - Remove all users' reactions for one emoji on the message
client.messages .clear Reactions - Remove all users' reactions for all emoji on the message, without deleting the message
client.messages .collect - Collect a bounded set of future
messageevents from one channelCreate client.messages .collect Reactions - Collect future reaction additions for one message
client.messages .delete - Delete one message, succeeding with no value after HTTP
204 client.messages .delete Attachment - Delete one attachment by its decimal ID from a message authored by this bot
client.messages .delete Many - Delete 1–100 distinct decimal message IDs from one community channel
client.messages .delete Own Messages - Irreversibly delete this bot's entire authored message history in one channel and in every thread under it, active or archived
client.messages .edit - Change a message's supplied fields and return its frozen updated snapshot after HTTP, without waiting for a gateway event
client.messages .fetch - Fetch one message from Fluxer, rather than reading the cache
client.messages .fetch Crosspost Source - Fetch frozen public source-community metadata for a published copy or a ChannelFollowAdd notice
client.messages .fetch Has Reaction - Check whether one user currently has a given reaction on a message, with one request and no cache
client.messages .fetch History - Fetch one page of channel messages from Fluxer, newest first
client.messages .fetch Pins - Fetch one frozen page of pinned messages in descending pin-time order
client.messages .fetch Reaction Users - Fetch one page of users who currently have a selected reaction on the message
client.messages .forward - Copy an accessible source message into the destination channel and return the new message
client.messages .get - Look up a message in this client's cache, without an HTTP request
client.messages .iterate History - Read older messages newest first, without connecting the gateway
client.messages .iterate Pins - Read pinned messages newest pin first, without adding message cache entries
client.messages .iterate Reaction Users - Read users who reacted with one selected emoji, in ascending user-ID order
client.messages .iterate Search - Read indexed search hits from the supplied community or channel context, following numbered pages without polling, prefetching or cache population
client.messages .keep Typing - Keep the bot's typing indicator active while a task runs, returning the task's value
client.messages .paginate - Show several pages in one message that people flip with ◀ and ▶ reactions, because Fluxer has no buttons
client.messages .pin - Pin a message using its decimal id and
channelId client.messages .preview Cleanup - Preview a bounded message-deletion selection without deleting anything
client.messages .publish - Publish an ordinary source message from an announcement channel and return its frozen updated snapshot
client.messages .remove Reaction - Remove only the bot's own reaction for the selected emoji
client.messages .remove User Reaction - Remove one user's reaction for one emoji, leaving other users and emoji groups unchanged
client.messages .reply - Send a reply that references an existing message and return the new reply
client.messages .search - Search messages in one explicit community or channel and return one page from Fluxer's search index
client.messages .send - Send text, embeds, files or stickers to a channel and return the created message
client.messages .typing - Show this bot's temporary typing indicator in a channel
client.messages .unpin - Remove a pin without deleting the message or its pin-created system message
client.permissions #
client.permissions .calculate - Calculate permission flags from supplied guild, member, role and optional channel data
client.permissions .fetch - Fetch guild, member, role and optional channel data, then calculate their permission flags
client.permissions .fetch Channels - Fetch one member's permission flags in every channel of a community, such as to see what the bot can do in each channel
client.presence #
client.presence .set - Set the bot's requested status and optional custom status, including before connecting
client.presence .set Members - Request presence updates for selected members in one community
client.rest #
client.rest .request - Send one request to a route under /v1 and resolve with its status, lower-case headers and parsed JSON body
client.roles #
client.roles .create - Create a role with a name, optional color and permission flags
client.roles .delete - Delete a role and remove its member assignments in Fluxer
client.roles .edit - Change only supplied role fields and return the server's snapshot
client.roles .fetch All - Fetch the community's current role list, including everyone, in server order
client.roles .get - Look up a role by decimal
guildand id in the enabled cache, including the everyone roleId client.roles .get All - Look up every role of a community by decimal
guildin the enabled cache, including the everyone roleId client.roles .reorder - Change role hierarchy positions using distinct role IDs and nonnegative safe-integer positions
client.roles .reset Hoist Positions - Clear display-position assignments across the community, including roles above the bot
client.roles .set Hoist Positions - Set roles' display positions without changing their permission hierarchy or enabling hoist
client.stickers #
client.stickers .clone - Copy a sticker into a community by its source ID, using Fluxer's server-side copy
client.stickers .create - Upload one community sticker and return its metadata
client.stickers .create Many - Upload 1–50 community stickers in one batch and return separate successes and failures
client.stickers .delete - Remove a sticker, succeeding with no value after HTTP
204 client.stickers .edit - Replace a sticker's name, description and tags without changing its image or fetching it first
client.stickers .fetch All - Fetch a community's sticker list in Fluxer's order, without pagination
client.stickers .fetch Metadata - Fetch minimal sticker metadata by decimal ID, without requiring source-community membership
client.stickers .fetch Source - Fetch the public presentation of the community that owns a custom sticker with this decimal ID: Its ID, name, icon hash and badges
client.stickers .get - Look up cached sticker metadata using decimal
guildand id, without an HTTP requestId
client.threads #
client.threads .add Member - Add a community member who can view the parent channel to a thread, succeeding with no value after HTTP
204 client.threads .create - Create a thread that is not attached to a message in a text or announcement channel, and return its frozen snapshot
client.threads .create From Message - Start a public thread on an existing message and return its frozen snapshot
client.threads .create Post - Create a post in a forum or media channel, a public thread with its first message, and return both frozen
client.threads .edit - Change only the supplied thread settings and return the frozen thread
client.threads .fetch Active - Fetch every active thread the bot can view in a community, newest first, as one frozen list
client.threads .fetch Archived - Fetch one frozen page of archived threads of a text, announcement, forum or media channel, as
ArchivedselectsThread Query client.threads .fetch Member - Fetch one thread member as a frozen
ThreadMember client.threads .fetch Members - Fetch one page of thread members in ascending user ID order, as frozen
ThreadvaluesMember client.threads .iterate Members - Read thread members in ascending user ID order, buffering one page and never prefetching
client.threads .join - Add the bot to a thread, succeeding with no value after HTTP
204 client.threads .leave - Remove the bot from a thread, succeeding with no value after HTTP
204 client.threads .remove Member - Remove a member from a thread, succeeding with no value after HTTP
204, and Fluxer posts a RecipientRemove notice in the thread client.threads .search - Search the threads of a text, announcement, forum or media channel by name, tags and state, and return one frozen page
client.users #
client.users .fetch - Fetch a public account snapshot by decimal user ID
client.users .fetch Profile - Fetch a user's privacy-filtered profile, optionally for the community specified in
query.guild Id client.users .fetch Self - Fetch the authenticated bot's public account data remotely
client.users .get - Look up a public account in the optional cache using its decimal ID, without a request
client.users .get Self - Look up the bot's own public account as the gateway's READY reported it, without a request
client.webhooks #
client.webhooks .create - Create an incoming webhook in a text, voice or announcement channel using the bot's permissions
client.webhooks .delete - Delete an incoming webhook and revoke its credential, or delete a follower webhook to unfollow its source
client.webhooks .edit - Change the supplied incoming or follower webhook settings, including its destination channel
client.webhooks .fetch - Fetch incoming, follower or unknown-kind metadata by decimal ID, discarding any returned token
client.webhooks .fetch For Channel - List the channel's accessible incoming, follower and unknown-kind webhook metadata without pagination
client.webhooks .fetch For Guild - List the community's accessible incoming, follower and unknown-kind webhook metadata