{"meta":{"generator":"0.4.0","format":17,"date":1480006798297},"classes":[{"name":"Client","description":"The starting point for making a Discord Bot.","extends":["EventEmitter"],"construct":{"name":"Client","params":[{"name":"options","description":"Options for the client","optional":true,"type":[[["ClientOptions"]]]}]},"props":[{"name":"rest","description":"The REST manager of the client","access":"private","type":[[["RESTManager"]]],"meta":{"line":29,"file":"Client.js","path":"src/client"}},{"name":"dataManager","description":"The data manager of the Client","access":"private","type":[[["ClientDataManager"]]],"meta":{"line":35,"file":"Client.js","path":"src/client"}},{"name":"manager","description":"The manager of the Client","access":"private","type":[[["ClientManager"]]],"meta":{"line":41,"file":"Client.js","path":"src/client"}},{"name":"ws","description":"The WebSocket Manager of the Client","access":"private","type":[[["WebSocketManager"]]],"meta":{"line":47,"file":"Client.js","path":"src/client"}},{"name":"resolver","description":"The Data Resolver of the Client","access":"private","type":[[["ClientDataResolver"]]],"meta":{"line":53,"file":"Client.js","path":"src/client"}},{"name":"actions","description":"The Action Manager of the Client","access":"private","type":[[["ActionsManager"]]],"meta":{"line":59,"file":"Client.js","path":"src/client"}},{"name":"voice","description":"The Voice Manager of the Client","access":"private","type":[[["ClientVoiceManager"]]],"meta":{"line":65,"file":"Client.js","path":"src/client"}},{"name":"users","description":"A Collection of the Client's stored users","type":[[["Collection",".<"],["string",", "],["User",">"]]],"meta":{"line":70,"file":"Client.js","path":"src/client"}},{"name":"guilds","description":"A Collection of the Client's stored guilds","type":[[["Collection",".<"],["string",", "],["Guild",">"]]],"meta":{"line":75,"file":"Client.js","path":"src/client"}},{"name":"channels","description":"A Collection of the Client's stored channels","type":[[["Collection",".<"],["string",", "],["Channel",">"]]],"meta":{"line":80,"file":"Client.js","path":"src/client"}},{"name":"token","description":"The authorization token for the logged in user/bot.","nullable":true,"type":[[["string"]]],"meta":{"line":85,"file":"Client.js","path":"src/client"}},{"name":"user","description":"The ClientUser representing the logged in Client","nullable":true,"type":[[["ClientUser"]]],"meta":{"line":90,"file":"Client.js","path":"src/client"}},{"name":"email","description":"The email, if there is one, for the logged in Client","nullable":true,"type":[[["string"]]],"meta":{"line":95,"file":"Client.js","path":"src/client"}},{"name":"password","description":"The password, if there is one, for the logged in Client","nullable":true,"type":[[["string"]]],"meta":{"line":100,"file":"Client.js","path":"src/client"}},{"name":"readyTime","description":"The date at which the Client was regarded as being in the `READY` state.","nullable":true,"type":[[["Date"]]],"meta":{"line":105,"file":"Client.js","path":"src/client"}},{"name":"voiceConnections","description":"Returns a Collection, mapping Guild ID to Voice Connections.","readonly":true,"type":[[["Collection",".<"],["string",", "],["VoiceConnection",">"]]],"meta":{"line":199,"file":"Client.js","path":"src/client"}},{"name":"uptime","description":"The uptime for the logged in Client.","readonly":true,"nullable":true,"type":[[["number"]]],"meta":{"line":208,"file":"Client.js","path":"src/client"}},{"name":"emojis","description":"The emojis that the client can use. Mapped by emoji ID.","readonly":true,"type":[[["Collection",".<"],["string",", "],["Emoji",">"]]],"meta":{"line":217,"file":"Client.js","path":"src/client"}},{"name":"status","description":"The status for the logged in Client.","readonly":true,"nullable":true,"type":[[["number"]]],"meta":{"line":228,"file":"Client.js","path":"src/client"}}],"methods":[{"name":"login","description":"Logs the client in. If successful, resolves with the account's token. <warn>If you're making a bot, it's\rmuch better to use a bot account rather than a user account.\rBot accounts have higher rate limits and have access to some features user accounts don't have. User bots\rthat are making a lot of API requests can even be banned.</warn>","examples":["// log the client in using a token\rconst token = 'my token';\rclient.login(token);","// log the client in using email and password\rconst email = 'user@email.com';\rconst password = 'supersecret123';\rclient.login(email, password);"],"params":[{"name":"tokenOrEmail","description":"The token or email used for the account. If it is an email, a password _must_ be\rprovided.","type":[[["string"]]]},{"name":"password","description":"The password for the account, only needed if an email was provided.","optional":true,"default":null,"type":[[["string"]]]}],"returns":[[["Promise",".<"],["string",">"]]],"meta":{"line":129,"file":"Client.js","path":"src/client"}},{"name":"destroy","description":"Destroys the client and logs out.","returns":[[["Promise"]]],"meta":{"line":138,"file":"Client.js","path":"src/client"}},{"name":"syncGuilds","description":"This shouldn't really be necessary to most developers as it is automatically invoked every 30 seconds, however\rif you wish to force a sync of Guild data, you can use this. Only applicable to user accounts.","params":[{"name":"guilds","description":"An array of guilds to sync","optional":true,"default":"this.guilds.array()","type":[[["Array",".<"],["Guild",">"]]]}],"meta":{"line":174,"file":"Client.js","path":"src/client"}},{"name":"fetchUser","description":"Caches a user, or obtains it from the cache if it's already cached.\rIf the user isn't already cached, it will only be obtainable by OAuth bot accounts.","params":[{"name":"id","description":"The ID of the user to obtain","type":[[["string"]]]}],"returns":[[["Promise",".<"],["User",">"]]],"meta":{"line":189,"file":"Client.js","path":"src/client"}}],"events":[{"name":"channelUpdate","description":"Emitted whenever a channel is updated - e.g. name change, topic change.","params":[{"name":"oldChannel","description":"The channel before the update","type":[[["Channel"]]]},{"name":"newChannel","description":"The channel after the update","type":[[["Channel"]]]}],"meta":{"line":27,"file":"ChannelUpdate.js","path":"src/client/actions"}},{"name":"guildUnavailable","description":"Emitted whenever a guild becomes unavailable, likely due to a server outage.","params":[{"name":"guild","description":"The guild that has become unavailable.","type":[[["Guild"]]]}],"meta":{"line":45,"file":"GuildDelete.js","path":"src/client/actions"}},{"name":"guildMemberRemove","description":"Emitted whenever a member leaves a guild, or is kicked.","params":[{"name":"guild","description":"The guild that the member has left.","type":[[["Guild"]]]},{"name":"member","description":"The member that has left the guild.","type":[[["GuildMember"]]]}],"meta":{"line":43,"file":"GuildMemberRemove.js","path":"src/client/actions"}},{"name":"guildRoleCreate","description":"Emitted whenever a guild role is created.","params":[{"name":"guild","description":"The guild that the role was created in.","type":[[["Guild"]]]},{"name":"role","description":"The role that was created.","type":[[["Role"]]]}],"meta":{"line":26,"file":"GuildRoleCreate.js","path":"src/client/actions"}},{"name":"guildRoleDelete","description":"Emitted whenever a guild role is deleted.","params":[{"name":"guild","description":"The guild that the role was deleted in.","type":[[["Guild"]]]},{"name":"role","description":"The role that was deleted.","type":[[["Role"]]]}],"meta":{"line":40,"file":"GuildRoleDelete.js","path":"src/client/actions"}},{"name":"guildRoleUpdated","description":"Emitted whenever a guild role is updated.","params":[{"name":"guild","description":"The guild that the role was updated in.","type":[[["Guild"]]]},{"name":"oldRole","description":"The role before the update.","type":[[["Role"]]]},{"name":"newRole","description":"The role after the update.","type":[[["Role"]]]}],"meta":{"line":34,"file":"GuildRoleUpdate.js","path":"src/client/actions"}},{"name":"guildUpdate","description":"Emitted whenever a guild is updated - e.g. name change.","params":[{"name":"oldGuild","description":"The guild before the update.","type":[[["Guild"]]]},{"name":"newGuild","description":"The guild after the update.","type":[[["Guild"]]]}],"meta":{"line":27,"file":"GuildUpdate.js","path":"src/client/actions"}},{"name":"messageUpdate","description":"Emitted whenever a message is updated - e.g. embed or content change.","params":[{"name":"oldMessage","description":"The message before the update.","type":[[["Message"]]]},{"name":"newMessage","description":"The message after the update.","type":[[["Message"]]]}],"meta":{"line":36,"file":"MessageUpdate.js","path":"src/client/actions"}},{"name":"userUpdate","description":"Emitted whenever a detail of the logged in User changes - e.g. username.","params":[{"name":"oldClientUser","description":"The client user before the update.","type":[[["ClientUser"]]]},{"name":"newClientUser","description":"The client user after the update.","type":[[["ClientUser"]]]}],"meta":{"line":33,"file":"UserUpdate.js","path":"src/client/actions"}},{"name":"guildCreate","description":"Emitted whenever the client joins a Guild.","params":[{"name":"guild","description":"The created guild","type":[[["Guild"]]]}],"meta":{"line":25,"file":"ClientDataManager.js","path":"src/client"}},{"name":"channelCreate","description":"Emitted whenever a Channel is created.","params":[{"name":"channel","description":"The channel that was created","type":[[["Channel"]]]}],"meta":{"line":14,"file":"ChannelCreate.js","path":"src/client/websocket/packets/handlers"}},{"name":"channelDelete","description":"Emitted whenever a Channel is deleted.","params":[{"name":"channel","description":"The channel that was deleted","type":[[["Channel"]]]}],"meta":{"line":14,"file":"ChannelDelete.js","path":"src/client/websocket/packets/handlers"}},{"name":"channelPinsUpdate","description":"Emitted whenever the pins of a Channel are updated. Due to the nature of the WebSocket event, not much information\rcan be provided easily here - you need to manually check the pins yourself.","params":[{"name":"channel","description":"The channel that the pins update occured in","type":[[["Channel"]]]},{"name":"time","description":"The time of the pins update","type":[[["Date"]]]}],"meta":{"line":23,"file":"ChannelPinsUpdate.js","path":"src/client/websocket/packets/handlers"}},{"name":"guildBanAdd","description":"Emitted whenever a member is banned from a guild.","params":[{"name":"guild","description":"The guild that the ban occurred in","type":[[["Guild"]]]},{"name":"user","description":"The user that was banned","type":[[["User"]]]}],"meta":{"line":16,"file":"GuildBanAdd.js","path":"src/client/websocket/packets/handlers"}},{"name":"guildBanRemove","description":"Emitted whenever a member is unbanned from a guild.","params":[{"name":"guild","description":"The guild that the unban occurred in","type":[[["Guild"]]]},{"name":"user","description":"The user that was unbanned","type":[[["User"]]]}],"meta":{"line":13,"file":"GuildBanRemove.js","path":"src/client/websocket/packets/handlers"}},{"name":"guildDelete","description":"Emitted whenever a Guild is deleted/left.","params":[{"name":"guild","description":"The guild that was deleted","type":[[["Guild"]]]}],"meta":{"line":13,"file":"GuildDelete.js","path":"src/client/websocket/packets/handlers"}},{"name":"guildMembersChunk","description":"Emitted whenever a chunk of Guild members is received","params":[{"name":"guild","description":"The guild that the chunks relate to","type":[[["Guild"]]]},{"name":"members","description":"The members in the chunk","type":[[["Array",".<"],["GuildMember",">"]]]}],"meta":{"line":22,"file":"GuildMembersChunk.js","path":"src/client/websocket/packets/handlers"}},{"name":"message","description":"Emitted whenever a message is created","params":[{"name":"message","description":"The created message","type":[[["Message"]]]}],"meta":{"line":13,"file":"MessageCreate.js","path":"src/client/websocket/packets/handlers"}},{"name":"messageDelete","description":"Emitted whenever a message is deleted","params":[{"name":"message","description":"The deleted message","type":[[["Message"]]]}],"meta":{"line":13,"file":"MessageDelete.js","path":"src/client/websocket/packets/handlers"}},{"name":"messageDeleteBulk","description":"Emitted whenever messages are deleted in bulk","params":[{"name":"messages","description":"The deleted messages, mapped by their ID","type":[[["Collection",".<"],["string",", "],["Message",">"]]]}],"meta":{"line":11,"file":"MessageDeleteBulk.js","path":"src/client/websocket/packets/handlers"}},{"name":"presenceUpdate","description":"Emitted whenever a user changes one of their details or starts/stop playing a game","params":[{"name":"oldUser","description":"The user before the presence update","type":[[["User"]]]},{"name":"newUser","description":"The user after the presence update","type":[[["User"]]]}],"meta":{"line":57,"file":"PresenceUpdate.js","path":"src/client/websocket/packets/handlers"}},{"name":"guildMemberAvailable","description":"Emitted whenever a member becomes available in a large Guild","params":[{"name":"guild","description":"The guild that the member became available in","type":[[["Guild"]]]},{"name":"member","description":"The member that became available","type":[[["GuildMember"]]]}],"meta":{"line":64,"file":"PresenceUpdate.js","path":"src/client/websocket/packets/handlers"}},{"name":"typingStart","description":"Emitted whenever a user starts typing in a channel","params":[{"name":"channel","description":"The channel the user started typing in","type":[[["Channel"]]]},{"name":"user","description":"The user that started typing","type":[[["User"]]]}],"meta":{"line":49,"file":"TypingStart.js","path":"src/client/websocket/packets/handlers"}},{"name":"typingStop","description":"Emitted whenever a user stops typing in a channel","params":[{"name":"channel","description":"The channel the user stopped typing in","type":[[["Channel"]]]},{"name":"user","description":"The user that stopped typing","type":[[["User"]]]}],"meta":{"line":56,"file":"TypingStart.js","path":"src/client/websocket/packets/handlers"}},{"name":"voiceStateUpdate","description":"Emitted whenever a user changes voice state - e.g. joins/leaves a channel, mutes/unmutes.","params":[{"name":"oldMember","description":"The member before the voice state update","type":[[["GuildMember"]]]},{"name":"newMember","description":"The member after the voice state update","type":[[["GuildMember"]]]}],"meta":{"line":42,"file":"VoiceStateUpdate.js","path":"src/client/websocket/packets/handlers"}},{"name":"error","description":"Emitted whenever the Client encounters a serious connection error","params":[{"name":"error","description":"The encountered error","type":[[["Error"]]]}],"meta":{"line":190,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"ready","description":"Emitted when the Client becomes ready to start working","meta":{"line":202,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"reconnecting","description":"Emitted when the Client tries to reconnect after being disconnected","meta":{"line":244,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"guildMemberAdd","description":"Emitted whenever a user joins a guild.","params":[{"name":"guild","description":"The guild that the user has joined","type":[[["Guild"]]]},{"name":"member","description":"The member that has joined","type":[[["GuildMember"]]]}],"meta":{"line":598,"file":"Guild.js","path":"src/structures"}},{"name":"guildMemberUpdate","description":"Emitted whenever a Guild Member changes - i.e. new role, removed role, nickname","params":[{"name":"guild","description":"The guild that the update affects","type":[[["Guild"]]]},{"name":"oldMember","description":"The member before the update","type":[[["GuildMember"]]]},{"name":"newMember","description":"The member after the update","type":[[["GuildMember"]]]}],"meta":{"line":621,"file":"Guild.js","path":"src/structures"}},{"name":"guildMemberSpeaking","description":"Emitted once a Guild Member starts/stops speaking","params":[{"name":"member","description":"The member that started/stopped speaking","type":[[["GuildMember"]]]},{"name":"speaking","description":"Whether or not the member is speaking","type":[[["boolean"]]]}],"meta":{"line":646,"file":"Guild.js","path":"src/structures"}}],"meta":{"line":17,"file":"Client.js","path":"src/client"}},{"name":"ClientDataResolver","description":"The DataResolver identifies different objects and tries to resolve a specific piece of information from them, e.g.\rextracting a User from a Message object.","access":"private","construct":{"name":"ClientDataResolver","params":[{"name":"client","description":"The client the resolver is for","type":[[["Client"]]]}]},"methods":[{"name":"resolveUser","description":"Resolves a UserResolvable to a User object","params":[{"name":"user","description":"The UserResolvable to identify","type":[[["UserResolvable"]]]}],"returns":{"types":[[["User"]]],"nullable":true},"meta":{"line":40,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"resolveGuild","description":"Resolves a GuildResolvable to a Guild object","params":[{"name":"guild","description":"The GuildResolvable to identify","type":[[["GuildResolvable"]]]}],"returns":{"types":[[["Guild"]]],"nullable":true},"meta":{"line":67,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"resolveGuildMember","description":"Resolves a GuildMemberResolvable to a GuildMember object","params":[{"name":"guild","description":"The guild that the member is part of","type":[[["GuildResolvable"]]]},{"name":"user","description":"The user that is part of the guild","type":[[["UserResolvable"]]]}],"returns":{"types":[[["GuildMember"]]],"nullable":true},"meta":{"line":86,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"resolveBase64","description":"Resolves a Base64Resolvable to a Base 64 image","params":[{"name":"data","description":"The base 64 resolvable you want to resolve","type":[[["Base64Resolvable"]]]}],"returns":{"types":[[["string"]]],"nullable":true},"meta":{"line":108,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"resolveChannel","description":"Resolves a ChannelResolvable to a Channel object","params":[{"name":"channel","description":"The channel resolvable to resolve","type":[[["ChannelResolvable"]]]}],"returns":{"types":[[["Channel"]]],"nullable":true},"meta":{"line":125,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"resolvePermission","description":"Resolves a PermissionResolvable to a permission number","params":[{"name":"permission","description":"The permission resolvable to resolve","type":[[["PermissionResolvable"]]]}],"returns":[[["number"]]],"meta":{"line":143,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"resolveString","description":"Resolves a StringResolvable to a string","params":[{"name":"data","description":"The string resolvable to resolve","type":[[["StringResolvable"]]]}],"returns":[[["string"]]],"meta":{"line":162,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"resolveFile","description":"Resolves a FileResolvable to a Buffer","params":[{"name":"resource","description":"The file resolvable to resolve","type":[[["FileResolvable"]]]}],"returns":[[["Promise",".<"],["Buffer",">"]]],"meta":{"line":181,"file":"ClientDataResolver.js","path":"src/client"}}],"meta":{"line":17,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"ClientManager","description":"Manages the State and Background Tasks of the Client","access":"private","props":[{"name":"client","description":"The Client that instantiated this Manager","type":[[["Client"]]],"meta":{"line":13,"file":"ClientManager.js","path":"src/client"}},{"name":"heartbeatInterval","description":"The heartbeat interval, null if not yet set","nullable":true,"type":[[["number"]]],"meta":{"line":18,"file":"ClientManager.js","path":"src/client"}}],"methods":[{"name":"connectToWebSocket","description":"Connects the Client to the WebSocket","params":[{"name":"token","description":"The authorization token","type":[[["string"]]]},{"name":"resolve","description":"Function to run when connection is successful","type":[[["function"]]]},{"name":"reject","description":"Function to run when connection fails","type":[[["function"]]]}],"meta":{"line":27,"file":"ClientManager.js","path":"src/client"}},{"name":"setupKeepAlive","description":"Sets up a keep-alive interval to keep the Client's connection valid","params":[{"name":"time","description":"The interval in milliseconds at which heartbeat packets should be sent","type":[[["number"]]]}],"meta":{"line":42,"file":"ClientManager.js","path":"src/client"}}],"meta":{"line":7,"file":"ClientManager.js","path":"src/client"}},{"name":"RequestHandler","description":"A base class for different types of rate limiting handlers for the REST API.","access":"private","construct":{"name":"RequestHandler","params":[{"name":"restManager","description":"The REST manager to use","type":[[["RESTManager"]]]}]},"props":[{"name":"restManager","description":"The RESTManager that instantiated this RequestHandler","type":[[["RESTManager"]]],"meta":{"line":14,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}},{"name":"queue","description":"A list of requests that have yet to be processed.","type":[[["Array",".<"],["APIRequest",">"]]],"meta":{"line":20,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}},{"name":"globalLimit","description":"Whether or not the client is being rate limited on every endpoint.","type":[[["boolean"]]],"meta":{"line":27,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}}],"methods":[{"name":"push","description":"Push a new API request into this bucket","params":[{"name":"request","description":"The new request to push into the queue","type":[[["APIRequest"]]]}],"meta":{"line":39,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}},{"name":"handle","description":"Attempts to get this RequestHandler to process its current queue","meta":{"line":46,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}}],"meta":{"line":5,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}},{"name":"SequentialRequestHandler","description":"Handles API Requests sequentially, i.e. we wait until the current request is finished before moving onto\rthe next. This plays a _lot_ nicer in terms of avoiding 429's when there is more than one session of the account,\rbut it can be slower.","extends":["RequestHandler"],"access":"private","construct":{"name":"SequentialRequestHandler","params":[{"name":"restManager","description":"The REST manager to use","type":[[["RESTManager"]]]},{"name":"endpoint","description":"The endpoint to handle","type":[[["string"]]]}]},"props":[{"name":"waiting","description":"Whether this rate limiter is waiting for a response from a request","type":[[["boolean"]]],"meta":{"line":22,"file":"Sequential.js","path":"src/client/rest/RequestHandlers"}},{"name":"endpoint","description":"The endpoint that this handler is handling","type":[[["string"]]],"meta":{"line":28,"file":"Sequential.js","path":"src/client/rest/RequestHandlers"}},{"name":"timeDifference","description":"The time difference between Discord's Dates and the local computer's Dates. A positive number means the local\rcomputer's time is ahead of Discord's.","type":[[["number"]]],"meta":{"line":35,"file":"Sequential.js","path":"src/client/rest/RequestHandlers"}},{"name":"restManager","description":"The RESTManager that instantiated this RequestHandler","type":[[["RESTManager"]]],"meta":{"line":14,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}},{"name":"queue","description":"A list of requests that have yet to be processed.","type":[[["Array",".<"],["APIRequest",">"]]],"meta":{"line":20,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}},{"name":"globalLimit","description":"Whether or not the client is being rate limited on every endpoint.","type":[[["boolean"]]],"meta":{"line":27,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}}],"methods":[{"name":"execute","description":"Performs a request then resolves a promise to indicate its readiness for a new request","params":[{"name":"item","description":"The item to execute","type":[[["APIRequest"]]]}],"returns":[[["Promise",".<(?"],["Object","|"],["Error",")>"]]],"meta":{"line":48,"file":"Sequential.js","path":"src/client/rest/RequestHandlers"}},{"name":"push","description":"Push a new API request into this bucket","inherits":"RequestHandler#push","inherited":true,"params":[{"name":"request","description":"The new request to push into the queue","type":[[["APIRequest"]]]}],"meta":{"line":39,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}},{"name":"handle","description":"Attempts to get this RequestHandler to process its current queue","inherits":"RequestHandler#handle","inherited":true,"meta":{"line":46,"file":"RequestHandler.js","path":"src/client/rest/RequestHandlers"}}],"meta":{"line":10,"file":"Sequential.js","path":"src/client/rest/RequestHandlers"}},{"name":"ClientVoiceManager","description":"Manages all the voice stuff for the Client","access":"private","props":[{"name":"client","description":"The client that instantiated this voice manager","type":[[["Client"]]],"meta":{"line":16,"file":"ClientVoiceManager.js","path":"src/client/voice"}},{"name":"connections","description":"A collection mapping connection IDs to the Connection objects","type":[[["Collection",".<"],["string",", "],["VoiceConnection",">"]]],"meta":{"line":21,"file":"ClientVoiceManager.js","path":"src/client/voice"}},{"name":"pending","description":"Pending connection attempts, maps Guild ID to VoiceChannel","type":[[["Collection",".<"],["string",", "],["VoiceChannel",">"]]],"meta":{"line":26,"file":"ClientVoiceManager.js","path":"src/client/voice"}}],"methods":[{"name":"_checkPendingReady","description":"Checks whether a pending request can be processed","access":"private","params":[{"name":"guildID","description":"The ID of the Guild","type":[[["string"]]]}],"meta":{"line":34,"file":"ClientVoiceManager.js","path":"src/client/voice"}},{"name":"_receivedVoiceServer","description":"Called when the Client receives information about this voice server update.","params":[{"name":"guildID","description":"The ID of the Guild","type":[[["string"]]]},{"name":"token","description":"The token to authorise with","type":[[["string"]]]},{"name":"endpoint","description":"The endpoint to connect to","type":[[["string"]]]}],"meta":{"line":54,"file":"ClientVoiceManager.js","path":"src/client/voice"}},{"name":"_receivedVoiceStateUpdate","description":"Called when the Client receives information about the voice state update.","params":[{"name":"guildID","description":"The ID of the Guild","type":[[["string"]]]},{"name":"sessionID","description":"The session id to authorise with","type":[[["string"]]]}],"meta":{"line":68,"file":"ClientVoiceManager.js","path":"src/client/voice"}},{"name":"_sendWSJoin","description":"Sends a request to the main gateway to join a voice channel","params":[{"name":"channel","description":"The channel to join","type":[[["VoiceChannel"]]]},{"name":"options","description":"The options to provide","optional":true,"type":[[["Object"]]]}],"meta":{"line":80,"file":"ClientVoiceManager.js","path":"src/client/voice"}},{"name":"joinChannel","description":"Sets up a request to join a voice channel","params":[{"name":"channel","description":"The voice channel to join","type":[[["VoiceChannel"]]]}],"returns":[[["Promise",".<"],["VoiceConnection",">"]]],"meta":{"line":98,"file":"ClientVoiceManager.js","path":"src/client/voice"}}],"meta":{"line":10,"file":"ClientVoiceManager.js","path":"src/client/voice"}},{"name":"StreamDispatcher","description":"The class that sends voice packet data to the voice connection.\r```js\r// obtained using:\rvoiceChannel.join().then(connection => {\r  // you can play a file or a stream here:\r  connection.playFile('./file.mp3').then(dispatcher => {\r\r  });\r});\r```","extends":["EventEmitter"],"props":[{"name":"volume","description":"The volume of the stream, relative to the stream's input volume","readonly":true,"type":[[["number"]]],"meta":{"line":217,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}}],"methods":[{"name":"end","description":"Stops the current stream permanently and emits an `end` event.","meta":{"line":208,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"setVolume","description":"Sets the volume relative to the input stream - i.e. 1 is normal, 0.5 is half, 2 is double.","params":[{"name":"volume","description":"The volume that you want to set","type":[[["number"]]]}],"meta":{"line":225,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"setVolumeDecibels","description":"Set the volume in decibels","params":[{"name":"db","description":"The decibels","type":[[["number"]]]}],"meta":{"line":233,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"setVolumeLogarithmic","description":"Set the volume so that a perceived value of 0.5 is half the perceived volume etc.","params":[{"name":"value","description":"The value for the volume","type":[[["number"]]]}],"meta":{"line":241,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"pause","description":"Stops sending voice packets to the voice connection (stream may still progress however)","meta":{"line":248,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"resume","description":"Resumes sending voice packets to the voice connection (may be further on in the stream than when paused)","meta":{"line":255,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}}],"events":[{"name":"speaking","description":"Emitted when the dispatcher starts/stops speaking","params":[{"name":"value","description":"Whether or not the dispatcher is speaking","type":[[["boolean"]]]}],"meta":{"line":36,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"end","description":"Emitted once the stream has ended. Attach a `once` listener to this.","meta":{"line":136,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"error","description":"Emitted once the stream has encountered an error. Attach a `once` listener to this. Also emits `end`.","params":[{"name":"err","description":"The encountered error","type":[[["Error"]]]}],"meta":{"line":144,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"debug","description":"Emitted when the stream wants to give debug information.","params":[{"name":"information","description":"The debug information","type":[[["string"]]]}],"meta":{"line":157,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}}],"meta":{"line":20,"file":"StreamDispatcher.js","path":"src/client/voice/dispatcher"}},{"name":"VoiceReceiver","description":"Receives voice data from a voice connection.\r```js\r// obtained using:\rvoiceChannel.join().then(connection => {\r const receiver = connection.createReceiver();\r});\r```","extends":["EventEmitter"],"props":[{"name":"connection","description":"The VoiceConnection that instantiated this","type":[[["VoiceConnection"]]],"meta":{"line":32,"file":"VoiceReceiver.js","path":"src/client/voice/receiver"}}],"methods":[{"name":"createOpusStream","description":"Creates a readable stream for a user that provides opus data while the user is speaking. When the user\rstops speaking, the stream is destroyed.","params":[{"name":"user","description":"The user to create the stream for","type":[[["UserResolvable"]]]}],"returns":[[["ReadableStream"]]],"meta":{"line":59,"file":"VoiceReceiver.js","path":"src/client/voice/receiver"}},{"name":"createPCMStream","description":"Creates a readable stream for a user that provides PCM data while the user is speaking. When the user\rstops speaking, the stream is destroyed. The stream is 16-bit signed stereo PCM at 48KHz.","params":[{"name":"user","description":"The user to create the stream for","type":[[["UserResolvable"]]]}],"returns":[[["ReadableStream"]]],"meta":{"line":78,"file":"VoiceReceiver.js","path":"src/client/voice/receiver"}}],"events":[{"name":"warn","description":"Emitted whenever a voice packet cannot be decrypted","params":[{"name":"message","description":"The warning message","type":[[["string"]]]}],"meta":{"line":91,"file":"VoiceReceiver.js","path":"src/client/voice/receiver"}},{"name":"opus","description":"Emitted whenever voice data is received from the voice connection. This is _always_ emitted (unlike PCM).","params":[{"name":"user","description":"The user that is sending the buffer (is speaking)","type":[[["User"]]]},{"name":"buffer","description":"The opus buffer","type":[[["Buffer"]]]}],"meta":{"line":101,"file":"VoiceReceiver.js","path":"src/client/voice/receiver"}},{"name":"pcm","description":"Emits decoded voice data when it's received. For performance reasons, the decoding will only\rhappen if there is at least one `pcm` listener on this receiver.","params":[{"name":"user","description":"The user that is sending the buffer (is speaking)","type":[[["User"]]]},{"name":"buffer","description":"The decoded buffer","type":[[["Buffer"]]]}],"meta":{"line":109,"file":"VoiceReceiver.js","path":"src/client/voice/receiver"}}],"meta":{"line":18,"file":"VoiceReceiver.js","path":"src/client/voice/receiver"}},{"name":"VoiceConnection","description":"Represents a connection to a Voice Channel in Discord.\r```js\r// obtained using:\rvoiceChannel.join().then(connection => {\r\r});\r```","extends":["EventEmitter"],"props":[{"name":"manager","description":"The voice manager of this connection","access":"private","type":[[["ClientVoiceManager"]]],"meta":{"line":26,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"player","description":"The player","type":[[["BasePlayer"]]],"meta":{"line":31,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"endpoint","description":"The endpoint of the connection","type":[[["string"]]],"meta":{"line":36,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"channel","description":"The VoiceChannel for this connection","type":[[["VoiceChannel"]]],"meta":{"line":41,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"websocket","description":"The WebSocket connection for this voice connection","access":"private","type":[[["VoiceConnectionWebSocket"]]],"meta":{"line":47,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"ready","description":"Whether or not the connection is ready","type":[[["boolean"]]],"meta":{"line":52,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"_resolve","description":"The resolve function for the promise associated with creating this connection","access":"private","type":[[["function"]]],"meta":{"line":58,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"_reject","description":"The reject function for the promise associated with creating this connection","access":"private","type":[[["function"]]],"meta":{"line":64,"file":"VoiceConnection.js","path":"src/client/voice"}}],"methods":[{"name":"_onError","description":"Executed whenever an error occurs with the UDP/WebSocket sub-client","access":"private","params":[{"name":"err","description":"The encountered error","type":[[["Error"]]]}],"meta":{"line":76,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"disconnect","description":"Disconnects the Client from the Voice Channel","params":[{"name":"reason","description":"The reason of the disconnection","optional":true,"default":"'user requested'","type":[[["string"]]]}],"meta":{"line":91,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"bindListeners","description":"Binds listeners to the WebSocket and UDP sub-clients","access":"private","meta":{"line":127,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"playFile","description":"Play the given file in the voice connection","examples":["// play files natively\rvoiceChannel.join()\r .then(connection => {\r   const dispatcher = connection.playFile('C:/Users/Discord/Desktop/music.mp3');\r })\r .catch(console.log);"],"params":[{"name":"file","description":"The path to the file","type":[[["string"]]]},{"name":"options","description":"Options for playing the stream","optional":true,"type":[[["StreamOptions"]]]}],"returns":[[["StreamDispatcher"]]],"meta":{"line":227,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"playStream","description":"Plays and converts an audio stream in the voice connection","examples":["// play streams using ytdl-core\rconst ytdl = require('ytdl-core');\rconst streamOptions = { seek: 0, volume: 1 };\rvoiceChannel.join()\r .then(connection => {\r   const stream = ytdl('https://www.youtube.com/watch?v=XAWgeLF9EVQ', {filter : 'audioonly'});\r   const dispatcher = connection.playStream(stream, streamOptions);\r })\r .catch(console.log);"],"params":[{"name":"stream","description":"The audio stream to play","type":[[["ReadableStream"]]]},{"name":"options","description":"Options for playing the stream","optional":true,"type":[[["StreamOptions"]]]}],"returns":[[["StreamDispatcher"]]],"meta":{"line":248,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"playConvertedStream","description":"Plays a stream of 16-bit signed stereo PCM at 48KHz.","params":[{"name":"stream","description":"The audio stream to play.","type":[[["ReadableStream"]]]},{"name":"options","description":"Options for playing the stream","optional":true,"type":[[["StreamOptions"]]]}],"returns":[[["StreamDispatcher"]]],"meta":{"line":259,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"createReceiver","description":"Creates a VoiceReceiver so you can start listening to voice data. It's recommended to only create one of these.","returns":[[["VoiceReceiver"]]],"meta":{"line":270,"file":"VoiceConnection.js","path":"src/client/voice"}}],"events":[{"name":"error","description":"Emitted whenever the connection encounters a fatal error.","params":[{"name":"error","description":"The encountered error","type":[[["Error"]]]}],"meta":{"line":78,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"disconnected","description":"Emit once the voice connection has disconnected.","params":[{"name":"error","description":"The encountered error, if any","type":[[["Error"]]]}],"meta":{"line":115,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"ready","description":"Emitted once the connection is ready (joining voice channels resolves when the connection is ready anyway)","meta":{"line":139,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"speaking","description":"Emitted whenever a user starts/stops speaking","params":[{"name":"user","description":"The user that has started/stopped speaking","type":[[["User"]]]},{"name":"speaking","description":"Whether or not the user is speaking","type":[[["boolean"]]]}],"meta":{"line":191,"file":"VoiceConnection.js","path":"src/client/voice"}}],"meta":{"line":18,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"WebSocketManager","description":"The WebSocket Manager of the Client","access":"private","props":[{"name":"client","description":"The Client that instantiated this WebSocketManager","type":[[["Client"]]],"meta":{"line":16,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"packetManager","description":"A WebSocket Packet manager, it handles all the messages","type":[[["PacketManager"]]],"meta":{"line":21,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"status","description":"The status of the WebSocketManager, a type of Constants.Status. It defaults to IDLE.","type":[[["number"]]],"meta":{"line":26,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"sessionID","description":"The session ID of the connection, null if not yet available.","nullable":true,"type":[[["string"]]],"meta":{"line":31,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"sequence","description":"The packet count of the client, null if not yet available.","nullable":true,"type":[[["number"]]],"meta":{"line":36,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"gateway","description":"The gateway address for this WebSocket connection, null if not yet available.","nullable":true,"type":[[["string"]]],"meta":{"line":41,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"normalReady","description":"Whether READY was emitted normally (all packets received) or not","type":[[["boolean"]]],"meta":{"line":46,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"ws","description":"The WebSocket connection to the gateway","nullable":true,"type":[[["WebSocket"]]],"meta":{"line":51,"file":"WebSocketManager.js","path":"src/client/websocket"}}],"methods":[{"name":"connect","description":"Connects the client to a given gateway","params":[{"name":"gateway","description":"The gateway to connect to","type":[[["string"]]]}],"meta":{"line":58,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"send","description":"Sends a packet to the gateway","params":[{"name":"data","description":"An object that can be JSON stringified","type":[[["Object"]]]},{"name":"force","description":"Whether or not to send the packet immediately","default":false,"type":[[["boolean"]]]}],"meta":{"line":76,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"eventOpen","description":"Run whenever the gateway connections opens up","meta":{"line":117,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"_sendResume","description":"Sends a gateway resume packet, in cases of unexpected disconnections.","meta":{"line":126,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"_sendNewIdentify","description":"Sends a new identification packet, in cases of new connections or failed reconnections.","meta":{"line":142,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"eventClose","description":"Run whenever the connection to the gateway is closed, it will try to reconnect the client.","params":[{"name":"event","description":"The received websocket data","type":[[["Object"]]]}],"meta":{"line":159,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"eventMessage","description":"Run whenever a message is received from the WebSocket. Returns `true` if the message\rwas handled properly.","params":[{"name":"event","description":"The received websocket data","type":[[["Object"]]]}],"returns":[[["boolean"]]],"meta":{"line":170,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"eventError","description":"Run whenever an error occurs with the WebSocket connection. Tries to reconnect","params":[{"name":"err","description":"The encountered error","type":[[["Error"]]]}],"meta":{"line":189,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"checkIfReady","description":"Runs on new packets before `READY` to see if the Client is ready yet, if it is prepares\rthe `READY` event.","meta":{"line":216,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"tryReconnect","description":"Tries to reconnect the client, changing the status to Constants.Status.RECONNECTING.","meta":{"line":240,"file":"WebSocketManager.js","path":"src/client/websocket"}}],"meta":{"line":10,"file":"WebSocketManager.js","path":"src/client/websocket"}},{"name":"Shard","description":"Represents a Shard spawned by the ShardingManager.","construct":{"name":"Shard","params":[{"name":"manager","description":"The sharding manager","type":[[["ShardingManager"]]]},{"name":"id","description":"The ID of this shard","type":[[["number"]]]}]},"props":[{"name":"manager","description":"The manager of the spawned shard","type":[[["ShardingManager"]]],"meta":{"line":17,"file":"Shard.js","path":"src/sharding"}},{"name":"id","description":"The shard ID","type":[[["number"]]],"meta":{"line":22,"file":"Shard.js","path":"src/sharding"}},{"name":"process","description":"The process of the shard","type":[[["ChildProcess"]]],"meta":{"line":27,"file":"Shard.js","path":"src/sharding"}}],"meta":{"line":7,"file":"Shard.js","path":"src/sharding"}},{"name":"ShardingManager","description":"This is a utility class that can be used to help you spawn shards of your Client. Each shard is completely separate\rfrom the other. The Shard Manager takes a path to a file and spawns it under the specified amount of shards safely.\r<warn>The Sharding Manager is still experimental</warn>","extends":["EventEmitter"],"construct":{"name":"ShardingManager","params":[{"name":"file","description":"Path to your shard script file","type":[[["string"]]]},{"name":"totalShards","description":"Number of shards to default to spawning","optional":true,"default":1,"type":[[["number"]]]}]},"props":[{"name":"file","description":"Path to the shard script file","type":[[["string"]]],"meta":{"line":26,"file":"ShardingManager.js","path":"src/sharding"}},{"name":"totalShards","description":"The amount of shards that this manager is going to spawn","type":[[["number"]]],"meta":{"line":36,"file":"ShardingManager.js","path":"src/sharding"}},{"name":"shards","description":"A collection of shards that this manager has spawned","type":[[["Collection",".<"],["number",", "],["Shard",">"]]],"meta":{"line":46,"file":"ShardingManager.js","path":"src/sharding"}}],"methods":[{"name":"createShard","description":"Spawns a single shard.","meta":{"line":52,"file":"ShardingManager.js","path":"src/sharding"}},{"name":"spawn","description":"Spawns multiple shards.","params":[{"name":"amount","description":"The number of shards to spawn","optional":true,"default":"this.totalShards","type":[[["number"]]]}],"meta":{"line":63,"file":"ShardingManager.js","path":"src/sharding"}}],"meta":{"line":14,"file":"ShardingManager.js","path":"src/sharding"}},{"name":"Channel","description":"Represents any Channel on Discord","props":[{"name":"client","description":"The client that instantiated the Channel","type":[[["Client"]]],"meta":{"line":10,"file":"Channel.js","path":"src/structures"}},{"name":"type","description":"The type of the channel, either:\r* `dm` - a DM channel\r* `group` - a Group DM channel\r* `text` - a guild text channel\r* `voice` - a guild voice channel","type":[[["string"]]],"meta":{"line":21,"file":"Channel.js","path":"src/structures"}},{"name":"id","description":"The unique ID of the channel","type":[[["string"]]],"meta":{"line":31,"file":"Channel.js","path":"src/structures"}},{"name":"creationDate","description":"The time the channel was created","readonly":true,"type":[[["Date"]]],"meta":{"line":39,"file":"Channel.js","path":"src/structures"}}],"methods":[{"name":"delete","description":"Deletes the channel","examples":["// delete the channel\rchannel.delete()\r .then() // success\r .catch(console.log); // log error"],"returns":[[["Promise",".<"],["Channel",">"]]],"meta":{"line":52,"file":"Channel.js","path":"src/structures"}}],"meta":{"line":4,"file":"Channel.js","path":"src/structures"}},{"name":"ClientUser","description":"Represents the logged in client's Discord User","extends":["User"],"props":[{"name":"verified","description":"Whether or not this account has been verified","type":[[["boolean"]]],"meta":{"line":15,"file":"ClientUser.js","path":"src/structures"}},{"name":"email","description":"The email of this account","type":[[["string"]]],"meta":{"line":21,"file":"ClientUser.js","path":"src/structures"}},{"name":"client","description":"The Client that created the instance of the the User.","type":[[["Client"]]],"meta":{"line":14,"file":"User.js","path":"src/structures"}},{"name":"id","description":"The ID of the User","type":[[["string"]]],"meta":{"line":25,"file":"User.js","path":"src/structures"}},{"name":"username","description":"The username of the User","type":[[["string"]]],"meta":{"line":31,"file":"User.js","path":"src/structures"}},{"name":"discriminator","description":"A discriminator based on username for the User","type":[[["string"]]],"meta":{"line":37,"file":"User.js","path":"src/structures"}},{"name":"avatar","description":"The ID of the user's avatar","type":[[["string"]]],"meta":{"line":43,"file":"User.js","path":"src/structures"}},{"name":"bot","description":"Whether or not the User is a Bot.","type":[[["boolean"]]],"meta":{"line":49,"file":"User.js","path":"src/structures"}},{"name":"status","description":"The status of the user:\r\r* **`online`** - user is online\r* **`offline`** - user is offline\r* **`idle`** - user is AFK","type":[[["string"]]],"meta":{"line":59,"file":"User.js","path":"src/structures"}},{"name":"game","description":"The game that the user is playing, `null` if they aren't playing a game.","type":[[["string"]]],"meta":{"line":65,"file":"User.js","path":"src/structures"}},{"name":"creationDate","description":"The time the user was created","readonly":true,"type":[[["Date"]]],"meta":{"line":73,"file":"User.js","path":"src/structures"}},{"name":"avatarURL","description":"A link to the user's avatar (if they have one, otherwise null)","readonly":true,"nullable":true,"type":[[["string"]]],"meta":{"line":82,"file":"User.js","path":"src/structures"}}],"methods":[{"name":"setUsername","description":"Set the username of the logged in Client.\r<info>Changing usernames in Discord is heavily rate limited, with only 2 requests\revery hour. Use this sparingly!</info>","examples":["// set username\rclient.user.setUsername('discordjs')\r .then(user => console.log(`My new username is ${user.username}`))\r .catch(console.log);"],"params":[{"name":"username","description":"The new username","type":[[["string"]]]}],"returns":[[["Promise",".<"],["ClientUser",">"]]],"meta":{"line":38,"file":"ClientUser.js","path":"src/structures"}},{"name":"setEmail","description":"If this user is a \"self bot\" or logged in using a normal user's details (which should be avoided), you can set the\remail here.","examples":["// set email\rclient.user.setEmail('bob@gmail.com')\r .then(user => console.log(`My new email is ${user.email}`))\r .catch(console.log);"],"params":[{"name":"email","description":"The new email","type":[[["string"]]]}],"returns":[[["Promise",".<"],["ClientUser",">"]]],"meta":{"line":53,"file":"ClientUser.js","path":"src/structures"}},{"name":"setPassword","description":"If this user is a \"self bot\" or logged in using a normal user's details (which should be avoided), you can set the\rpassword here.","examples":["// set password\rclient.user.setPassword('password')\r .then(user => console.log('New password set!'))\r .catch(console.log);"],"params":[{"name":"password","description":"The new password","type":[[["string"]]]}],"returns":[[["Promise",".<"],["ClientUser",">"]]],"meta":{"line":68,"file":"ClientUser.js","path":"src/structures"}},{"name":"setAvatar","description":"Set the avatar of the logged in Client.","examples":["// set avatar\rclient.user.setAvatar(fs.readFileSync('./avatar.png'))\r .then(user => console.log(`New avatar set!`))\r .catch(console.log);"],"params":[{"name":"avatar","description":"The new avatar","type":[[["Base64Resolvable"]]]}],"returns":[[["Promise",".<"],["ClientUser",">"]]],"meta":{"line":82,"file":"ClientUser.js","path":"src/structures"}},{"name":"setStatus","description":"Set the status and playing game of the logged in client.","examples":["// set status\rclient.user.setStatus('status', 'game')\r .then(user => console.log('Changed status!'))\r .catch(console.log);"],"params":[{"name":"status","description":"The status, can be `online` or `idle`","optional":true,"type":[[["string"]]]},{"name":"game","description":"The game that is being played","optional":true,"type":[[["string"]],[["Object"]]]},{"name":"url","description":"If you want to display as streaming, set this as the URL to the stream (must be a\rtwitch.tv URl)","optional":true,"default":null,"type":[[["string"]]]}],"returns":[[["Promise",".<"],["ClientUser",">"]]],"meta":{"line":99,"file":"ClientUser.js","path":"src/structures"}},{"name":"deleteDM","description":"Deletes a DM Channel (if one exists) between the Client and the User. Resolves with the Channel if successful.","inherits":"User#deleteDM","inherited":true,"returns":[[["Promise",".<"],["DMChannel",">"]]],"meta":{"line":91,"file":"User.js","path":"src/structures"}},{"name":"equals","description":"Checks if the user is equal to another. It compares username, ID, discriminator, status and the game being played.\rIt is recommended to compare equality by using `user.id === user2.id` unless you want to compare all properties.","inherits":"User#equals","inherited":true,"params":[{"name":"user","description":"The user to compare","type":[[["User"]]]}],"returns":[[["boolean"]]],"meta":{"line":101,"file":"User.js","path":"src/structures"}},{"name":"toString","description":"When concatenated with a string, this automatically concatenates the User's mention instead of the User object.","inherits":"User#toString","inherited":true,"examples":["// logs: Hello from <@123456789>!\rconsole.log(`Hello from ${user}!`);"],"returns":[[["string"]]],"meta":{"line":124,"file":"User.js","path":"src/structures"}},{"name":"sendMessage","description":"Send a message to this channel","inherits":"User#sendMessage","inherited":true,"implements":["TextBasedChannel#sendMessage"],"examples":["// send a message\rchannel.sendMessage('hello!')\r .then(message => console.log(`Sent message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":48,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendTTSMessage","description":"Send a text-to-speech message to this channel","inherits":"User#sendTTSMessage","inherited":true,"implements":["TextBasedChannel#sendTTSMessage"],"examples":["// send a TTS message\rchannel.sendTTSMessage('hello!')\r .then(message => console.log(`Sent tts message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":63,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendFile","description":"Send a file to this channel","inherits":"User#sendFile","inherited":true,"implements":["TextBasedChannel#sendFile"],"params":[{"name":"attachment","description":"The file to send","type":[[["FileResolvable"]]]},{"name":"fileName","description":"The name and extension of the file","optional":true,"default":"\"file.jpg\"","type":[[["string"]]]},{"name":"content","description":"Text message to send with the attachment","optional":true,"type":[[["StringResolvable"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":74,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"meta":{"line":7,"file":"ClientUser.js","path":"src/structures"}},{"name":"DMChannel","description":"Represents a Direct Message Channel between two users.","extends":["Channel"],"props":[{"name":"recipient","description":"The recipient on the other end of the DM","type":[[["User"]]],"meta":{"line":24,"file":"DMChannel.js","path":"src/structures"}},{"name":"messages","description":"A Collection containing the messages sent to this channel.","type":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":16,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"lastMessageID","description":"The ID of the last message in the channel, if one was sent.","nullable":true,"type":[[["string"]]],"meta":{"line":22,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"typing","description":"Whether or not the typing indicator is being shown in the channel.","type":[[["boolean"]]],"meta":{"line":222,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"typingCount","description":"Number of times `startTyping` has been called.","type":[[["number"]]],"meta":{"line":230,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"client","description":"The client that instantiated the Channel","type":[[["Client"]]],"meta":{"line":10,"file":"Channel.js","path":"src/structures"}},{"name":"type","description":"The type of the channel, either:\r* `dm` - a DM channel\r* `group` - a Group DM channel\r* `text` - a guild text channel\r* `voice` - a guild voice channel","type":[[["string"]]],"meta":{"line":21,"file":"Channel.js","path":"src/structures"}},{"name":"id","description":"The unique ID of the channel","type":[[["string"]]],"meta":{"line":31,"file":"Channel.js","path":"src/structures"}},{"name":"creationDate","description":"The time the channel was created","readonly":true,"type":[[["Date"]]],"meta":{"line":39,"file":"Channel.js","path":"src/structures"}}],"methods":[{"name":"toString","description":"When concatenated with a string, this automatically concatenates the recipient's mention instead of the\rDM channel object.","returns":[[["string"]]],"meta":{"line":36,"file":"DMChannel.js","path":"src/structures"}},{"name":"sendMessage","description":"Send a message to this channel","implements":["TextBasedChannel#sendMessage"],"examples":["// send a message\rchannel.sendMessage('hello!')\r .then(message => console.log(`Sent message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":48,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendTTSMessage","description":"Send a text-to-speech message to this channel","implements":["TextBasedChannel#sendTTSMessage"],"examples":["// send a TTS message\rchannel.sendTTSMessage('hello!')\r .then(message => console.log(`Sent tts message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":63,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendFile","description":"Send a file to this channel","implements":["TextBasedChannel#sendFile"],"params":[{"name":"attachment","description":"The file to send","type":[[["FileResolvable"]]]},{"name":"fileName","description":"The name and extension of the file","optional":true,"default":"\"file.jpg\"","type":[[["string"]]]},{"name":"content","description":"Text message to send with the attachment","optional":true,"type":[[["StringResolvable"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":74,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchMessage","description":"Gets a single message from this channel, regardless of it being cached or not.","implements":["TextBasedChannel#fetchMessage"],"examples":["// get message\rchannel.fetchMessage('99539446449315840')\r  .then(message => console.log(message.content))\r  .catch(console.error);"],"params":[{"name":"messageID","description":"The ID of the message to get","type":[[["string"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":104,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchMessages","description":"Gets the past messages sent in this channel. Resolves with a Collection mapping message ID's to Message objects.","implements":["TextBasedChannel#fetchMessages"],"examples":["// get messages\rchannel.fetchMessages({limit: 10})\r .then(messages => console.log(`Received ${messages.size} messages`))\r .catch(console.log);"],"params":[{"name":"options","description":"The query parameters to pass in","optional":true,"default":"{}","type":[[["ChannelLogsQueryOptions"]]]}],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":140,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchPinnedMessages","description":"Fetches the pinned messages of this Channel and returns a Collection of them.","implements":["TextBasedChannel#fetchPinnedMessages"],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":158,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"startTyping","description":"Starts a typing indicator in the channel.","implements":["TextBasedChannel#startTyping"],"examples":["// start typing in a channel\rchannel.startTyping();"],"params":[{"name":"count","description":"The number of times startTyping should be considered to have been called","optional":true,"type":[[["number"]]]}],"meta":{"line":179,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"stopTyping","description":"Stops the typing indicator in the channel.\rThe indicator will only stop if this is called as many times as startTyping().\r<info>It can take a few seconds for the Client User to stop typing.</info>","implements":["TextBasedChannel#stopTyping"],"examples":["// stop typing in a channel\rchannel.stopTyping();","// force typing to fully stop in a channel\rchannel.stopTyping(true);"],"params":[{"name":"force","description":"Whether or not to reset the call count and force the indicator to stop","optional":true,"default":false,"type":[[["boolean"]]]}],"meta":{"line":207,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"createCollector","description":"Creates a Message Collector","implements":["TextBasedChannel#createCollector"],"examples":["// create a message collector\rconst collector = channel.createCollector(\r m => m.content.includes('discord'),\r { time: 15000 }\r);\rcollector.on('message', m => console.log(`Collected ${m.content}`));\rcollector.on('end', collected => console.log(`Collected ${collected.size} items`));"],"params":[{"name":"filter","description":"The filter to create the collector with","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"The options to pass to the collector","optional":true,"default":"{}","type":[[["CollectorOptions"]]]}],"returns":[[["MessageCollector"]]],"meta":{"line":249,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"awaitMessages","description":"Similar to createCollector but in Promise form. Resolves with a Collection of messages that pass the specified\rfilter.","implements":["TextBasedChannel#awaitMessages"],"examples":["// await !vote messages\rconst filter = m => m.content.startsWith('!vote');\r// errors: ['time'] treats ending because of the time limit as an error\rchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\r .then(collected => console.log(collected.size))\r .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));"],"params":[{"name":"filter","description":"The filter function to use","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"Optional options to pass to the internal collector","optional":true,"default":"{}","type":[[["AwaitMessagesOptions"]]]}],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":277,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"bulkDelete","description":"Bulk delete a given Collection or Array of messages in one go. Returns the deleted messages after.","implements":["TextBasedChannel#bulkDelete"],"params":[{"name":"messages","description":"The messages to delete","type":[[["Collection",".<"],["string",", "],["Message",">"]],[["Array",".<"],["Message",">"]]]}],"returns":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":295,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"delete","description":"Deletes the channel","inherits":"Channel#delete","inherited":true,"examples":["// delete the channel\rchannel.delete()\r .then() // success\r .catch(console.log); // log error"],"returns":[[["Promise",".<"],["Channel",">"]]],"meta":{"line":52,"file":"Channel.js","path":"src/structures"}}],"meta":{"line":11,"file":"DMChannel.js","path":"src/structures"}},{"name":"Emoji","description":"Represents a Custom Emoji","props":[{"name":"client","description":"The Client that instantiated this object","type":[[["Client"]]],"meta":{"line":13,"file":"Emoji.js","path":"src/structures"}},{"name":"guild","description":"The Guild this emoji is part of","type":[[["Guild"]]],"meta":{"line":20,"file":"Emoji.js","path":"src/structures"}},{"name":"id","description":"The ID of the Emoji","type":[[["string"]]],"meta":{"line":30,"file":"Emoji.js","path":"src/structures"}},{"name":"name","description":"The name of the Emoji","type":[[["string"]]],"meta":{"line":36,"file":"Emoji.js","path":"src/structures"}},{"name":"requiresColons","description":"Whether or not this emoji requires colons surrounding it","type":[[["boolean"]]],"meta":{"line":42,"file":"Emoji.js","path":"src/structures"}},{"name":"managed","description":"Whether this emoji is managed by an external service","type":[[["boolean"]]],"meta":{"line":48,"file":"Emoji.js","path":"src/structures"}},{"name":"creationDate","description":"The time the emoji was created","readonly":true,"type":[[["Date"]]],"meta":{"line":58,"file":"Emoji.js","path":"src/structures"}},{"name":"roles","description":"A collection of roles this emoji is active for (empty if all), mapped by role ID.","readonly":true,"type":[[["Collection",".<"],["string",", "],["Role",">"]]],"meta":{"line":67,"file":"Emoji.js","path":"src/structures"}},{"name":"url","description":"The URL to the emoji file","readonly":true,"type":[[["string"]]],"meta":{"line":80,"file":"Emoji.js","path":"src/structures"}}],"methods":[{"name":"toString","description":"When concatenated with a string, this automatically returns the emoji mention rather than the object.","examples":["// send an emoji:\rconst emoji = guild.emojis.array()[0];\rmsg.reply(`Hello! ${emoji}`);"],"returns":[[["string"]]],"meta":{"line":92,"file":"Emoji.js","path":"src/structures"}}],"meta":{"line":7,"file":"Emoji.js","path":"src/structures"}},{"name":"EvaluatedPermissions","description":"The final evaluated permissions for a member in a channel","props":[{"name":"member","description":"The member this permissions refer to","type":[[["GuildMember"]]],"meta":{"line":12,"file":"EvaluatedPermissions.js","path":"src/structures"}},{"name":"permissions","description":"A number representing the packed permissions.","access":"private","type":[[["number"]]],"meta":{"line":19,"file":"EvaluatedPermissions.js","path":"src/structures"}}],"methods":[{"name":"serialize","description":"Get an object mapping permission name, e.g. `READ_MESSAGES` to a boolean - whether the user\rcan perform this or not.","returns":[[["Object",".<"],["string",", "],["boolean",">"]]],"meta":{"line":27,"file":"EvaluatedPermissions.js","path":"src/structures"}},{"name":"hasPermission","description":"Checks whether the user has a certain permission, e.g. `READ_MESSAGES`.","params":[{"name":"permission","description":"The permission to check for","type":[[["PermissionResolvable"]]]},{"name":"explicit","description":"Whether to require the user to explicitly have the exact permission","optional":true,"default":false,"type":[[["boolean"]]]}],"returns":[[["boolean"]]],"meta":{"line":41,"file":"EvaluatedPermissions.js","path":"src/structures"}}],"meta":{"line":6,"file":"EvaluatedPermissions.js","path":"src/structures"}},{"name":"GroupDMChannel","description":"Represents a Group DM on Discord","extends":["Channel"],"props":[{"name":"name","description":"The name of this Group DM, can be null if one isn't set.","type":[[["string"]]],"meta":{"line":46,"file":"GroupDMChannel.js","path":"src/structures"}},{"name":"icon","description":"A hash of the Group DM icon.","type":[[["string"]]],"meta":{"line":52,"file":"GroupDMChannel.js","path":"src/structures"}},{"name":"owner","description":"The owner of this Group DM.","type":[[["User"]]],"meta":{"line":58,"file":"GroupDMChannel.js","path":"src/structures"}},{"name":"recipients","description":"A collection of the recipients of this DM, mapped by their ID.","type":[[["Collection",".<"],["string",", "],["User",">"]]],"meta":{"line":65,"file":"GroupDMChannel.js","path":"src/structures"}},{"name":"messages","description":"A Collection containing the messages sent to this channel.","type":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":16,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"lastMessageID","description":"The ID of the last message in the channel, if one was sent.","nullable":true,"type":[[["string"]]],"meta":{"line":22,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"typing","description":"Whether or not the typing indicator is being shown in the channel.","type":[[["boolean"]]],"meta":{"line":222,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"typingCount","description":"Number of times `startTyping` has been called.","type":[[["number"]]],"meta":{"line":230,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"client","description":"The client that instantiated the Channel","type":[[["Client"]]],"meta":{"line":10,"file":"Channel.js","path":"src/structures"}},{"name":"type","description":"The type of the channel, either:\r* `dm` - a DM channel\r* `group` - a Group DM channel\r* `text` - a guild text channel\r* `voice` - a guild voice channel","type":[[["string"]]],"meta":{"line":21,"file":"Channel.js","path":"src/structures"}},{"name":"id","description":"The unique ID of the channel","type":[[["string"]]],"meta":{"line":31,"file":"Channel.js","path":"src/structures"}},{"name":"creationDate","description":"The time the channel was created","readonly":true,"type":[[["Date"]]],"meta":{"line":39,"file":"Channel.js","path":"src/structures"}}],"methods":[{"name":"equals","description":"Whether this channel equals another channel. It compares all properties, so for most operations\rit is advisable to just compare `channel.id === channel2.id` as it is much faster and is often\rwhat most users need.","params":[{"name":"channel","description":"The channel to compare to","type":[[["GroupDMChannel"]]]}],"returns":[[["boolean"]]],"meta":{"line":87,"file":"GroupDMChannel.js","path":"src/structures"}},{"name":"toString","description":"When concatenated with a string, this automatically concatenates the Channel's name instead of the Channel object.","examples":["// logs: Hello from My Group DM!\rconsole.log(`Hello from ${channel}!`);","// logs: Hello from My Group DM!\rconsole.log(`Hello from ' + channel + '!');"],"returns":[[["string"]]],"meta":{"line":113,"file":"GroupDMChannel.js","path":"src/structures"}},{"name":"sendMessage","description":"Send a message to this channel","implements":["TextBasedChannel#sendMessage"],"examples":["// send a message\rchannel.sendMessage('hello!')\r .then(message => console.log(`Sent message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":48,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendTTSMessage","description":"Send a text-to-speech message to this channel","implements":["TextBasedChannel#sendTTSMessage"],"examples":["// send a TTS message\rchannel.sendTTSMessage('hello!')\r .then(message => console.log(`Sent tts message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":63,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendFile","description":"Send a file to this channel","implements":["TextBasedChannel#sendFile"],"params":[{"name":"attachment","description":"The file to send","type":[[["FileResolvable"]]]},{"name":"fileName","description":"The name and extension of the file","optional":true,"default":"\"file.jpg\"","type":[[["string"]]]},{"name":"content","description":"Text message to send with the attachment","optional":true,"type":[[["StringResolvable"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":74,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchMessage","description":"Gets a single message from this channel, regardless of it being cached or not.","implements":["TextBasedChannel#fetchMessage"],"examples":["// get message\rchannel.fetchMessage('99539446449315840')\r  .then(message => console.log(message.content))\r  .catch(console.error);"],"params":[{"name":"messageID","description":"The ID of the message to get","type":[[["string"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":104,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchMessages","description":"Gets the past messages sent in this channel. Resolves with a Collection mapping message ID's to Message objects.","implements":["TextBasedChannel#fetchMessages"],"examples":["// get messages\rchannel.fetchMessages({limit: 10})\r .then(messages => console.log(`Received ${messages.size} messages`))\r .catch(console.log);"],"params":[{"name":"options","description":"The query parameters to pass in","optional":true,"default":"{}","type":[[["ChannelLogsQueryOptions"]]]}],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":140,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchPinnedMessages","description":"Fetches the pinned messages of this Channel and returns a Collection of them.","implements":["TextBasedChannel#fetchPinnedMessages"],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":158,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"startTyping","description":"Starts a typing indicator in the channel.","implements":["TextBasedChannel#startTyping"],"examples":["// start typing in a channel\rchannel.startTyping();"],"params":[{"name":"count","description":"The number of times startTyping should be considered to have been called","optional":true,"type":[[["number"]]]}],"meta":{"line":179,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"stopTyping","description":"Stops the typing indicator in the channel.\rThe indicator will only stop if this is called as many times as startTyping().\r<info>It can take a few seconds for the Client User to stop typing.</info>","implements":["TextBasedChannel#stopTyping"],"examples":["// stop typing in a channel\rchannel.stopTyping();","// force typing to fully stop in a channel\rchannel.stopTyping(true);"],"params":[{"name":"force","description":"Whether or not to reset the call count and force the indicator to stop","optional":true,"default":false,"type":[[["boolean"]]]}],"meta":{"line":207,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"createCollector","description":"Creates a Message Collector","implements":["TextBasedChannel#createCollector"],"examples":["// create a message collector\rconst collector = channel.createCollector(\r m => m.content.includes('discord'),\r { time: 15000 }\r);\rcollector.on('message', m => console.log(`Collected ${m.content}`));\rcollector.on('end', collected => console.log(`Collected ${collected.size} items`));"],"params":[{"name":"filter","description":"The filter to create the collector with","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"The options to pass to the collector","optional":true,"default":"{}","type":[[["CollectorOptions"]]]}],"returns":[[["MessageCollector"]]],"meta":{"line":249,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"awaitMessages","description":"Similar to createCollector but in Promise form. Resolves with a Collection of messages that pass the specified\rfilter.","implements":["TextBasedChannel#awaitMessages"],"examples":["// await !vote messages\rconst filter = m => m.content.startsWith('!vote');\r// errors: ['time'] treats ending because of the time limit as an error\rchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\r .then(collected => console.log(collected.size))\r .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));"],"params":[{"name":"filter","description":"The filter function to use","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"Optional options to pass to the internal collector","optional":true,"default":"{}","type":[[["AwaitMessagesOptions"]]]}],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":277,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"bulkDelete","description":"Bulk delete a given Collection or Array of messages in one go. Returns the deleted messages after.","implements":["TextBasedChannel#bulkDelete"],"params":[{"name":"messages","description":"The messages to delete","type":[[["Collection",".<"],["string",", "],["Message",">"]],[["Array",".<"],["Message",">"]]]}],"returns":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":295,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"delete","description":"Deletes the channel","inherits":"Channel#delete","inherited":true,"examples":["// delete the channel\rchannel.delete()\r .then() // success\r .catch(console.log); // log error"],"returns":[[["Promise",".<"],["Channel",">"]]],"meta":{"line":52,"file":"Channel.js","path":"src/structures"}}],"meta":{"line":33,"file":"GroupDMChannel.js","path":"src/structures"}},{"name":"Guild","description":"Represents a Guild (or a Server) on Discord.\r<info>It's recommended to see if a guild is available before performing operations or reading data from it. You can\rcheck this with `guild.available`.</info>","props":[{"name":"client","description":"The Client that created the instance of the the Guild.","type":[[["Client"]]],"meta":{"line":21,"file":"Guild.js","path":"src/structures"}},{"name":"members","description":"A Collection of members that are in this Guild. The key is the member's ID, the value is the member.","type":[[["Collection",".<"],["string",", "],["GuildMember",">"]]],"meta":{"line":28,"file":"Guild.js","path":"src/structures"}},{"name":"channels","description":"A Collection of channels that are in this Guild. The key is the channel's ID, the value is the channel.","type":[[["Collection",".<"],["string",", "],["GuildChannel",">"]]],"meta":{"line":34,"file":"Guild.js","path":"src/structures"}},{"name":"roles","description":"A Collection of roles that are in this Guild. The key is the role's ID, the value is the role.","type":[[["Collection",".<"],["string",", "],["Role",">"]]],"meta":{"line":40,"file":"Guild.js","path":"src/structures"}},{"name":"available","description":"Whether the Guild is available to access. If it is not available, it indicates a server outage.","type":[[["boolean"]]],"meta":{"line":48,"file":"Guild.js","path":"src/structures"}},{"name":"id","description":"The Unique ID of the Guild, useful for comparisons.","type":[[["string"]]],"meta":{"line":54,"file":"Guild.js","path":"src/structures"}},{"name":"name","description":"The name of the guild","type":[[["string"]]],"meta":{"line":71,"file":"Guild.js","path":"src/structures"}},{"name":"icon","description":"The hash of the guild icon, or null if there is no icon.","nullable":true,"type":[[["string"]]],"meta":{"line":77,"file":"Guild.js","path":"src/structures"}},{"name":"splash","description":"The hash of the guild splash image, or null if no splash (VIP only)","nullable":true,"type":[[["string"]]],"meta":{"line":83,"file":"Guild.js","path":"src/structures"}},{"name":"region","description":"The region the guild is located in","type":[[["string"]]],"meta":{"line":89,"file":"Guild.js","path":"src/structures"}},{"name":"memberCount","description":"The full amount of members in this Guild as of `READY`","type":[[["number"]]],"meta":{"line":95,"file":"Guild.js","path":"src/structures"}},{"name":"large","description":"Whether the guild is \"large\" (has more than 250 members)","type":[[["boolean"]]],"meta":{"line":101,"file":"Guild.js","path":"src/structures"}},{"name":"features","description":"An array of guild features.","type":[[["Array",".<"],["Object",">"]]],"meta":{"line":107,"file":"Guild.js","path":"src/structures"}},{"name":"emojis","description":"An array of guild emojis.","type":[[["Array",".<"],["Object",">"]]],"meta":{"line":113,"file":"Guild.js","path":"src/structures"}},{"name":"afkTimeout","description":"The time in seconds before a user is counted as \"away from keyboard\".","nullable":true,"type":[[["number"]]],"meta":{"line":120,"file":"Guild.js","path":"src/structures"}},{"name":"afkChannelID","description":"The ID of the voice channel where AFK members are moved.","nullable":true,"type":[[["string"]]],"meta":{"line":126,"file":"Guild.js","path":"src/structures"}},{"name":"embedEnabled","description":"Whether embedded images are enabled on this guild.","type":[[["boolean"]]],"meta":{"line":132,"file":"Guild.js","path":"src/structures"}},{"name":"verificationLevel","description":"The verification level of the guild.","type":[[["number"]]],"meta":{"line":138,"file":"Guild.js","path":"src/structures"}},{"name":"creationDate","description":"The time the guild was created","readonly":true,"type":[[["Date"]]],"meta":{"line":198,"file":"Guild.js","path":"src/structures"}},{"name":"joinDate","description":"The date at which the logged-in client joined the guild.","type":[[["Date"]]],"meta":{"line":206,"file":"Guild.js","path":"src/structures"}},{"name":"iconURL","description":"Gets the URL to this guild's icon (if it has one, otherwise it returns null)","readonly":true,"nullable":true,"type":[[["string"]]],"meta":{"line":215,"file":"Guild.js","path":"src/structures"}},{"name":"owner","description":"The owner of the Guild","readonly":true,"type":[[["GuildMember"]]],"meta":{"line":225,"file":"Guild.js","path":"src/structures"}},{"name":"defaultChannel","description":"The `#general` GuildChannel of the server.","readonly":true,"type":[[["GuildChannel"]]],"meta":{"line":234,"file":"Guild.js","path":"src/structures"}}],"methods":[{"name":"setup","description":"Sets up the Guild","access":"private","params":[{"name":"data","description":"The raw data of the guild","type":[["*"]]}],"meta":{"line":66,"file":"Guild.js","path":"src/structures"}},{"name":"edit","description":"Updates the Guild with new information - e.g. a new name.","examples":["// set the guild name and region\rguild.edit({\r name: 'Discord Guild',\r region: 'london',\r})\r.then(updated => console.log(`New guild name ${updated.name} in region ${updated.region}`))\r.catch(console.log);"],"params":[{"name":"data","description":"The data to update the guild with","type":[[["GuildEditData"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":251,"file":"Guild.js","path":"src/structures"}},{"name":"setName","description":"Edit the name of the Guild.","examples":["// edit the guild name\rguild.setName('Discord Guild')\r .then(updated => console.log(`Updated guild name to ${guild.name}`))\r .catch(console.log);"],"params":[{"name":"name","description":"The new name of the Guild","type":[[["string"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":265,"file":"Guild.js","path":"src/structures"}},{"name":"setRegion","description":"Edit the region of the Guild.","examples":["// edit the guild region\rguild.setRegion('london')\r .then(updated => console.log(`Updated guild region to ${guild.region}`))\r .catch(console.log);"],"params":[{"name":"region","description":"The new region of the guild.","type":[[["Region"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":279,"file":"Guild.js","path":"src/structures"}},{"name":"setVerificationLevel","description":"Edit the verification level of the Guild.","examples":["// edit the guild verification level\rguild.setVerificationLevel(1)\r .then(updated => console.log(`Updated guild verification level to ${guild.verificationLevel}`))\r .catch(console.log);"],"params":[{"name":"verificationLevel","description":"The new verification level of the guild","type":[[["VerificationLevel"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":293,"file":"Guild.js","path":"src/structures"}},{"name":"setAFKChannel","description":"Edit the AFK channel of the Guild.","examples":["// edit the guild AFK channel\rguild.setAFKChannel(channel)\r .then(updated => console.log(`Updated guild AFK channel to ${guild.afkChannel}`))\r .catch(console.log);"],"params":[{"name":"afkChannel","description":"The new AFK channel","type":[[["GuildChannelResolvable"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":307,"file":"Guild.js","path":"src/structures"}},{"name":"setAFKTimeout","description":"Edit the AFK timeout of the Guild.","examples":["// edit the guild AFK channel\rguild.setAFKTimeout(60)\r .then(updated => console.log(`Updated guild AFK timeout to ${guild.afkTimeout}`))\r .catch(console.log);"],"params":[{"name":"afkTimeout","description":"The time in seconds that a user must be idle to be considered AFK","type":[[["number"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":321,"file":"Guild.js","path":"src/structures"}},{"name":"setIcon","description":"Set a new Guild Icon.","examples":["// edit the guild icon\rguild.setIcon(fs.readFileSync('./icon.png'))\r .then(updated => console.log('Updated the guild icon'))\r .catch(console.log);"],"params":[{"name":"icon","description":"The new icon of the guild","type":[[["Base64Resolvable"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":335,"file":"Guild.js","path":"src/structures"}},{"name":"setOwner","description":"Sets a new owner of the Guild.","examples":["// edit the guild owner\rguild.setOwner(guilds.members[0])\r .then(updated => console.log(`Updated the guild owner to ${updated.owner.username}`))\r .catch(console.log);"],"params":[{"name":"owner","description":"The new owner of the Guild","type":[[["GuildMemberResolvable"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":349,"file":"Guild.js","path":"src/structures"}},{"name":"setSplash","description":"Set a new Guild Splash Logo.","examples":["// edit the guild splash\rguild.setIcon(fs.readFileSync('./splash.png'))\r .then(updated => console.log('Updated the guild splash'))\r .catch(console.log);"],"params":[{"name":"splash","description":"The new splash screen of the guild","type":[[["Base64Resolvable"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":363,"file":"Guild.js","path":"src/structures"}},{"name":"member","description":"Returns the GuildMember form of a User object, if the User is present in the guild.","examples":["// get the guild member of a user\rconst member = guild.member(message.author);"],"params":[{"name":"user","description":"The user that you want to obtain the GuildMember of","type":[[["UserResolvable"]]]}],"returns":{"types":[[["GuildMember"]]],"nullable":true},"meta":{"line":375,"file":"Guild.js","path":"src/structures"}},{"name":"ban","description":"Bans a user from the guild.","examples":["// ban a user\rguild.ban('123123123123');"],"params":[{"name":"user","description":"The user to ban","type":[[["UserResolvable"]]]},{"name":"deleteDays","description":"The amount of days worth of messages from this user that should\ralso be deleted. Between `0` and `7`.","optional":true,"default":0,"type":[[["number"]]]}],"returns":[[["Promise",".<("],["GuildMember","|"],["User",")>"]]],"meta":{"line":389,"file":"Guild.js","path":"src/structures"}},{"name":"unban","description":"Unbans a user from the Guild.","examples":["// unban a user\rguild.unban('123123123123')\r .then(user => console.log(`Unbanned ${user.username} from ${guild.name}`))\r .catch(reject);"],"params":[{"name":"user","description":"The user to unban","type":[[["UserResolvable"]]]}],"returns":[[["Promise",".<"],["User",">"]]],"meta":{"line":403,"file":"Guild.js","path":"src/structures"}},{"name":"fetchBans","description":"Fetch a Collection of banned users in this Guild.","returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["User",">>"]]],"meta":{"line":411,"file":"Guild.js","path":"src/structures"}},{"name":"fetchInvites","description":"Fetch a Collection of invites to this Guild. Resolves with a Collection mapping invites by their codes.","returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Invite",">>"]]],"meta":{"line":419,"file":"Guild.js","path":"src/structures"}},{"name":"fetchMember","description":"Fetch a single guild member from a user.","params":[{"name":"user","description":"The user to fetch the member for","type":[[["UserResolvable"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":428,"file":"Guild.js","path":"src/structures"}},{"name":"fetchMembers","description":"Fetches all the members in the Guild, even if they are offline. If the Guild has less than 250 members,\rthis should not be necessary.","params":[{"name":"query","description":"An optional query to provide when fetching members","optional":true,"default":"''","type":[[["string"]]]}],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":442,"file":"Guild.js","path":"src/structures"}},{"name":"createChannel","description":"Creates a new Channel in the Guild.","examples":["// create a new text channel\rguild.createChannel('new general', 'text')\r .then(channel => console.log(`Created new channel ${channel}`))\r .catch(console.log);"],"params":[{"name":"name","description":"The name of the new channel","type":[[["string"]]]},{"name":"type","description":"The type of the new channel, either `text` or `voice`","type":[[["string"]]]}],"returns":[[["Promise",".<("],["TextChannel","|"],["VoiceChannel",")>"]]],"meta":{"line":474,"file":"Guild.js","path":"src/structures"}},{"name":"createRole","description":"Creates a new role in the guild, and optionally updates it with the given information.","examples":["// create a new role\rguild.createRole()\r .then(role => console.log(`Created role ${role}`))\r .catch(console.log);","// create a new role with data\rguild.createRole({ name: 'Super Cool People' })\r  .then(role => console.log(`Created role ${role}`))\r  .catch(console.log)"],"params":[{"name":"data","description":"The data to update the role with","optional":true,"type":[[["RoleData"]]]}],"returns":[[["Promise",".<"],["Role",">"]]],"meta":{"line":493,"file":"Guild.js","path":"src/structures"}},{"name":"leave","description":"Causes the Client to leave the guild.","examples":["// leave a guild\rguild.leave()\r .then(g => console.log(`Left the guild ${g}`))\r .catch(console.log);"],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":508,"file":"Guild.js","path":"src/structures"}},{"name":"delete","description":"Causes the Client to delete the guild.","examples":["// delete a guild\rguild.delete()\r .then(g => console.log(`Deleted the guild ${g}`))\r .catch(console.log);"],"returns":[[["Promise",".<"],["Guild",">"]]],"meta":{"line":521,"file":"Guild.js","path":"src/structures"}},{"name":"sync","description":"Syncs this guild (already done automatically every 30 seconds). Only applicable to user accounts.","meta":{"line":528,"file":"Guild.js","path":"src/structures"}},{"name":"equals","description":"Whether this Guild equals another Guild. It compares all properties, so for most operations\rit is advisable to just compare `guild.id === guild2.id` as it is much faster and is often\rwhat most users need.","params":[{"name":"guild","description":"The guild to compare","type":[[["Guild"]]]}],"returns":[[["boolean"]]],"meta":{"line":539,"file":"Guild.js","path":"src/structures"}},{"name":"toString","description":"When concatenated with a string, this automatically concatenates the Guild's name instead of the Guild object.","examples":["// logs: Hello from My Guild!\rconsole.log(`Hello from ${guild}!`);","// logs: Hello from My Guild!\rconsole.log(`Hello from ' + guild + '!');"],"returns":[[["string"]]],"meta":{"line":576,"file":"Guild.js","path":"src/structures"}}],"meta":{"line":15,"file":"Guild.js","path":"src/structures"}},{"name":"GuildChannel","description":"Represents a Guild Channel (i.e. Text Channels and Voice Channels)","extends":["Channel"],"props":[{"name":"guild","description":"The guild the channel is in","type":[[["Guild"]]],"meta":{"line":21,"file":"GuildChannel.js","path":"src/structures"}},{"name":"name","description":"The name of the Guild Channel","type":[[["string"]]],"meta":{"line":31,"file":"GuildChannel.js","path":"src/structures"}},{"name":"position","description":"The position of the channel in the list.","type":[[["number"]]],"meta":{"line":37,"file":"GuildChannel.js","path":"src/structures"}},{"name":"permissionOverwrites","description":"A map of permission overwrites in this channel for roles and users.","type":[[["Collection",".<"],["string",", "],["PermissionOverwrites",">"]]],"meta":{"line":43,"file":"GuildChannel.js","path":"src/structures"}},{"name":"client","description":"The client that instantiated the Channel","type":[[["Client"]]],"meta":{"line":10,"file":"Channel.js","path":"src/structures"}},{"name":"type","description":"The type of the channel, either:\r* `dm` - a DM channel\r* `group` - a Group DM channel\r* `text` - a guild text channel\r* `voice` - a guild voice channel","type":[[["string"]]],"meta":{"line":21,"file":"Channel.js","path":"src/structures"}},{"name":"id","description":"The unique ID of the channel","type":[[["string"]]],"meta":{"line":31,"file":"Channel.js","path":"src/structures"}},{"name":"creationDate","description":"The time the channel was created","readonly":true,"type":[[["Date"]]],"meta":{"line":39,"file":"Channel.js","path":"src/structures"}}],"methods":[{"name":"permissionsFor","description":"Gets the overall set of permissions for a user in this channel, taking into account roles and permission\roverwrites.","params":[{"name":"member","description":"The user that you want to obtain the overall permissions for","type":[[["GuildMemberResolvable"]]]}],"returns":{"types":[[["EvaluatedPermissions"]]],"nullable":true},"meta":{"line":57,"file":"GuildChannel.js","path":"src/structures"}},{"name":"overwritePermissions","description":"Overwrites the permissions for a user or role in this channel.","examples":["// overwrite permissions for a message author\rmessage.channel.overwritePermissions(message.author, {\r SEND_MESSAGES: false\r})\r.then(() => console.log('Done!'))\r.catch(console.log);"],"params":[{"name":"userOrRole","description":"The user or role to update","type":[[["Role"]],[["UserResolvable"]]]},{"name":"options","description":"The configuration for the update","type":[[["PermissionOverwriteOptions"]]]}],"returns":[[["Promise"]]],"meta":{"line":125,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setName","description":"Set a new name for the Guild Channel","examples":["// set a new channel name\rchannel.setName('not general')\r .then(newChannel => console.log(`Channel's new name is ${newChannel.name}`))\r .catch(console.log);"],"params":[{"name":"name","description":"The new name for the guild channel","type":[[["string"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":175,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setPosition","description":"Set a new position for the Guild Channel","examples":["// set a new channel position\rchannel.setPosition(2)\r .then(newChannel => console.log(`Channel's new position is ${newChannel.position}`))\r .catch(console.log);"],"params":[{"name":"position","description":"The new position for the guild channel","type":[[["number"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":189,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setTopic","description":"Set a new topic for the Guild Channel","examples":["// set a new channel topic\rchannel.setTopic('needs more rate limiting')\r .then(newChannel => console.log(`Channel's new topic is ${newChannel.topic}`))\r .catch(console.log);"],"params":[{"name":"topic","description":"The new topic for the guild channel","type":[[["string"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":203,"file":"GuildChannel.js","path":"src/structures"}},{"name":"createInvite","description":"Create an invite to this Guild Channel","params":[{"name":"options","description":"The options for the invite","optional":true,"default":"{}","type":[[["InviteOptions"]]]}],"returns":[[["Promise",".<"],["Invite",">"]]],"meta":{"line":224,"file":"GuildChannel.js","path":"src/structures"}},{"name":"equals","description":"Checks if this channel has the same type, topic, position, name, overwrites and ID as another channel.\rIn most cases, a simple `channel.id === channel2.id` will do, and is much faster too.","params":[{"name":"channel","description":"The channel to compare this channel to","type":[[["GuildChannel"]]]}],"returns":[[["boolean"]]],"meta":{"line":234,"file":"GuildChannel.js","path":"src/structures"}},{"name":"toString","description":"When concatenated with a string, this automatically returns the Channel's mention instead of the Channel object.","examples":["// Outputs: Hello from #general\rconsole.log(`Hello from ${channel}`);","// Outputs: Hello from #general\rconsole.log('Hello from ' + channel);"],"returns":[[["string"]]],"meta":{"line":265,"file":"GuildChannel.js","path":"src/structures"}},{"name":"delete","description":"Deletes the channel","inherits":"Channel#delete","inherited":true,"examples":["// delete the channel\rchannel.delete()\r .then() // success\r .catch(console.log); // log error"],"returns":[[["Promise",".<"],["Channel",">"]]],"meta":{"line":52,"file":"Channel.js","path":"src/structures"}}],"meta":{"line":13,"file":"GuildChannel.js","path":"src/structures"}},{"name":"GuildMember","description":"Represents a Member of a Guild on Discord","props":[{"name":"client","description":"The client that instantiated this GuildMember","type":[[["Client"]]],"meta":{"line":17,"file":"GuildMember.js","path":"src/structures"}},{"name":"guild","description":"The guild that this member is part of","type":[[["Guild"]]],"meta":{"line":24,"file":"GuildMember.js","path":"src/structures"}},{"name":"user","description":"The user that this guild member instance Represents","type":[[["User"]]],"meta":{"line":30,"file":"GuildMember.js","path":"src/structures"}},{"name":"serverDeaf","description":"Whether this member is deafened server-wide","type":[[["boolean"]]],"meta":{"line":41,"file":"GuildMember.js","path":"src/structures"}},{"name":"serverMute","description":"Whether this member is muted server-wide","type":[[["boolean"]]],"meta":{"line":47,"file":"GuildMember.js","path":"src/structures"}},{"name":"selfMute","description":"Whether this member is self-muted","type":[[["boolean"]]],"meta":{"line":53,"file":"GuildMember.js","path":"src/structures"}},{"name":"selfDeaf","description":"Whether this member is self-deafened","type":[[["boolean"]]],"meta":{"line":59,"file":"GuildMember.js","path":"src/structures"}},{"name":"voiceSessionID","description":"The voice session ID of this member, if any","nullable":true,"type":[[["string"]]],"meta":{"line":65,"file":"GuildMember.js","path":"src/structures"}},{"name":"voiceChannelID","description":"The voice channel ID of this member, if any","nullable":true,"type":[[["string"]]],"meta":{"line":71,"file":"GuildMember.js","path":"src/structures"}},{"name":"speaking","description":"Whether this meember is speaking","nullable":true,"type":[[["boolean"]]],"meta":{"line":77,"file":"GuildMember.js","path":"src/structures"}},{"name":"nickname","description":"The nickname of this Guild Member, if they have one","nullable":true,"type":[[["string"]]],"meta":{"line":83,"file":"GuildMember.js","path":"src/structures"}},{"name":"joinDate","description":"The date this member joined the guild","type":[[["Date"]]],"meta":{"line":94,"file":"GuildMember.js","path":"src/structures"}},{"name":"roles","description":"A list of roles that are applied to this GuildMember, mapped by the role ID.","readonly":true,"type":[[["Collection",".<"],["string",", "],["Role",">"]]],"meta":{"line":103,"file":"GuildMember.js","path":"src/structures"}},{"name":"mute","description":"Whether this member is muted in any way","readonly":true,"type":[[["boolean"]]],"meta":{"line":122,"file":"GuildMember.js","path":"src/structures"}},{"name":"deaf","description":"Whether this member is deafened in any way","readonly":true,"type":[[["boolean"]]],"meta":{"line":131,"file":"GuildMember.js","path":"src/structures"}},{"name":"voiceChannel","description":"The voice channel this member is in, if any","readonly":true,"nullable":true,"type":[[["VoiceChannel"]]],"meta":{"line":140,"file":"GuildMember.js","path":"src/structures"}},{"name":"id","description":"The ID of this User","readonly":true,"type":[[["string"]]],"meta":{"line":149,"file":"GuildMember.js","path":"src/structures"}},{"name":"permissions","description":"The overall set of permissions for the guild member, taking only roles into account","type":[[["EvaluatedPermissions"]]],"meta":{"line":157,"file":"GuildMember.js","path":"src/structures"}}],"methods":[{"name":"hasPermission","description":"Checks if any of the member's roles have a permission","params":[{"name":"permission","description":"The permission to check for","type":[[["PermissionResolvable"]]]},{"name":"explicit","description":"Whether to require the roles to explicitly have the exact permission","optional":true,"default":false,"type":[[["boolean"]]]}],"returns":[[["boolean"]]],"meta":{"line":176,"file":"GuildMember.js","path":"src/structures"}},{"name":"setMute","description":"Mute/unmute a user","params":[{"name":"mute","description":"Whether or not the member should be muted","type":[[["boolean"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":185,"file":"GuildMember.js","path":"src/structures"}},{"name":"setDeaf","description":"Deafen/undeafen a user","params":[{"name":"deaf","description":"Whether or not the member should be deafened","type":[[["boolean"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":194,"file":"GuildMember.js","path":"src/structures"}},{"name":"setVoiceChannel","description":"Moves the Guild Member to the given channel.","params":[{"name":"channel","description":"The channel to move the member to","type":[[["ChannelResolvable"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":203,"file":"GuildMember.js","path":"src/structures"}},{"name":"setRoles","description":"Sets the Roles applied to the member.","params":[{"name":"roles","description":"The roles or role IDs to apply","type":[[["Collection",".<"],["string",", "],["Role",">"]],[["Array",".<"],["Role",">"]],[["Array",".<"],["string",">"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":212,"file":"GuildMember.js","path":"src/structures"}},{"name":"addRole","description":"Adds a single Role to the member.","params":[{"name":"role","description":"The role or ID of the role to add","type":[[["Role"]],[["string"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":221,"file":"GuildMember.js","path":"src/structures"}},{"name":"addRoles","description":"Adds multiple roles to the member.","params":[{"name":"roles","description":"The roles or role IDs to add","type":[[["Collection",".<"],["string",", "],["Role",">"]],[["Array",".<"],["Role",">"]],[["Array",".<"],["string",">"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":230,"file":"GuildMember.js","path":"src/structures"}},{"name":"removeRole","description":"Removes a single Role from the member.","params":[{"name":"role","description":"The role or ID of the role to remove","type":[[["Role"]],[["string"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":246,"file":"GuildMember.js","path":"src/structures"}},{"name":"removeRoles","description":"Removes multiple roles from the member.","params":[{"name":"roles","description":"The roles or role IDs to remove","type":[[["Collection",".<"],["string",", "],["Role",">"]],[["Array",".<"],["Role",">"]],[["Array",".<"],["string",">"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":255,"file":"GuildMember.js","path":"src/structures"}},{"name":"setNickname","description":"Set the nickname for the Guild Member","params":[{"name":"nick","description":"The nickname for the Guild Member","type":[[["string"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":276,"file":"GuildMember.js","path":"src/structures"}},{"name":"edit","description":"Edit a Guild Member","params":[{"name":"data","description":"The data to edit the member with","type":[[["GuildmemberEditData"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":285,"file":"GuildMember.js","path":"src/structures"}},{"name":"deleteDM","description":"Deletes any DMs with this Guild Member","returns":[[["Promise",".<"],["DMChannel",">"]]],"meta":{"line":293,"file":"GuildMember.js","path":"src/structures"}},{"name":"kick","description":"Kick this member from the Guild","returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":301,"file":"GuildMember.js","path":"src/structures"}},{"name":"ban","description":"Ban this Guild Member","examples":["// ban a guild member\rguildMember.ban(7);"],"params":[{"name":"deleteDays","description":"The amount of days worth of messages from this member that should\ralso be deleted. Between `0` and `7`.","optional":true,"default":0,"type":[[["number"]]]}],"returns":[[["Promise",".<"],["GuildMember",">"]]],"meta":{"line":314,"file":"GuildMember.js","path":"src/structures"}},{"name":"sendMessage","description":"Send a message to this channel","implements":["TextBasedChannel#sendMessage"],"examples":["// send a message\rchannel.sendMessage('hello!')\r .then(message => console.log(`Sent message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":48,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendTTSMessage","description":"Send a text-to-speech message to this channel","implements":["TextBasedChannel#sendTTSMessage"],"examples":["// send a TTS message\rchannel.sendTTSMessage('hello!')\r .then(message => console.log(`Sent tts message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":63,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendFile","description":"Send a file to this channel","implements":["TextBasedChannel#sendFile"],"params":[{"name":"attachment","description":"The file to send","type":[[["FileResolvable"]]]},{"name":"fileName","description":"The name and extension of the file","optional":true,"default":"\"file.jpg\"","type":[[["string"]]]},{"name":"content","description":"Text message to send with the attachment","optional":true,"type":[[["StringResolvable"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":74,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"meta":{"line":11,"file":"GuildMember.js","path":"src/structures"}},{"name":"MessageCollector","description":"Collects messages based on a specified filter, then emits them.","extends":["EventEmitter"],"construct":{"name":"MessageCollector","params":[{"name":"channel","description":"The channel to collect messages in","type":[[["Channel"]]]},{"name":"filter","description":"The filter function","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"Options for the collector","optional":true,"type":[[["CollectorOptions"]]]}]},"props":[{"name":"channel","description":"The channel this collector is operating on","type":[[["Channel"]]],"meta":{"line":353,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"filter","description":"A function used to filter messages that the collector collects.","type":[[["CollectorFilterFunction"]]],"meta":{"line":359,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"options","description":"Options for the collecor.","type":[[["CollectorOptions"]]],"meta":{"line":365,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"ended","description":"Whether this collector has stopped collecting Messages.","type":[[["boolean"]]],"meta":{"line":371,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"collected","description":"A collection of collected messages, mapped by message ID.","type":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":377,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"methods":[{"name":"verify","description":"Verifies a message against the filter and options","access":"private","params":[{"name":"message","description":"The message","type":[[["Message"]]]}],"returns":[[["boolean"]]],"meta":{"line":390,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"stop","description":"Stops the collector and emits `end`.","params":[{"name":"reason","description":"An optional reason for stopping the collector","optional":true,"default":"'user'","type":[[["string"]]]}],"meta":{"line":411,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"events":[{"name":"message","description":"Emitted whenever the Collector receives a Message that passes the filter test.","params":[{"name":"message","description":"The received message","type":[[["Message"]]]},{"name":"collector","description":"The collector the message passed through","type":[[["MessageCollector"]]]}],"meta":{"line":394,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"end","description":"Emitted when the Collector stops collecting.","params":[{"name":"collection","description":"A collection of messages collected\rduring the lifetime of the Collector, mapped by the ID of the Messages.","type":[[["Collection",".<"],["string",", "],["Message",">"]]]},{"name":"reason","description":"The reason for the end of the collector. If it ended because it reached the specified time\rlimit, this would be `time`. If you invoke `.stop()` without specifying a reason, this would be `user`. If it\rended because it reached its message limit, it will be `limit`.","type":[[["string"]]]}],"meta":{"line":415,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"meta":{"line":316,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"Invite","description":"Represents an Invitation to a Guild Channel","props":[{"name":"client","description":"The client that instantiated the invite","type":[[["Client"]]],"meta":{"line":34,"file":"Invite.js","path":"src/structures"}},{"name":"guild","description":"The Guild the invite is for. If this Guild is already known, this will be a Guild object. If the Guild is\runknown, this will be a Partial Guild.","type":[[["Guild"]],[["PartialGuild"]]],"meta":{"line":46,"file":"Invite.js","path":"src/structures"}},{"name":"code","description":"The code for this invite","type":[[["string"]]],"meta":{"line":52,"file":"Invite.js","path":"src/structures"}},{"name":"temporary","description":"Whether or not this invite is temporary","type":[[["boolean"]]],"meta":{"line":58,"file":"Invite.js","path":"src/structures"}},{"name":"maxAge","description":"The maximum age of the invite, in seconds","nullable":true,"type":[[["number"]]],"meta":{"line":64,"file":"Invite.js","path":"src/structures"}},{"name":"uses","description":"How many times this invite has been used","type":[[["number"]]],"meta":{"line":70,"file":"Invite.js","path":"src/structures"}},{"name":"maxUses","description":"The maximum uses of this invite","type":[[["number"]]],"meta":{"line":76,"file":"Invite.js","path":"src/structures"}},{"name":"inviter","description":"The user who created this invite","type":[[["User"]]],"meta":{"line":82,"file":"Invite.js","path":"src/structures"}},{"name":"channel","description":"The Channel the invite is for. If this Channel is already known, this will be a GuildChannel object.\rIf the Channel is unknown, this will be a Partial Guild Channel.","type":[[["GuildChannel"]],[["PartialGuildChannel"]]],"meta":{"line":89,"file":"Invite.js","path":"src/structures"}},{"name":"createdAt","description":"The creation date of the invite","type":[[["Date"]]],"meta":{"line":98,"file":"Invite.js","path":"src/structures"}},{"name":"creationDate","description":"The creation date of the invite","type":[[["Date"]]],"meta":{"line":106,"file":"Invite.js","path":"src/structures"}}],"methods":[{"name":"delete","description":"Deletes this invite","returns":[[["Promise",".<"],["Invite",">"]]],"meta":{"line":114,"file":"Invite.js","path":"src/structures"}}],"meta":{"line":28,"file":"Invite.js","path":"src/structures"}},{"name":"Message","description":"Represents a Message on Discord","props":[{"name":"client","description":"The client that instantiated the Message","type":[[["Client"]]],"meta":{"line":14,"file":"Message.js","path":"src/structures"}},{"name":"channel","description":"The channel that the message was sent in","type":[[["TextChannel"]],[["DMChannel"]],[["GroupDMChannel"]]],"meta":{"line":21,"file":"Message.js","path":"src/structures"}},{"name":"guild","description":"If the message was sent in a guild, this will be the guild the message was sent in","nullable":true,"type":[[["Guild"]]],"meta":{"line":27,"file":"Message.js","path":"src/structures"}},{"name":"id","description":"The ID of the message (unique in the channel it was sent)","type":[[["string"]]],"meta":{"line":37,"file":"Message.js","path":"src/structures"}},{"name":"content","description":"The content of the message","type":[[["string"]]],"meta":{"line":43,"file":"Message.js","path":"src/structures"}},{"name":"author","description":"The author of the message","type":[[["User"]]],"meta":{"line":49,"file":"Message.js","path":"src/structures"}},{"name":"member","description":"Represents the Author of the message as a Guild Member. Only available if the message comes from a Guild\rwhere the author is still a member.","type":[[["GuildMember"]]],"meta":{"line":56,"file":"Message.js","path":"src/structures"}},{"name":"pinned","description":"Whether or not this message is pinned","type":[[["boolean"]]],"meta":{"line":62,"file":"Message.js","path":"src/structures"}},{"name":"tts","description":"Whether or not the message was Text-To-Speech","type":[[["boolean"]]],"meta":{"line":68,"file":"Message.js","path":"src/structures"}},{"name":"nonce","description":"A random number used for checking message delivery","type":[[["string"]]],"meta":{"line":74,"file":"Message.js","path":"src/structures"}},{"name":"system","description":"Whether or not this message was sent by Discord, not actually a user (e.g. pin notifications)","type":[[["boolean"]]],"meta":{"line":80,"file":"Message.js","path":"src/structures"}},{"name":"embeds","description":"A list of embeds in the message - e.g. YouTube Player","type":[[["Array",".<"],["Embed",">"]]],"meta":{"line":86,"file":"Message.js","path":"src/structures"}},{"name":"attachments","description":"A collection of attachments in the message - e.g. Pictures - mapped by their ID.","type":[[["Collection",".<"],["string",", "],["MessageAttachment",">"]]],"meta":{"line":92,"file":"Message.js","path":"src/structures"}},{"name":"mentions","description":"An object containing a further users, roles or channels collections","type":[[["Object"]]],"props":[{"name":"mentions.users","description":"Mentioned users, maps their ID to the user object.","type":[[["Collection",".<"],["string",", "],["User",">"]]]},{"name":"mentions.roles","description":"Mentioned roles, maps their ID to the role object.","type":[[["Collection",".<"],["string",", "],["Role",">"]]]},{"name":"mentions.channels","description":"Mentioned channels,\rmaps their ID to the channel object.","type":[[["Collection",".<"],["string",", "],["GuildChannel",">"]]]},{"name":"mentions.everyone","description":"Whether or not @everyone was mentioned.","type":[[["boolean"]]]}],"meta":{"line":104,"file":"Message.js","path":"src/structures"}},{"name":"timestamp","description":"When the message was sent","type":[[["Date"]]],"meta":{"line":145,"file":"Message.js","path":"src/structures"}},{"name":"editedTimestamp","description":"If the message was edited, the timestamp at which it was last edited","nullable":true,"type":[[["Date"]]],"meta":{"line":153,"file":"Message.js","path":"src/structures"}},{"name":"cleanContent","description":"The message contents with all mentions replaced by the equivalent text.","type":[[["string"]]],"meta":{"line":161,"file":"Message.js","path":"src/structures"}},{"name":"edits","description":"An array of cached versions of the message, including the current version.\rSorted from latest (first) to oldest (last).","type":[[["Array",".<"],["Message",">"]]],"meta":{"line":194,"file":"Message.js","path":"src/structures"}}],"methods":[{"name":"delete","description":"Deletes the message","examples":["// delete a message\rmessage.delete()\r .then(msg => console.log(`Deleted message from ${msg.author}`))\r .catch(console.log);"],"params":[{"name":"timeout","description":"How long to wait to delete the message in milliseconds","optional":true,"default":0,"type":[[["number"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":265,"file":"Message.js","path":"src/structures"}},{"name":"edit","description":"Edit the content of a message","examples":["// update the content of a message\rmessage.edit('This is my new content!')\r .then(msg => console.log(`Updated the content of a message from ${msg.author}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The new content for the message","type":[[["StringResolvable"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":285,"file":"Message.js","path":"src/structures"}},{"name":"reply","description":"Reply to a message","examples":["// reply to a message\rmessage.reply('Hey, I'm a reply!')\r .then(msg => console.log(`Sent a reply to ${msg.author}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content for the message","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":300,"file":"Message.js","path":"src/structures"}},{"name":"isMentioned","description":"Whether or not a user, channel or role is mentioned in this message.","params":[{"name":"data","description":"either a guild channel, user or a role object, or a string representing\rthe ID of any of these.","type":[[["GuildChannel"]],[["User"]],[["Role"]],[["string"]]]}],"returns":[[["boolean"]]],"meta":{"line":312,"file":"Message.js","path":"src/structures"}},{"name":"pin","description":"Pins this message to the channel's pinned messages","returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":321,"file":"Message.js","path":"src/structures"}},{"name":"unpin","description":"Unpins this message from the channel's pinned messages","returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":329,"file":"Message.js","path":"src/structures"}},{"name":"equals","description":"Used mainly internally. Whether two messages are identical in properties. If you want to compare messages\rwithout checking all the properties, use `message.id === message2.id`, which is much more efficient. This\rmethod allows you to see if there are differences in content, embeds, attachments, nonce and tts properties.","params":[{"name":"message","description":"The message to compare it to","type":[[["Message"]]]},{"name":"rawData","description":"Raw data passed through the WebSocket about this message","type":[[["Object"]]]}],"returns":[[["boolean"]]],"meta":{"line":341,"file":"Message.js","path":"src/structures"}}],"meta":{"line":8,"file":"Message.js","path":"src/structures"}},{"name":"MessageAttachment","description":"Represents an Attachment in a Message","props":[{"name":"client","description":"The Client that instantiated this Message.","type":[[["Client"]]],"meta":{"line":10,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"message","description":"The message this attachment is part of.","type":[[["Message"]]],"meta":{"line":17,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"id","description":"The ID of this attachment","type":[[["string"]]],"meta":{"line":27,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"filename","description":"The file name of this attachment","type":[[["string"]]],"meta":{"line":33,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"filesize","description":"The size of this attachment in bytes","type":[[["number"]]],"meta":{"line":39,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"url","description":"The URL to this attachment","type":[[["string"]]],"meta":{"line":45,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"proxyURL","description":"The Proxy URL to this attachment","type":[[["string"]]],"meta":{"line":51,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"height","description":"The height of this attachment (if an image)","nullable":true,"type":[[["number"]]],"meta":{"line":57,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"width","description":"The width of this attachment (if an image)","nullable":true,"type":[[["number"]]],"meta":{"line":63,"file":"MessageAttachment.js","path":"src/structures"}}],"meta":{"line":4,"file":"MessageAttachment.js","path":"src/structures"}},{"name":"MessageEmbed","description":"Represents an embed in an image - e.g. preview of image","props":[{"name":"client","description":"The client that instantiated this embed","type":[[["Client"]]],"meta":{"line":10,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"message","description":"The message this embed is part of","type":[[["Message"]]],"meta":{"line":17,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"title","description":"The title of this embed, if there is one","nullable":true,"type":[[["string"]]],"meta":{"line":27,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"type","description":"The type of this embed","type":[[["string"]]],"meta":{"line":33,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"description","description":"The description of this embed, if there is one","nullable":true,"type":[[["string"]]],"meta":{"line":39,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"url","description":"The URL of this embed","type":[[["string"]]],"meta":{"line":45,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"thumbnail","description":"The thumbnail of this embed, if there is one","type":[[["MessageEmbedThumbnail"]]],"meta":{"line":51,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"author","description":"The author of this embed, if there is one","type":[[["MessageEmbedAuthor"]]],"meta":{"line":57,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"provider","description":"The provider of this embed, if there is one","type":[[["MessageEmbedProvider"]]],"meta":{"line":63,"file":"MessageEmbed.js","path":"src/structures"}}],"meta":{"line":4,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"MessageEmbedThumbnail","description":"Represents a thumbnail for a Message embed","props":[{"name":"embed","description":"The embed this thumbnail is part of","type":[[["MessageEmbed"]]],"meta":{"line":76,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"url","description":"The URL for this thumbnail","type":[[["string"]]],"meta":{"line":86,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"proxyURL","description":"The Proxy URL for this thumbnail","type":[[["string"]]],"meta":{"line":92,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"height","description":"The height of the thumbnail","type":[[["number"]]],"meta":{"line":98,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"width","description":"The width of the thumbnail","type":[[["number"]]],"meta":{"line":104,"file":"MessageEmbed.js","path":"src/structures"}}],"meta":{"line":70,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"MessageEmbedProvider","description":"Represents a Provider for a Message embed","props":[{"name":"embed","description":"The embed this provider is part of","type":[[["MessageEmbed"]]],"meta":{"line":117,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"name","description":"The name of this provider","type":[[["string"]]],"meta":{"line":127,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"url","description":"The URL of this provider","type":[[["string"]]],"meta":{"line":133,"file":"MessageEmbed.js","path":"src/structures"}}],"meta":{"line":111,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"MessageEmbedAuthor","description":"Represents a Author for a Message embed","props":[{"name":"embed","description":"The embed this author is part of","type":[[["MessageEmbed"]]],"meta":{"line":146,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"name","description":"The name of this author","type":[[["string"]]],"meta":{"line":156,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"url","description":"The URL of this author","type":[[["string"]]],"meta":{"line":162,"file":"MessageEmbed.js","path":"src/structures"}}],"meta":{"line":140,"file":"MessageEmbed.js","path":"src/structures"}},{"name":"PartialGuild","description":"Represents a Guild that the client only has limited information for - e.g. from invites.","props":[{"name":"client","description":"The client that instantiated this PartialGuild","type":[[["Client"]]],"meta":{"line":17,"file":"PartialGuild.js","path":"src/structures"}},{"name":"id","description":"The ID of this guild","type":[[["string"]]],"meta":{"line":28,"file":"PartialGuild.js","path":"src/structures"}},{"name":"name","description":"The name of this guild","type":[[["string"]]],"meta":{"line":34,"file":"PartialGuild.js","path":"src/structures"}},{"name":"icon","description":"The hash of this guild's icon, or null if there is none.","nullable":true,"type":[[["string"]]],"meta":{"line":40,"file":"PartialGuild.js","path":"src/structures"}},{"name":"splash","description":"The hash of the guild splash image, or null if no splash (VIP only)","nullable":true,"type":[[["string"]]],"meta":{"line":46,"file":"PartialGuild.js","path":"src/structures"}}],"meta":{"line":11,"file":"PartialGuild.js","path":"src/structures"}},{"name":"PartialGuildChannel","description":"Represents a Guild Channel that the client only has limited information for - e.g. from invites.","props":[{"name":"client","description":"The client that instantiated this PartialGuildChannel","type":[[["Client"]]],"meta":{"line":16,"file":"PartialGuildChannel.js","path":"src/structures"}},{"name":"id","description":"The ID of this Guild Channel","type":[[["string"]]],"meta":{"line":27,"file":"PartialGuildChannel.js","path":"src/structures"}},{"name":"name","description":"The name of this Guild Channel","type":[[["string"]]],"meta":{"line":33,"file":"PartialGuildChannel.js","path":"src/structures"}},{"name":"type","description":"The type of this Guild Channel - `text` or `voice`","type":[[["string"]]],"meta":{"line":39,"file":"PartialGuildChannel.js","path":"src/structures"}}],"meta":{"line":10,"file":"PartialGuildChannel.js","path":"src/structures"}},{"name":"PermissionOverwrites","description":"Represents a permission overwrite for a Role or Member in a Guild Channel.","props":[{"name":"channel","description":"The GuildChannel this overwrite is for","type":[[["GuildChannel"]]],"meta":{"line":10,"file":"PermissionOverwrites.js","path":"src/structures"}},{"name":"id","description":"The ID of this overwrite, either a User ID or a Role ID","type":[[["string"]]],"meta":{"line":20,"file":"PermissionOverwrites.js","path":"src/structures"}},{"name":"type","description":"The type of this overwrite","type":[[["string"]]],"meta":{"line":26,"file":"PermissionOverwrites.js","path":"src/structures"}}],"methods":[{"name":"delete","description":"Delete this Permission Overwrite.","returns":[[["Promise",".<"],["PermissionOverwrites",">"]]],"meta":{"line":36,"file":"PermissionOverwrites.js","path":"src/structures"}}],"meta":{"line":4,"file":"PermissionOverwrites.js","path":"src/structures"}},{"name":"Role","description":"Represents a Role on Discord","props":[{"name":"client","description":"The client that instantiated the role","type":[[["Client"]]],"meta":{"line":12,"file":"Role.js","path":"src/structures"}},{"name":"guild","description":"The guild that the role belongs to","type":[[["Guild"]]],"meta":{"line":19,"file":"Role.js","path":"src/structures"}},{"name":"id","description":"The ID of the role (unique to the guild it is part of)","type":[[["string"]]],"meta":{"line":29,"file":"Role.js","path":"src/structures"}},{"name":"name","description":"The name of the role","type":[[["string"]]],"meta":{"line":35,"file":"Role.js","path":"src/structures"}},{"name":"color","description":"The base 10 color of the role","type":[[["number"]]],"meta":{"line":41,"file":"Role.js","path":"src/structures"}},{"name":"hoist","description":"If true, users that are part of this role will appear in a separate category in the users list","type":[[["boolean"]]],"meta":{"line":47,"file":"Role.js","path":"src/structures"}},{"name":"position","description":"The position of the role in the role manager","type":[[["number"]]],"meta":{"line":53,"file":"Role.js","path":"src/structures"}},{"name":"permissions","description":"The evaluated permissions number","type":[[["number"]]],"meta":{"line":59,"file":"Role.js","path":"src/structures"}},{"name":"managed","description":"Whether or not the role is managed by an external service","type":[[["boolean"]]],"meta":{"line":65,"file":"Role.js","path":"src/structures"}},{"name":"creationDate","description":"The time the role was created","readonly":true,"type":[[["Date"]]],"meta":{"line":73,"file":"Role.js","path":"src/structures"}},{"name":"hexColor","description":"The hexadecimal version of the role color, with a leading hashtag.","readonly":true,"type":[[["string"]]],"meta":{"line":213,"file":"Role.js","path":"src/structures"}}],"methods":[{"name":"delete","description":"Deletes the role","examples":["// delete a role\rrole.delete()\r .then(r => console.log(`Deleted role ${r}`))\r .catch(console.log);"],"returns":[[["Promise",".<"],["Role",">"]]],"meta":{"line":86,"file":"Role.js","path":"src/structures"}},{"name":"edit","description":"Edits the role","examples":["// edit a role\rrole.edit({name: 'new role'})\r .then(r => console.log(`Edited role ${r}`))\r .catch(console.log);"],"params":[{"name":"data","description":"The new data for the role","type":[[["RoleData"]]]}],"returns":[[["Promise",".<"],["Role",">"]]],"meta":{"line":100,"file":"Role.js","path":"src/structures"}},{"name":"setName","description":"Set a new name for the role","examples":["// set the name of the role\rrole.setName('new role')\r .then(r => console.log(`Edited name of role ${r}`))\r .catch(console.log);"],"params":[{"name":"name","description":"The new name of the role","type":[[["string"]]]}],"returns":[[["Promise",".<"],["Role",">"]]],"meta":{"line":114,"file":"Role.js","path":"src/structures"}},{"name":"setColor","description":"Set a new color for the role","examples":["// set the color of a role\rrole.setColor('#FF0000')\r .then(r => console.log(`Set color of role ${r}`))\r .catch(console.log);"],"params":[{"name":"color","description":"The new color for the role, either a hex string or a base 10 number","type":[[["number"]],[["string"]]]}],"returns":[[["Promise",".<"],["Role",">"]]],"meta":{"line":128,"file":"Role.js","path":"src/structures"}},{"name":"setHoist","description":"Set whether or not the role should be hoisted","examples":["// set the hoist of the role\rrole.setHoist(true)\r .then(r => console.log(`Role hoisted: ${r.hoist}`))\r .catch(console.log);"],"params":[{"name":"hoist","description":"Whether or not to hoist the role","type":[[["boolean"]]]}],"returns":[[["Promise",".<"],["Role",">"]]],"meta":{"line":142,"file":"Role.js","path":"src/structures"}},{"name":"setPosition","description":"Set the position of the role","examples":["// set the position of the role\rrole.setPosition(1)\r .then(r => console.log(`Role position: ${r.position}`))\r .catch(console.log);"],"params":[{"name":"position","description":"The position of the role","type":[[["number"]]]}],"returns":[[["Promise",".<"],["Role",">"]]],"meta":{"line":156,"file":"Role.js","path":"src/structures"}},{"name":"setPermissions","description":"Set the permissions of the role","examples":["// set the permissions of the role\rrole.setPermissions(['KICK_MEMBERS', 'BAN_MEMBERS'])\r .then(r => console.log(`Role updated ${r}`))\r .catch(console.log);"],"params":[{"name":"permissions","description":"The permissions of the role","type":[[["Array",".<"],["string",">"]]]}],"returns":[[["Promise",".<"],["Role",">"]]],"meta":{"line":170,"file":"Role.js","path":"src/structures"}},{"name":"serialize","description":"Get an object mapping permission names to whether or not the role enables that permission","examples":["// print the serialized role\rconsole.log(role.serialize());"],"returns":[[["Object",".<"],["string",", "],["boolean",">"]]],"meta":{"line":181,"file":"Role.js","path":"src/structures"}},{"name":"hasPermission","description":"Whether or not the role includes the given permission","examples":["// see if a role can ban a member\rif (role.hasPermission('BAN_MEMBERS')) {\r  console.log('This role can ban members');\r} else {\r  console.log('This role can\\'t ban members');\r}"],"params":[{"name":"permission","description":"The name of the permission to test","type":[[["PermissionResolvable"]]]},{"name":"explicit","description":"Whether to require the role to explicitly have the exact permission","optional":true,"default":false,"type":[[["boolean"]]]}],"returns":[[["boolean"]]],"meta":{"line":202,"file":"Role.js","path":"src/structures"}},{"name":"equals","description":"Whether this role equals another role. It compares all properties, so for most operations\rit is advisable to just compare `role.id === role2.id` as it is much faster and is often\rwhat most users need.","params":[{"name":"role","description":"The role to compare to","type":[[["Role"]]]}],"returns":[[["boolean"]]],"meta":{"line":226,"file":"Role.js","path":"src/structures"}},{"name":"toString","description":"When concatenated with a string, this automatically concatenates the Role mention rather than the Role object.","returns":[[["string"]]],"meta":{"line":241,"file":"Role.js","path":"src/structures"}}],"meta":{"line":6,"file":"Role.js","path":"src/structures"}},{"name":"TextChannel","description":"Represents a Server Text Channel on Discord.","extends":["GuildChannel"],"props":[{"name":"topic","description":"The topic of the Text Channel, if there is one.","nullable":true,"type":[[["string"]]],"meta":{"line":23,"file":"TextChannel.js","path":"src/structures"}},{"name":"messages","description":"A Collection containing the messages sent to this channel.","type":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":16,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"lastMessageID","description":"The ID of the last message in the channel, if one was sent.","nullable":true,"type":[[["string"]]],"meta":{"line":22,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"typing","description":"Whether or not the typing indicator is being shown in the channel.","type":[[["boolean"]]],"meta":{"line":222,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"typingCount","description":"Number of times `startTyping` has been called.","type":[[["number"]]],"meta":{"line":230,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"guild","description":"The guild the channel is in","type":[[["Guild"]]],"meta":{"line":21,"file":"GuildChannel.js","path":"src/structures"}},{"name":"name","description":"The name of the Guild Channel","type":[[["string"]]],"meta":{"line":31,"file":"GuildChannel.js","path":"src/structures"}},{"name":"position","description":"The position of the channel in the list.","type":[[["number"]]],"meta":{"line":37,"file":"GuildChannel.js","path":"src/structures"}},{"name":"permissionOverwrites","description":"A map of permission overwrites in this channel for roles and users.","type":[[["Collection",".<"],["string",", "],["PermissionOverwrites",">"]]],"meta":{"line":43,"file":"GuildChannel.js","path":"src/structures"}}],"methods":[{"name":"sendMessage","description":"Send a message to this channel","implements":["TextBasedChannel#sendMessage"],"examples":["// send a message\rchannel.sendMessage('hello!')\r .then(message => console.log(`Sent message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":48,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendTTSMessage","description":"Send a text-to-speech message to this channel","implements":["TextBasedChannel#sendTTSMessage"],"examples":["// send a TTS message\rchannel.sendTTSMessage('hello!')\r .then(message => console.log(`Sent tts message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":63,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendFile","description":"Send a file to this channel","implements":["TextBasedChannel#sendFile"],"params":[{"name":"attachment","description":"The file to send","type":[[["FileResolvable"]]]},{"name":"fileName","description":"The name and extension of the file","optional":true,"default":"\"file.jpg\"","type":[[["string"]]]},{"name":"content","description":"Text message to send with the attachment","optional":true,"type":[[["StringResolvable"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":74,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchMessage","description":"Gets a single message from this channel, regardless of it being cached or not.","implements":["TextBasedChannel#fetchMessage"],"examples":["// get message\rchannel.fetchMessage('99539446449315840')\r  .then(message => console.log(message.content))\r  .catch(console.error);"],"params":[{"name":"messageID","description":"The ID of the message to get","type":[[["string"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":104,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchMessages","description":"Gets the past messages sent in this channel. Resolves with a Collection mapping message ID's to Message objects.","implements":["TextBasedChannel#fetchMessages"],"examples":["// get messages\rchannel.fetchMessages({limit: 10})\r .then(messages => console.log(`Received ${messages.size} messages`))\r .catch(console.log);"],"params":[{"name":"options","description":"The query parameters to pass in","optional":true,"default":"{}","type":[[["ChannelLogsQueryOptions"]]]}],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":140,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchPinnedMessages","description":"Fetches the pinned messages of this Channel and returns a Collection of them.","implements":["TextBasedChannel#fetchPinnedMessages"],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":158,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"startTyping","description":"Starts a typing indicator in the channel.","implements":["TextBasedChannel#startTyping"],"examples":["// start typing in a channel\rchannel.startTyping();"],"params":[{"name":"count","description":"The number of times startTyping should be considered to have been called","optional":true,"type":[[["number"]]]}],"meta":{"line":179,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"stopTyping","description":"Stops the typing indicator in the channel.\rThe indicator will only stop if this is called as many times as startTyping().\r<info>It can take a few seconds for the Client User to stop typing.</info>","implements":["TextBasedChannel#stopTyping"],"examples":["// stop typing in a channel\rchannel.stopTyping();","// force typing to fully stop in a channel\rchannel.stopTyping(true);"],"params":[{"name":"force","description":"Whether or not to reset the call count and force the indicator to stop","optional":true,"default":false,"type":[[["boolean"]]]}],"meta":{"line":207,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"createCollector","description":"Creates a Message Collector","implements":["TextBasedChannel#createCollector"],"examples":["// create a message collector\rconst collector = channel.createCollector(\r m => m.content.includes('discord'),\r { time: 15000 }\r);\rcollector.on('message', m => console.log(`Collected ${m.content}`));\rcollector.on('end', collected => console.log(`Collected ${collected.size} items`));"],"params":[{"name":"filter","description":"The filter to create the collector with","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"The options to pass to the collector","optional":true,"default":"{}","type":[[["CollectorOptions"]]]}],"returns":[[["MessageCollector"]]],"meta":{"line":249,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"awaitMessages","description":"Similar to createCollector but in Promise form. Resolves with a Collection of messages that pass the specified\rfilter.","implements":["TextBasedChannel#awaitMessages"],"examples":["// await !vote messages\rconst filter = m => m.content.startsWith('!vote');\r// errors: ['time'] treats ending because of the time limit as an error\rchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\r .then(collected => console.log(collected.size))\r .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));"],"params":[{"name":"filter","description":"The filter function to use","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"Optional options to pass to the internal collector","optional":true,"default":"{}","type":[[["AwaitMessagesOptions"]]]}],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":277,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"bulkDelete","description":"Bulk delete a given Collection or Array of messages in one go. Returns the deleted messages after.","implements":["TextBasedChannel#bulkDelete"],"params":[{"name":"messages","description":"The messages to delete","type":[[["Collection",".<"],["string",", "],["Message",">"]],[["Array",".<"],["Message",">"]]]}],"returns":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":295,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"permissionsFor","description":"Gets the overall set of permissions for a user in this channel, taking into account roles and permission\roverwrites.","inherits":"GuildChannel#permissionsFor","inherited":true,"params":[{"name":"member","description":"The user that you want to obtain the overall permissions for","type":[[["GuildMemberResolvable"]]]}],"returns":{"types":[[["EvaluatedPermissions"]]],"nullable":true},"meta":{"line":57,"file":"GuildChannel.js","path":"src/structures"}},{"name":"overwritePermissions","description":"Overwrites the permissions for a user or role in this channel.","inherits":"GuildChannel#overwritePermissions","inherited":true,"examples":["// overwrite permissions for a message author\rmessage.channel.overwritePermissions(message.author, {\r SEND_MESSAGES: false\r})\r.then(() => console.log('Done!'))\r.catch(console.log);"],"params":[{"name":"userOrRole","description":"The user or role to update","type":[[["Role"]],[["UserResolvable"]]]},{"name":"options","description":"The configuration for the update","type":[[["PermissionOverwriteOptions"]]]}],"returns":[[["Promise"]]],"meta":{"line":125,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setName","description":"Set a new name for the Guild Channel","inherits":"GuildChannel#setName","inherited":true,"examples":["// set a new channel name\rchannel.setName('not general')\r .then(newChannel => console.log(`Channel's new name is ${newChannel.name}`))\r .catch(console.log);"],"params":[{"name":"name","description":"The new name for the guild channel","type":[[["string"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":175,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setPosition","description":"Set a new position for the Guild Channel","inherits":"GuildChannel#setPosition","inherited":true,"examples":["// set a new channel position\rchannel.setPosition(2)\r .then(newChannel => console.log(`Channel's new position is ${newChannel.position}`))\r .catch(console.log);"],"params":[{"name":"position","description":"The new position for the guild channel","type":[[["number"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":189,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setTopic","description":"Set a new topic for the Guild Channel","inherits":"GuildChannel#setTopic","inherited":true,"examples":["// set a new channel topic\rchannel.setTopic('needs more rate limiting')\r .then(newChannel => console.log(`Channel's new topic is ${newChannel.topic}`))\r .catch(console.log);"],"params":[{"name":"topic","description":"The new topic for the guild channel","type":[[["string"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":203,"file":"GuildChannel.js","path":"src/structures"}},{"name":"createInvite","description":"Create an invite to this Guild Channel","inherits":"GuildChannel#createInvite","inherited":true,"params":[{"name":"options","description":"The options for the invite","optional":true,"default":"{}","type":[[["InviteOptions"]]]}],"returns":[[["Promise",".<"],["Invite",">"]]],"meta":{"line":224,"file":"GuildChannel.js","path":"src/structures"}},{"name":"equals","description":"Checks if this channel has the same type, topic, position, name, overwrites and ID as another channel.\rIn most cases, a simple `channel.id === channel2.id` will do, and is much faster too.","inherits":"GuildChannel#equals","inherited":true,"params":[{"name":"channel","description":"The channel to compare this channel to","type":[[["GuildChannel"]]]}],"returns":[[["boolean"]]],"meta":{"line":234,"file":"GuildChannel.js","path":"src/structures"}},{"name":"toString","description":"When concatenated with a string, this automatically returns the Channel's mention instead of the Channel object.","inherits":"GuildChannel#toString","inherited":true,"examples":["// Outputs: Hello from #general\rconsole.log(`Hello from ${channel}`);","// Outputs: Hello from #general\rconsole.log('Hello from ' + channel);"],"returns":[[["string"]]],"meta":{"line":265,"file":"GuildChannel.js","path":"src/structures"}}],"meta":{"line":10,"file":"TextChannel.js","path":"src/structures"}},{"name":"User","description":"Represents a User on Discord.","props":[{"name":"client","description":"The Client that created the instance of the the User.","type":[[["Client"]]],"meta":{"line":14,"file":"User.js","path":"src/structures"}},{"name":"id","description":"The ID of the User","type":[[["string"]]],"meta":{"line":25,"file":"User.js","path":"src/structures"}},{"name":"username","description":"The username of the User","type":[[["string"]]],"meta":{"line":31,"file":"User.js","path":"src/structures"}},{"name":"discriminator","description":"A discriminator based on username for the User","type":[[["string"]]],"meta":{"line":37,"file":"User.js","path":"src/structures"}},{"name":"avatar","description":"The ID of the user's avatar","type":[[["string"]]],"meta":{"line":43,"file":"User.js","path":"src/structures"}},{"name":"bot","description":"Whether or not the User is a Bot.","type":[[["boolean"]]],"meta":{"line":49,"file":"User.js","path":"src/structures"}},{"name":"status","description":"The status of the user:\r\r* **`online`** - user is online\r* **`offline`** - user is offline\r* **`idle`** - user is AFK","type":[[["string"]]],"meta":{"line":59,"file":"User.js","path":"src/structures"}},{"name":"game","description":"The game that the user is playing, `null` if they aren't playing a game.","type":[[["string"]]],"meta":{"line":65,"file":"User.js","path":"src/structures"}},{"name":"creationDate","description":"The time the user was created","readonly":true,"type":[[["Date"]]],"meta":{"line":73,"file":"User.js","path":"src/structures"}},{"name":"avatarURL","description":"A link to the user's avatar (if they have one, otherwise null)","readonly":true,"nullable":true,"type":[[["string"]]],"meta":{"line":82,"file":"User.js","path":"src/structures"}}],"methods":[{"name":"deleteDM","description":"Deletes a DM Channel (if one exists) between the Client and the User. Resolves with the Channel if successful.","returns":[[["Promise",".<"],["DMChannel",">"]]],"meta":{"line":91,"file":"User.js","path":"src/structures"}},{"name":"equals","description":"Checks if the user is equal to another. It compares username, ID, discriminator, status and the game being played.\rIt is recommended to compare equality by using `user.id === user2.id` unless you want to compare all properties.","params":[{"name":"user","description":"The user to compare","type":[[["User"]]]}],"returns":[[["boolean"]]],"meta":{"line":101,"file":"User.js","path":"src/structures"}},{"name":"toString","description":"When concatenated with a string, this automatically concatenates the User's mention instead of the User object.","examples":["// logs: Hello from <@123456789>!\rconsole.log(`Hello from ${user}!`);"],"returns":[[["string"]]],"meta":{"line":124,"file":"User.js","path":"src/structures"}},{"name":"sendMessage","description":"Send a message to this channel","implements":["TextBasedChannel#sendMessage"],"examples":["// send a message\rchannel.sendMessage('hello!')\r .then(message => console.log(`Sent message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":48,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendTTSMessage","description":"Send a text-to-speech message to this channel","implements":["TextBasedChannel#sendTTSMessage"],"examples":["// send a TTS message\rchannel.sendTTSMessage('hello!')\r .then(message => console.log(`Sent tts message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":63,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendFile","description":"Send a file to this channel","implements":["TextBasedChannel#sendFile"],"params":[{"name":"attachment","description":"The file to send","type":[[["FileResolvable"]]]},{"name":"fileName","description":"The name and extension of the file","optional":true,"default":"\"file.jpg\"","type":[[["string"]]]},{"name":"content","description":"Text message to send with the attachment","optional":true,"type":[[["StringResolvable"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":74,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"meta":{"line":8,"file":"User.js","path":"src/structures"}},{"name":"VoiceChannel","description":"Represents a Server Voice Channel on Discord.","extends":["GuildChannel"],"props":[{"name":"members","description":"The members in this Voice Channel.","type":[[["Collection",".<"],["string",", "],["GuildMember",">"]]],"meta":{"line":16,"file":"VoiceChannel.js","path":"src/structures"}},{"name":"bitrate","description":"The bitrate of this voice channel","type":[[["number"]]],"meta":{"line":26,"file":"VoiceChannel.js","path":"src/structures"}},{"name":"userLimit","description":"The maximum amount of users allowed in this channel - 0 means unlimited.","type":[[["number"]]],"meta":{"line":32,"file":"VoiceChannel.js","path":"src/structures"}},{"name":"guild","description":"The guild the channel is in","type":[[["Guild"]]],"meta":{"line":21,"file":"GuildChannel.js","path":"src/structures"}},{"name":"name","description":"The name of the Guild Channel","type":[[["string"]]],"meta":{"line":31,"file":"GuildChannel.js","path":"src/structures"}},{"name":"position","description":"The position of the channel in the list.","type":[[["number"]]],"meta":{"line":37,"file":"GuildChannel.js","path":"src/structures"}},{"name":"permissionOverwrites","description":"A map of permission overwrites in this channel for roles and users.","type":[[["Collection",".<"],["string",", "],["PermissionOverwrites",">"]]],"meta":{"line":43,"file":"GuildChannel.js","path":"src/structures"}}],"methods":[{"name":"setBitrate","description":"Sets the bitrate of the channel","examples":["// set the bitrate of a voice channel\rvoiceChannel.setBitrate(48000)\r .then(vc => console.log(`Set bitrate to ${vc.bitrate} for ${vc.name}`))\r .catch(console.log);"],"params":[{"name":"bitrate","description":"The new bitrate","type":[[["number"]]]}],"returns":[[["Promise",".<"],["VoiceChannel",">"]]],"meta":{"line":47,"file":"VoiceChannel.js","path":"src/structures"}},{"name":"join","description":"Attempts to join this Voice Channel","examples":["// join a voice channel\rvoiceChannel.join()\r .then(connection => console.log('Connected!'))\r .catch(console.log);"],"returns":[[["Promise",".<"],["VoiceConnection",">"]]],"meta":{"line":60,"file":"VoiceChannel.js","path":"src/structures"}},{"name":"leave","description":"Leaves this voice channel","examples":["// leave a voice channel\rvoiceChannel.leave();"],"meta":{"line":70,"file":"VoiceChannel.js","path":"src/structures"}},{"name":"permissionsFor","description":"Gets the overall set of permissions for a user in this channel, taking into account roles and permission\roverwrites.","inherits":"GuildChannel#permissionsFor","inherited":true,"params":[{"name":"member","description":"The user that you want to obtain the overall permissions for","type":[[["GuildMemberResolvable"]]]}],"returns":{"types":[[["EvaluatedPermissions"]]],"nullable":true},"meta":{"line":57,"file":"GuildChannel.js","path":"src/structures"}},{"name":"overwritePermissions","description":"Overwrites the permissions for a user or role in this channel.","inherits":"GuildChannel#overwritePermissions","inherited":true,"examples":["// overwrite permissions for a message author\rmessage.channel.overwritePermissions(message.author, {\r SEND_MESSAGES: false\r})\r.then(() => console.log('Done!'))\r.catch(console.log);"],"params":[{"name":"userOrRole","description":"The user or role to update","type":[[["Role"]],[["UserResolvable"]]]},{"name":"options","description":"The configuration for the update","type":[[["PermissionOverwriteOptions"]]]}],"returns":[[["Promise"]]],"meta":{"line":125,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setName","description":"Set a new name for the Guild Channel","inherits":"GuildChannel#setName","inherited":true,"examples":["// set a new channel name\rchannel.setName('not general')\r .then(newChannel => console.log(`Channel's new name is ${newChannel.name}`))\r .catch(console.log);"],"params":[{"name":"name","description":"The new name for the guild channel","type":[[["string"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":175,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setPosition","description":"Set a new position for the Guild Channel","inherits":"GuildChannel#setPosition","inherited":true,"examples":["// set a new channel position\rchannel.setPosition(2)\r .then(newChannel => console.log(`Channel's new position is ${newChannel.position}`))\r .catch(console.log);"],"params":[{"name":"position","description":"The new position for the guild channel","type":[[["number"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":189,"file":"GuildChannel.js","path":"src/structures"}},{"name":"setTopic","description":"Set a new topic for the Guild Channel","inherits":"GuildChannel#setTopic","inherited":true,"examples":["// set a new channel topic\rchannel.setTopic('needs more rate limiting')\r .then(newChannel => console.log(`Channel's new topic is ${newChannel.topic}`))\r .catch(console.log);"],"params":[{"name":"topic","description":"The new topic for the guild channel","type":[[["string"]]]}],"returns":[[["Promise",".<"],["GuildChannel",">"]]],"meta":{"line":203,"file":"GuildChannel.js","path":"src/structures"}},{"name":"createInvite","description":"Create an invite to this Guild Channel","inherits":"GuildChannel#createInvite","inherited":true,"params":[{"name":"options","description":"The options for the invite","optional":true,"default":"{}","type":[[["InviteOptions"]]]}],"returns":[[["Promise",".<"],["Invite",">"]]],"meta":{"line":224,"file":"GuildChannel.js","path":"src/structures"}},{"name":"equals","description":"Checks if this channel has the same type, topic, position, name, overwrites and ID as another channel.\rIn most cases, a simple `channel.id === channel2.id` will do, and is much faster too.","inherits":"GuildChannel#equals","inherited":true,"params":[{"name":"channel","description":"The channel to compare this channel to","type":[[["GuildChannel"]]]}],"returns":[[["boolean"]]],"meta":{"line":234,"file":"GuildChannel.js","path":"src/structures"}},{"name":"toString","description":"When concatenated with a string, this automatically returns the Channel's mention instead of the Channel object.","inherits":"GuildChannel#toString","inherited":true,"examples":["// Outputs: Hello from #general\rconsole.log(`Hello from ${channel}`);","// Outputs: Hello from #general\rconsole.log('Hello from ' + channel);"],"returns":[[["string"]]],"meta":{"line":265,"file":"GuildChannel.js","path":"src/structures"}}],"meta":{"line":8,"file":"VoiceChannel.js","path":"src/structures"}},{"name":"Collection","description":"A utility class to help make it easier to access the data stores","extends":["Map"],"methods":[{"name":"array","description":"Returns an ordered array of the values of this collection.","examples":["// identical to:\rArray.from(collection.values());"],"returns":[[["array"]]],"meta":{"line":13,"file":"Collection.js","path":"src/util"}},{"name":"first","description":"Returns the first item in this collection.","examples":["// identical to:\rArray.from(collection.values())[0];"],"returns":[["*"]],"meta":{"line":24,"file":"Collection.js","path":"src/util"}},{"name":"last","description":"Returns the last item in this collection. This is a relatively slow operation,\rsince an array copy of the values must be made to find the last element.","returns":[["*"]],"meta":{"line":33,"file":"Collection.js","path":"src/util"}},{"name":"random","description":"Returns a random item from this collection. This is a relatively slow operation,\rsince an array copy of the values must be made to find a random element.","returns":[["*"]],"meta":{"line":43,"file":"Collection.js","path":"src/util"}},{"name":"deleteAll","description":"If the items in this collection have a delete method (e.g. messages), invoke\rthe delete method. Returns an array of promises","returns":[[["Array",".<"],["Promise",">"]]],"meta":{"line":53,"file":"Collection.js","path":"src/util"}},{"name":"findAll","description":"Returns an array of items where `item[key] === value` of the collection","examples":["collection.findAll('username', 'Bob');"],"params":[{"name":"key","description":"The key to filter by","type":[[["string"]]]},{"name":"value","description":"The expected value","type":[["*"]]}],"returns":[[["array"]]],"meta":{"line":69,"file":"Collection.js","path":"src/util"}},{"name":"find","description":"Returns a single item where `item[key] === value`","examples":["collection.find('id', '123123...');"],"params":[{"name":"key","description":"The key to filter by","type":[[["string"]]]},{"name":"value","description":"The expected value","type":[["*"]]}],"returns":[["*"]],"meta":{"line":87,"file":"Collection.js","path":"src/util"}},{"name":"exists","description":"Returns true if the collection has an item where `item[key] === value`","examples":["if (collection.exists('id', '123123...')) {\r console.log('user here!');\r}"],"params":[{"name":"key","description":"The key to filter by","type":[[["string"]]]},{"name":"value","description":"The expected value","type":[["*"]]}],"returns":[[["boolean"]]],"meta":{"line":106,"file":"Collection.js","path":"src/util"}},{"name":"filter","description":"Identical to\r[Array.filter()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter),\rbut returns a Collection instead of an Array.","params":[{"name":"fn","description":"Function used to test (should return a boolean)","type":[[["function"]]]},{"name":"thisArg","description":"Value to use as `this` when executing function","optional":true,"type":[[["Object"]]]}],"returns":[[["Collection"]]],"meta":{"line":118,"file":"Collection.js","path":"src/util"}},{"name":"map","description":"Identical to\r[Array.map()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map).","params":[{"name":"fn","description":"Function that produces an element of the new array, taking three arguments","type":[[["function"]]]},{"name":"thisArg","description":"Value to use as `this` when executing function","optional":true,"type":[["*"]]}],"returns":[[["array"]]],"meta":{"line":134,"file":"Collection.js","path":"src/util"}},{"name":"some","description":"Identical to\r[Array.some()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/some).","params":[{"name":"fn","description":"Function used to test (should return a boolean)","type":[[["function"]]]},{"name":"thisArg","description":"Value to use as `this` when executing function","optional":true,"type":[[["Object"]]]}],"returns":[[["Collection"]]],"meta":{"line":151,"file":"Collection.js","path":"src/util"}},{"name":"every","description":"Identical to\r[Array.every()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/every).","params":[{"name":"fn","description":"Function used to test (should return a boolean)","type":[[["function"]]]},{"name":"thisArg","description":"Value to use as `this` when executing function","optional":true,"type":[[["Object"]]]}],"returns":[[["Collection"]]],"meta":{"line":166,"file":"Collection.js","path":"src/util"}}],"meta":{"line":5,"file":"Collection.js","path":"src/util"}}],"interfaces":[{"name":"TextBasedChannel","description":"Interface for classes that have text-channel-like features","props":[{"name":"messages","description":"A Collection containing the messages sent to this channel.","type":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":16,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"lastMessageID","description":"The ID of the last message in the channel, if one was sent.","nullable":true,"type":[[["string"]]],"meta":{"line":22,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"typing","description":"Whether or not the typing indicator is being shown in the channel.","type":[[["boolean"]]],"meta":{"line":222,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"typingCount","description":"Number of times `startTyping` has been called.","type":[[["number"]]],"meta":{"line":230,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"methods":[{"name":"sendMessage","description":"Send a message to this channel","examples":["// send a message\rchannel.sendMessage('hello!')\r .then(message => console.log(`Sent message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":48,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendTTSMessage","description":"Send a text-to-speech message to this channel","examples":["// send a TTS message\rchannel.sendTTSMessage('hello!')\r .then(message => console.log(`Sent tts message: ${message.content}`))\r .catch(console.log);"],"params":[{"name":"content","description":"The content to send","type":[[["StringResolvable"]]]},{"name":"options","description":"The options to provide","optional":true,"default":"{}","type":[[["MessageOptions"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":63,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"sendFile","description":"Send a file to this channel","params":[{"name":"attachment","description":"The file to send","type":[[["FileResolvable"]]]},{"name":"fileName","description":"The name and extension of the file","optional":true,"default":"\"file.jpg\"","type":[[["string"]]]},{"name":"content","description":"Text message to send with the attachment","optional":true,"type":[[["StringResolvable"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":74,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchMessage","description":"Gets a single message from this channel, regardless of it being cached or not.","examples":["// get message\rchannel.fetchMessage('99539446449315840')\r  .then(message => console.log(message.content))\r  .catch(console.error);"],"params":[{"name":"messageID","description":"The ID of the message to get","type":[[["string"]]]}],"returns":[[["Promise",".<"],["Message",">"]]],"meta":{"line":104,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchMessages","description":"Gets the past messages sent in this channel. Resolves with a Collection mapping message ID's to Message objects.","examples":["// get messages\rchannel.fetchMessages({limit: 10})\r .then(messages => console.log(`Received ${messages.size} messages`))\r .catch(console.log);"],"params":[{"name":"options","description":"The query parameters to pass in","optional":true,"default":"{}","type":[[["ChannelLogsQueryOptions"]]]}],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":140,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"fetchPinnedMessages","description":"Fetches the pinned messages of this Channel and returns a Collection of them.","returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":158,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"startTyping","description":"Starts a typing indicator in the channel.","examples":["// start typing in a channel\rchannel.startTyping();"],"params":[{"name":"count","description":"The number of times startTyping should be considered to have been called","optional":true,"type":[[["number"]]]}],"meta":{"line":179,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"stopTyping","description":"Stops the typing indicator in the channel.\rThe indicator will only stop if this is called as many times as startTyping().\r<info>It can take a few seconds for the Client User to stop typing.</info>","examples":["// stop typing in a channel\rchannel.stopTyping();","// force typing to fully stop in a channel\rchannel.stopTyping(true);"],"params":[{"name":"force","description":"Whether or not to reset the call count and force the indicator to stop","optional":true,"default":false,"type":[[["boolean"]]]}],"meta":{"line":207,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"createCollector","description":"Creates a Message Collector","examples":["// create a message collector\rconst collector = channel.createCollector(\r m => m.content.includes('discord'),\r { time: 15000 }\r);\rcollector.on('message', m => console.log(`Collected ${m.content}`));\rcollector.on('end', collected => console.log(`Collected ${collected.size} items`));"],"params":[{"name":"filter","description":"The filter to create the collector with","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"The options to pass to the collector","optional":true,"default":"{}","type":[[["CollectorOptions"]]]}],"returns":[[["MessageCollector"]]],"meta":{"line":249,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"awaitMessages","description":"Similar to createCollector but in Promise form. Resolves with a Collection of messages that pass the specified\rfilter.","examples":["// await !vote messages\rconst filter = m => m.content.startsWith('!vote');\r// errors: ['time'] treats ending because of the time limit as an error\rchannel.awaitMessages(filter, { max: 4, time: 60000, errors: ['time'] })\r .then(collected => console.log(collected.size))\r .catch(collected => console.log(`After a minute, only ${collected.size} out of 4 voted.`));"],"params":[{"name":"filter","description":"The filter function to use","type":[[["CollectorFilterFunction"]]]},{"name":"options","description":"Optional options to pass to the internal collector","optional":true,"default":"{}","type":[[["AwaitMessagesOptions"]]]}],"returns":[[["Promise",".<"],["Collection",".<"],["string",", "],["Message",">>"]]],"meta":{"line":277,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"bulkDelete","description":"Bulk delete a given Collection or Array of messages in one go. Returns the deleted messages after.","params":[{"name":"messages","description":"The messages to delete","type":[[["Collection",".<"],["string",", "],["Message",">"]],[["Array",".<"],["Message",">"]]]}],"returns":[[["Collection",".<"],["string",", "],["Message",">"]]],"meta":{"line":295,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"meta":{"line":10,"file":"TextBasedChannel.js","path":"src/structures/interface"}}],"typedefs":[{"name":"UserResolvable","description":"Data that resolves to give a User object. This can be:\r* A User object\r* A User ID\r* A Message (resolves to the message author)\r* A Guild (owner of the guild)\r* A Guild Member","type":[[["User"]],[["string"]],[["Message"]],[["Guild"]],[["GuildMember"]]],"meta":{"line":25,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"GuildResolvable","description":"Data that resolves to give a Guild object. This can be:\r* A Guild object","type":[[["Guild"]]],"meta":{"line":56,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"GuildMemberResolvable","description":"Data that resolves to give a GuildMember object. This can be:\r* A GuildMember object\r* A User object","type":[[["Guild"]]],"meta":{"line":73,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"Base64Resolvable","description":"Data that resolves to give a Base64 string, typically for image uploading. This can be:\r* A Buffer\r* A Base64 string","type":[[["Buffer"]],[["string"]]],"meta":{"line":96,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"ChannelResolvable","description":"Data that can be resolved to give a Channel. This can be:\r* An instance of a Channel\r* An ID of a Channel","type":[[["Channel"]],[["string"]]],"meta":{"line":113,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"PermissionResolvable","description":"Data that can be resolved to give a permission number. This can be:\r* A string\r* A permission number","type":[[["string"]],[["number"]]],"meta":{"line":131,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"StringResolvable","description":"Data that can be resolved to give a string. This can be:\r* A string\r* An Array (joined with a new line delimiter to give a string)\r* Any value","type":[[["string"]],[["Array"]],["*"]],"meta":{"line":149,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"FileResolvable","description":"Data that can be resolved to give a Buffer. This can be:\r* A Buffer\r* The path to a local file\r* A URL","type":[[["string"]],[["Buffer"]]],"meta":{"line":168,"file":"ClientDataResolver.js","path":"src/client"}},{"name":"StreamOptions","description":"Options that can be passed to stream-playing methods:\r```js\r{\r  seek: 0,\r  volume: 1\r};\r```","type":[[["Object"]]],"meta":{"line":203,"file":"VoiceConnection.js","path":"src/client/voice"}},{"name":"PermissionOverwriteOptions","description":"An object mapping permission flags to `true` (enabled) or `false` (disabled)\r```js\r{\r 'SEND_MESSAGES': true,\r 'ATTACH_FILES': false,\r}\r```","type":[[["Object"]]],"meta":{"line":101,"file":"GuildChannel.js","path":"src/structures"}},{"name":"InviteOptions","description":"Options given when creating a Guild Channel Invite:\r```js\r{\r temporary: false, // whether the invite should kick users after 24hrs if they are not given a new role\r maxAge: 0, // the time in seconds the invite expires in\r maxUses: 0, // the maximum amount of uses for this invite\r}\r```","type":[[["Object"]]],"meta":{"line":207,"file":"GuildChannel.js","path":"src/structures"}},{"name":"MessageOptions","description":"Options that can be passed into sendMessage or sendTTSMessage:\r```js\r{\r  tts: false,\r  nonce: '',\r  disable_everyone: false,\r};\r```","type":[[["Object"]]],"meta":{"line":25,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"ChannelLogsQueryOptions","description":"The parameters to pass in when requesting previous messages from a channel. `around`, `before` and\r`after` are mutually exclusive. All the parameters are optional.\r```js\r{\r limit: 30, // the message limit, defaults to 50\r before: '123', // gets messages before the given message ID\r after: '123', // gets messages after the given message ID\r around: '123', // gets messages around the given message ID\r}\r```","type":[[["Object"]]],"meta":{"line":116,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"AwaitMessagesOptions","description":"An object containing the same properties as CollectorOptions, but a few more:\r```js\r{\r errors: [], // an array of stop/end reasons that cause the promise to reject.\r}\r```","type":[[["Object"]]],"meta":{"line":253,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"CollectorFilterFunction","description":"A function that takes a Message object and a MessageCollector and returns a boolean.\r```js\rfunction(message, collector) {\r if (message.content.includes('discord')) {\r   return true; // passed the filter test\r }\r return false; // failed the filter test\r}\r```","type":[[["function"]]],"meta":{"line":317,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"CollectorOptions","description":"An object containing options used to configure a MessageCollector. All properties are optional.\r```js\r{\r time: null, // time in milliseconds. If specified, the collector ends after this amount of time.\r max: null, // the maximum amount of messages to handle before ending.\r}\r```","type":[[["Object"]]],"meta":{"line":330,"file":"TextBasedChannel.js","path":"src/structures/interface"}},{"name":"ClientOptions","description":"Options that can be passed to a client:\r```js\r{\r  ws: {\r    large_threshold: 250,\r    compress: true,\r    properties: {\r      $os: process ? process.platform : 'discord.js',\r      $browser: 'discord.js',\r      $device: 'discord.js',\r      $referrer: '',\r      $referring_domain: '',\r    },\r  },\r  protocol_version: 6,\r  max_message_cache: 200,\r  rest_ws_bridge_timeout: 5000,\r  api_request_method: 'sequential',\r  shard_id: 0,\r  shard_count: 0,\r  fetch_all_members: false,\r  disable_everyone: false,\r};\r```","type":[[["Object"]]],"meta":{"line":1,"file":"Constants.js","path":"src/util"}}],"externals":[],"custom":{"general":[{"id":"welcome","name":"Welcome","type":"md","content":"<p align=\"center\">\r\n  <a href=\"https://hydrabolt.github.io/discord.js\">\r\n    <img alt=\"discord.js\" src=\"http://i.imgur.com/sPOLh9y.png\" width=\"546\"><br />\r\n  </a>\r\n</p>\r\n\r\n[![Discord](https://discordapp.com/api/guilds/222078108977594368/embed.png)](https://discord.gg/bRCvFy9)\r\n[![npm](https://img.shields.io/npm/v/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js)\r\n[![npm](https://img.shields.io/npm/dt/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js)\r\n[![Build Status](https://travis-ci.org/hydrabolt/discord.js.svg)](https://travis-ci.org/hydrabolt/discord.js)\r\n[![David](https://img.shields.io/david/hydrabolt/discord.js.svg?maxAge=2592000)](https://david-dm.org/hydrabolt/discord.js)\r\n\r\n[![NPM](https://nodei.co/npm/discord.js.png?downloads=true&stars=true)](https://nodei.co/npm/discord.js/)\r\n\r\ndiscord.js is a powerful node.js module that allows you to interact with the [Discord API](https://discordapp.com/developers/docs/intro).\r\n\r\n# Welcome!\r\nWelcome to the discord.js v9 documentation. The v9 rewrite has taken a lot of time, but it should be much more\r\nstable and performant than previous versions.\r\n\r\n## Installation\r\n**Node.js 6.0.0 or newer is required.**  \r\nWith voice support: `npm install --save discord.js --production`  \r\nWithout voice support: `npm install --save discord.js --production --no-optional`\r\n\r\nBy default, discord.js uses [opusscript](https://www.npmjs.com/package/opusscript) when playing audio over voice connections.\r\nIf you're looking to play over multiple voice connections, it might be better to install [node-opus](https://www.npmjs.com/package/node-opus).\r\ndiscord.js will automatically prefer node-opus over opusscript.\r\n\r\n## Guides\r\n* [LuckyEvie's general guide](https://eslachance.gitbooks.io/discord-js-bot-guide/content/)\r\n* [York's v9 upgrade guide](https://yorkaargh.wordpress.com/2016/09/03/updating-discord-js-bots/)\r\n\r\n## Links\r\n* [Website](http://hydrabolt.github.io/discord.js/)\r\n* [Discord Server](https://discord.gg/bRCvFy9)\r\n* [Documentation](http://hydrabolt.github.io/discord.js/#!/docs/tag/master)\r\n* [Legacy Documentation](http://discordjs.readthedocs.io/en/8.1.0/docs_client.html)\r\n* [GitHub](https://github.com/hydrabolt/discord.js)\r\n* [NPM](https://www.npmjs.com/package/discord.js)\r\n* [Examples](https://github.com/hydrabolt/discord.js/tree/master/docs/custom/examples)\r\n* [Related Libraries](https://discordapi.com/unofficial/libs.html)\r\n\r\n## Help\r\nIf you don't understand something in this documentation, you are experiencing problems, or you just need a gentle\r\nnudge in the right direction, please don't hesitate to join our official [Discord.js Server](https://discord.gg/bRCvFy9).\r\n"},{"id":"updating","name":"Updating your code","type":"md","content":"# About Version 9\r\nThe version 9 (v9) rewrite takes a much more object-oriented approach than previous versions,\r\nwhich allows your code to be much more readable and manageable.\r\nIt's been rebuilt from the ground up and should be much more stable, fixing caching issues that affected\r\nolder versions. It also has support for newer Discord Features, such as emojis.\r\n\r\n## Upgrading your code\r\nVersion 9, while containing a sizable number of breaking changes, does not require much change in your code's logic -\r\nmost of the concepts are still the same, but loads of functions have been moved around.\r\nThe vast majority of methods you're used to using have been moved out of the Client class,\r\ninto other more relevant classes where they belong.\r\nBecause of this, you will need to convert most of your calls over to the new methods.\r\n\r\nHere are a few examples of methods that have changed:\r\n* `Client.sendMessage(channel, message)` ==> `TextChannel.sendMessage(message)`\r\n  * `Client.sendMessage(user, message)` ==> `User.sendMessage(message)`\r\n* `Client.updateMessage(message, \"New content\")` ==> `Message.edit(\"New Content\")`\r\n* `Client.getChannelLogs(channel, limit)` ==> `TextChannel.fetchMessages({options})`\r\n* `Server.detailsOfUser(User)` ==> `Server.members.get(User).properties` (retrieving a member gives a GuildMember object)\r\n* `Client.joinVoiceChannel(voicechannel)` => `VoiceChannel.join()`\r\n\r\nA couple more important details:\r\n* `Client.loginWithToken(\"token\")` ==> `client.login(\"token\")`\r\n* `Client.servers.length` ==> `client.guilds.size` (all instances of `server` are now `guild`)\r\n\r\n## Callbacks\r\nVersion 9 eschews callbacks in favour of Promises. This means all code relying on callbacks must be changed.  \r\nFor example, the following code:\r\n\r\n```js\r\nclient.getChannelLogs(channel, 100, function(messages) {\r\n  console.log(`${messages.length} messages found`);\r\n});\r\n```\r\n\r\n```js\r\nchannel.fetchMessages({limit: 100}).then(messages => {\r\n  console.log(`${messages.size} messages found`);\r\n});\r\n```\r\n"}],"examples":[{"id":"ping","name":"Ping","type":"js","content":"/*\r\n  A ping pong bot, whenever you send \"ping\", it replies \"pong\".\r\n*/\r\n\r\n// import the discord.js module\r\nconst Discord = require('discord.js');\r\n\r\n// create an instance of a Discord Client, and call it bot\r\nconst bot = new Discord.Client();\r\n\r\n// the token of your bot - https://discordapp.com/developers/applications/me\r\nconst token = 'your bot token here';\r\n\r\n// the ready event is vital, it means that your bot will only start reacting to information\r\n// from Discord _after_ ready is emitted.\r\nbot.on('ready', () => {\r\n  console.log('I am ready!');\r\n});\r\n\r\n// create an event listener for messages\r\nbot.on('message', message => {\r\n  // if the message is \"ping\",\r\n  if (message.content === 'ping') {\r\n    // send \"pong\" to the same channel.\r\n    message.channel.sendMessage('pong');\r\n  }\r\n});\r\n\r\n// log our bot in\r\nbot.login(token);\r\n"},{"id":"avatars","name":"Avatars","type":"js","content":"/*\r\n  Send a user a link to their avatar\r\n*/\r\n\r\n// import the discord.js module\r\nconst Discord = require('discord.js');\r\n\r\n// create an instance of a Discord Client, and call it bot\r\nconst bot = new Discord.Client();\r\n\r\n// the token of your bot - https://discordapp.com/developers/applications/me\r\nconst token = 'your bot token here';\r\n\r\n// the ready event is vital, it means that your bot will only start reacting to information\r\n// from Discord _after_ ready is emitted.\r\nbot.on('ready', () => {\r\n  console.log('I am ready!');\r\n});\r\n\r\n// create an event listener for messages\r\nbot.on('message', message => {\r\n  // if the message is \"what is my avatar\",\r\n  if (message.content === 'what is my avatar') {\r\n    // send the user's avatar URL\r\n    message.reply(message.author.avatarURL);\r\n  }\r\n});\r\n\r\n// log our bot in\r\nbot.login(token);\r\n"}]}}