Preparing search index...
The search index is not available
stoat.js - v
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
stoat.js
Hierarchy Summary
ChannelInvite
UnknownInvite
ServerInvite
Collection
StoreCollection
ClassCollection
BotCollection
ChannelCollection
ChannelUnreadCollection
ChannelWebhookCollection
EmojiCollection
MessageCollection
ServerCollection
ServerMemberCollection
SessionCollection
UserCollection
MessageEmbed
UnknownEmbed
ImageEmbed
VideoEmbed
WebsiteEmbed
TextEmbed
PublicChannelInvite
UnknownPublicInvite
ServerPublicInvite
SystemMessage
TextSystemMessage
UserSystemMessage
UserModeratedSystemMessage
ChannelEditSystemMessage
ChannelRenamedSystemMessage
ChannelOwnershipChangeSystemMessage
MessagePinnedSystemMessage
CallStartedSystemMessage
stoat.js
API
API
API Client
Options
Client configuration options
Request
Options
Request options
Account
Info
All
Member
Response
APIRoutes
Audit
Log
Entry
Audit
Log
Entry
Action
Audit
Log
Query
Response
Bandcamp
Type
Ban
List
Result
Banned
User
Bot
Bot
Information
Bot
With
User
Response
Build
Information
Bulk
Message
Response
Captcha
Feature
Category
Channel
Channel
Composite
Key
Channel
Unread
Content
Report
Reason
Create
Server
Legacy
Response
Create
Voice
User
Response
Create
Webhook
Body
Data
Account
Deletion
Data
Ban
Create
Data
Change
Email
Data
Change
Password
Data
Change
Username
Data
Create
Account
Data
Create
Bot
Data
Create
Emoji
Data
Create
Group
Data
Create
Role
Data
Create
Server
Data
Create
Server
Channel
Data
Default
Channel
Permissions
Data
Edit
Bot
Data
Edit
Channel
Data
Edit
Emoji
Data
Edit
Message
Data
Edit
Role
Data
Edit
Role
Ranks
Data
Edit
Server
Data
Edit
Session
Data
Edit
User
Data
Edit
Webhook
Data
Hello
Data
Join
Call
Data
Login
Data
Member
Edit
Data
Message
Search
Data
Message
Send
Data
Onboard
Data
Password
Reset
Data
Permissions
Value
Data
Report
Content
Data
Resend
Verification
Data
Send
Friend
Request
Data
Send
Password
Reset
Data
Set
Role
Permissions
Data
Set
Server
Role
Permission
Data
User
Profile
Embed
Emoji
Emoji
Parent
Error
Feature
Fetch
Bot
Response
Fetch
Server
Response
Fields
Bot
Fields
Channel
Fields
Member
Fields
Role
Fields
Server
Fields
User
Fields
Webhook
File
Flag
Response
Global
Limits
Id
Image
Image
Size
Interactions
Invite
Invite
Bot
Destination
Invite
Join
Response
Invite
Response
ISO8601_
Timestamp
Legacy
Server
Channel
Type
Legal
Links
Lightspeed
Type
Limits
Config
Masquerade
Member
Member
Composite
Key
Member
Query
Response
Member
Response
Message
Message
Sort
Message
Webhook
Metadata
MFAMethod
MFAResponse
MFATicket
Multi
Factor
Status
Mutual
Response
New
Role
Response
Options
Bulk
Delete
Options
Fetch
Settings
Override
Override
Field
Owned
Bots
Response
Partial
Channel
Partial
Emoji
Partial
Member
Partial
Role
Partial
Server
Presence
Public
Bot
Relationship
Relationship
Status
Reply
Intent
Reported
Content
Response
Login
Response
Totp
Secret
Response
Verify
Response
Webhook
Revolt
Config
Revolt
Features
Role
Sendable
Embed
Server
Server
Ban
Session
Info
Special
System
Message
System
Message
Channels
Twitch
Type
User
User
Limits
User
Profile
User
Report
Reason
User
Status
Video
Voice
Feature
Voice
Information
Voice
Node
Webhook
Web
Push
Subscription
get
Path
Name
Get the specific path name of any given path.
Bot
Flags
Flags attributed to users
Connection
State
All possible event client states.
Server
Flags
Flags attributed to servers
User
Badges
Badges available to users
User
Flags
Flags attributed to users
Banned
User
Banned User
Bot
Bot Class
Bot
Collection
Collection of Bots
Call
Started
System
Message
Call Started System Message
Channel
Channel Class
Channel
Collection
Collection of Channels
Channel
Edit
System
Message
Channel Edit System Message
Channel
Invite
Channel Invite
Channel
Ownership
Change
System
Message
Channel Ownership Change System Message
Channel
Renamed
System
Message
Channel Renamed System Message
Channel
Unread
Channel Unread Class
Channel
Unread
Collection
Collection of Channel Unreads
Channel
Webhook
Channel Webhook Class
Channel
Webhook
Collection
Collection of Channel Webhooks
Class
Collection
Generic class collection backed by store
Client
Stoat.js Clients
Collection
Abstract Collection type
Emoji
Emoji Class
Emoji
Collection
Collection of Emoji
Event
Client
Simple wrapper around the Revolt websocket service.
File
Uploaded File
Image
Embed
Image Embed
Message
Message Class
Message
Collection
Collection of Messages
Message
Embed
Message Embed
Message
Pinned
System
Message
Message Pinned System Message
Message
Webhook
Message Webhook Class
MFA
Multi-Factor Authentication
MFATicket
MFA Ticket
Public
Bot
Public Bot Class
Public
Channel
Invite
Public Channel Invite
Server
Server Class
Server
Ban
Server Ban
Server
Collection
Collection of Servers
Server
Invite
Server Invite
Server
Member
Server Member Class
Server
Member
Collection
Collection of Server Members
Server
Public
Invite
Public Server Invite
Server
Role
Server Role
Session
Session Class
Session
Collection
Collection of Sessions
Store
Collection
Collection backed by a Solid.js Store
System
Message
System Message
Text
Embed
Text Embed
Text
System
Message
Text System Message
Unknown
Embed
Embed of unknown type
Unknown
Invite
Invite of unknown type
Unknown
Public
Invite
Public invite of unknown type
User
User Class
User
Collection
Collection of Users
User
Moderated
System
Message
User Moderated System Message
User
Profile
User Profile Class
User
System
Message
User System Message
Video
Embed
Video Embed
Voice
Participant
Voice Participant
Website
Embed
Website Embed
Client
Options
Client options object
Private
Session
Protocol
V1
Version 1 of the events protocol
User
Limits
Voice
Status
The voice status of an entity. Screenshare supersedes video, video supersedes voice, and voice supersedes none.
ALLOW_
IN_
TIMEOUT
Permissions allowed for a user while in timeout
DEFAULT_
PERMISSION
Default base permissions for channels
DEFAULT_
PERMISSION_
DIRECT_
MESSAGE
Permissions in direct message channels / default permissions for group DMs
DEFAULT_
PERMISSION_
SAVED_
MESSAGES
Permissions in saved messages channel
DEFAULT_
PERMISSION_
SERVER
Permissions in server text / voice channel
DEFAULT_
PERMISSION_
VIEW_
ONLY
Default permissions if we can only view
Permission
Permission against Server / Channel
RE_
CHANNELS
Regular expression for channels.
RE_
CUSTOM_
EMOJI
Regular expression for stripping custom emojis.
RE_
MENTIONS
Regular expression for mentions.
RE_
SPOILER
Regular expression for spoilers.
U32_
MAX
Maximum safe value
User
Permission
Permission against User