Index | Yasmin

A

$Client#api — Property in class Client: The API manager.
Client::apimanager() — Method in class Client: You don't need to know.
Client::addTimer() — Method in class Client: Adds a "client-dependant" timer. The timer gets automatically cancelled on destroy. The callback can only accept one argument, the client.
Client::addPeriodicTimer() — Method in class Client: Adds a "client-dependant" periodic timer. The timer gets automatically cancelled on destroy. The callback can only accept one argument, the client.
APIEndpoints — Class in namespace CharlotteDunois\Yasmin\HTTP: Handles the API endpoints.
$APIEndpoints#api — Property in class APIEndpoints: The API manager.
APIManager — Class in namespace CharlotteDunois\Yasmin\HTTP: Handles the API.
APIManager::add() — Method in class APIManager: Adds an APIRequest to the queue.
APIRequest — Class in namespace CharlotteDunois\Yasmin\HTTP: Represents a single HTTP request.
$APIRequest#api — Property in class APIRequest: The API manager.
AthenaRatelimitBucket — Class in namespace CharlotteDunois\Yasmin\HTTP: Manages a route's ratelimit in Redis, using Athena. Requires client option http.ratelimitbucket.athena to be set to an instance of AthenaCache.
$AthenaRatelimitBucket#api — Property in class AthenaRatelimitBucket: The API manager.
$Channel#api — Property in class Channel
$Emoji#api — Property in class Emoji
$Guild#api — Property in class Guild
Guild::addGuildMember() — Method in class Guild
Guild::addGuildMemberRole() — Method in class Guild
$Invite#api — Property in class Invite
Invite::acceptInvite() — Method in class Invite
$User#api — Property in class User
$Voice#api — Property in class Voice
$Webhook#api — Property in class Webhook: Constructor.
$RatelimitBucket#api — Property in class RatelimitBucket: The API manager.
ChannelStorageInterface::all() — Method in class ChannelStorageInterface: Returns all items.
EmojiStorageInterface::all() — Method in class EmojiStorageInterface: Returns all items.
GuildMemberStorageInterface::all() — Method in class GuildMemberStorageInterface: Returns all items.
GuildStorageInterface::all() — Method in class GuildStorageInterface: Returns all items.
MessageStorageInterface::all() — Method in class MessageStorageInterface: Returns all items.
PresenceStorageInterface::all() — Method in class PresenceStorageInterface: Returns all items.
RoleStorageInterface::all() — Method in class RoleStorageInterface: Returns all items.
StorageInterface::all() — Method in class StorageInterface: Returns all items.
UserStorageInterface::all() — Method in class UserStorageInterface: Returns all items.
Activity — Class in namespace CharlotteDunois\Yasmin\Models: Something someone does.
$Activity#applicationID — Property in class Activity: The application ID associated with the activity, or null.
$Activity#assets — Property in class Activity: Assets for rich presence, or null.
AnnouncementChannel — Class in namespace CharlotteDunois\Yasmin\Models: Announcement channel; functionally identical to a TextChannel
AuditLog — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild audit log.
AuditLogEntry — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild audit log entry.
$AuditLogEntry#actionType — Property in class AuditLogEntry: Specific action type of this entry in its string presentation.
$Emoji#animated — Property in class Emoji: Whether this emoji is animated.
Emoji::addRestrictedRole() — Method in class Emoji: Adds a role to the list of roles that can use this emoji. Resolves with $this.
Emoji::addRestrictedRoles() — Method in class Emoji: Adds multiple roles to the list of roles that can use this emoji. Resolves with $this.
$GroupDMChannel#applicationID — Property in class GroupDMChannel: The application which created the group DM channel.
GroupDMChannel::addRecipient() — Method in class GroupDMChannel: Adds the given user to the Group DM channel using the given access token. Resolves with $this.
$Guild#available — Property in class Guild: Whether the guild is available.
$Guild#afkChannelID — Property in class Guild: The ID of the afk channel, or null.
$Guild#afkTimeout — Property in class Guild: The time in seconds before an user is counted as "away from keyboard".
$Guild#applicationID — Property in class Guild: Application ID of the guild creator, if it is bot-created.
$Guild#afkChannel — Property in class Guild: The guild's afk channel, or null.
Guild::addMember() — Method in class Guild: Adds the given user to the guild using the OAuth Access Token. Requires the CREATE_INSTANT_INVITE permission. Resolves with $this.
$GuildMember#avatar — Property in class GuildMember: The hash of the user's server avatar, or null.
GuildMember::addRole() — Method in class GuildMember: Adds a role to the guild member. Resolves with $this.
GuildMember::addRoles() — Method in class GuildMember: Adds roles to the guild member. Resolves with $this.
$Message#author — Property in class Message: The user that created the message.
$Message#activity — Property in class Message: The activity attached to this message. Sent with Rich Presence-related chat embeds.
$Message#application — Property in class Message: The application attached to this message. Sent with Rich Presence-related chat embeds.
$Message#attachments — Property in class Message: A collection of attachments in the message - mapped by their ID. ({see \CharlotteDunois\Yasmin\Models\MessageAttachment})
$MessageActivity#activity — Property in class MessageActivity: The activity this message activity points to, or null.
$MessageAttachment#attachment — Property in class MessageAttachment: Used for sending attachments.
$MessageEmbed#author — Property in class MessageEmbed: The author in the format [ 'name' => string, 'icon' => string, 'url' => string ], or null.
MessageEmbed::addField() — Method in class MessageEmbed: Adds a field to this embed.
$PermissionOverwrite#allow — Property in class PermissionOverwrite: The allowed Permissions instance.
Permissions::add() — Method in class Permissions: Adds permissions to these ones.
$Presence#activities — Property in class Presence: All activities the user is doing.
$RichPresenceAssets#activity — Property in class RichPresenceAssets: The activity which these assets belong to.
$User#avatar — Property in class User: The hash of the user's avatar, or null.
$Webhook#avatar — Property in class Webhook: The webhook default avatar, or null.
DataHelpers::applyOptions() — Method in class DataHelpers: Converts the input to the specified options.
URLHelpers::applyRequestOptions() — Method in class URLHelpers: Applies request options to the request.
$WSConnection#authenticated — Property in class WSConnection: The WS authentication state.
$WebhookClient#avatar — Property in class WebhookClient: The webhook default avatar, or null.

B

$APIManager#bucketName — Property in class APIManager: The class name of the bucket to use.
$APIManager#bucketRatelimitPromises — Property in class APIManager: Pending promises of buckets setting the ratelimit.
$AthenaRatelimitBucket#busy — Property in class AthenaRatelimitBucket: Whether the bucket is busy.
Channel::bulkDeleteMessages() — Method in class Channel
Guild::beginGuildPrune() — Method in class Guild
$RatelimitBucket#busy — Property in class RatelimitBucket: Whether the bucket is busy.
GuildTextChannelInterface::bulkDelete() — Method in class GuildTextChannelInterface: Deletes multiple messages at once. Resolves with $this.
Base — Class in namespace CharlotteDunois\Yasmin\Models: Something all Models extend.
$Guild#banner — Property in class Guild: Guild banner hash used for Server Discovery, or null.
Guild::ban() — Method in class Guild: Bans the given user. Resolves with $this.
$GuildMember#banner — Property in class GuildMember: The hash of the user's server banner, or null.
GuildMember::ban() — Method in class GuildMember: Bans the guild member.
$OAuthApplication#botPublic — Property in class OAuthApplication: Whether the bot is public.
$OAuthApplication#botRequireCodeGrant — Property in class OAuthApplication: Whether the bot requires a code grant (full OAuth flow).
$Permissions#bitfield — Property in class Permissions: The bitfield value.
$Storage#baseStorageArgs — Property in class Storage: Basic storage args.
$User#bot — Property in class User: Is the user a bot? Or are you a bot?
$User#banner — Property in class User: The hash of the user's banner, or null.
$VoiceChannel#bitrate — Property in class VoiceChannel: The bitrate of the channel.
TextChannelTrait::bulkDelete() — Method in class TextChannelTrait: Deletes multiple messages at once. Resolves with $this.
$Collector#bucket — Property in class Collector
$Snowflake#binary — Property in class Snowflake: The binary representation of this snowflake.

C

Client — Class in namespace CharlotteDunois\Yasmin: The client. What else do you expect this to say?
$Client#channels — Property in class Client: Holds all cached channels, mapped by ID.
Client::createGuild() — Method in class Client: Creates a new guild. Resolves with an instance of Guild. Options is as following, everything is optional unless specified:
Client::cancelTimer() — Method in class Client: Cancels a timer.
Client::cancelTimers() — Method in class Client: Cancels all timers.
Client::checkOptionsStorages() — Method in class Client: Validates the passed client options storages.
ClientEvents — Class in namespace CharlotteDunois\Yasmin: Documents all Client events. ($client->on('name here', callable))
ClientEvents::channelCreate() — Method in class ClientEvents: Emitted when a channel gets created.
ClientEvents::channelUpdate() — Method in class ClientEvents: Emitted when a channel gets updated.
ClientEvents::channelDelete() — Method in class ClientEvents: Emitted when a channel gets deleted.
ClientEvents::channelPinsUpdate() — Method in class ClientEvents: Emitted when a channel's pins gets updated. Due to the nature of the event, it's not possible to do much.
$APIEndpoints#channel — Property in class APIEndpoints: The channel endpoints.
$APIManager#client — Property in class APIManager
APIManager::clear() — Method in class APIManager: Clears all buckets and the queue.
$AthenaRatelimitBucket#cache — Property in class AthenaRatelimitBucket: The athena cache instance.
AthenaRatelimitBucket::clear() — Method in class AthenaRatelimitBucket: Unsets all queue items.
Channel — Class in namespace CharlotteDunois\Yasmin\HTTP\Endpoints: Handles the API endpoints "Channel".
Channel::createMessage() — Method in class Channel
Channel::createMessageReaction() — Method in class Channel
Channel::createChannelInvite() — Method in class Channel
Channel::crosspostChannelMessage() — Method in class Channel
Emoji::createGuildEmoji() — Method in class Emoji
Guild::createGuild() — Method in class Guild
Guild::createGuildChannel() — Method in class Guild
Guild::createGuildBan() — Method in class Guild
Guild::createGuildRole() — Method in class Guild
Guild::createGuildIntegration() — Method in class Guild
User::createUserDM() — Method in class User
User::createGroupDM() — Method in class User
Webhook::createWebhook() — Method in class Webhook
RatelimitBucket::clear() — Method in class RatelimitBucket: Unsets all queue items.
CategoryChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all guild category channels implement.
ChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all channels implement.
ChannelStorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all channel storages implement. The storage also is used as factory.
ChannelStorageInterface::current() — Method in class ChannelStorageInterface: Returns the current element. From Iterator interface.
EmojiStorageInterface::current() — Method in class EmojiStorageInterface: Returns the current element. From Iterator interface.
GuildChannelInterface::clone() — Method in class GuildChannelInterface: Clones a guild channel. Resolves with an instance of GuildChannelInterface.
GuildMemberStorageInterface::current() — Method in class GuildMemberStorageInterface: Returns the current element. From Iterator interface.
GuildNewsChannelInterface::createInvite() — Method in class GuildNewsChannelInterface: Creates an invite. Resolves with an instance of Invite.
GuildStorageInterface::current() — Method in class GuildStorageInterface: Returns the current element. From Iterator interface.
GuildTextChannelInterface::createInvite() — Method in class GuildTextChannelInterface: Creates an invite. Resolves with an instance of Invite.
MessageStorageInterface::current() — Method in class MessageStorageInterface: Returns the current element. From Iterator interface.
PresenceStorageInterface::current() — Method in class PresenceStorageInterface: Returns the current element. From Iterator interface.
RatelimitBucketInterface::clear() — Method in class RatelimitBucketInterface: Unsets all queue items.
RoleStorageInterface::current() — Method in class RoleStorageInterface: Returns the current element. From Iterator interface.
StorageInterface::current() — Method in class StorageInterface: Returns the current element. From Iterator interface.
StorageInterface::count() — Method in class StorageInterface: Returns the total number of items. From Countable interface.
StorageInterface::copy() — Method in class StorageInterface: Returns a copy of itself. This does not make a copy of the stored data.
StorageInterface::clear() — Method in class StorageInterface: Clears the Storage.
TextChannelInterface::collectMessages() — Method in class TextChannelInterface: Collects messages during a specific duration (and max. amount). Resolves with a Collection of Message instances, mapped by their IDs.
UserStorageInterface::current() — Method in class UserStorageInterface: Returns the current element. From Iterator interface.
$AuditLogEntry#changes — Property in class AuditLogEntry: Specific property changes.
$AuditLogEntry#createdTimestamp — Property in class AuditLogEntry: When this audit log entry was created.
$AuditLogEntry#createdAt — Property in class AuditLogEntry: The DateTime instance of createdTimestamp.
CategoryChannel — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild's category channel.
$CategoryChannel#createdTimestamp — Property in class CategoryChannel: The timestamp of when this channel was created.
$CategoryChannel#createdAt — Property in class CategoryChannel: The DateTime instance of createdTimestamp.
ChannelStorage — Class in namespace CharlotteDunois\Yasmin\Models: Channel Storage to store channels, which utilizes Collection.
ChannelStorage::clear() — Method in class ChannelStorage: Clears the Storage.
ClientBase — Class in namespace CharlotteDunois\Yasmin\Models: Something all Models, with the need for a client, extend.
$ClientBase#client — Property in class ClientBase: The client which initiated the instance.
ClientStatus — Class in namespace CharlotteDunois\Yasmin\Models: Represents an user's client status.
ClientUser — Class in namespace CharlotteDunois\Yasmin\Models: Represents the Client User.
$ClientUser#clientPresence — Property in class ClientUser: The client's presence.
ClientUser::createGroupDM() — Method in class ClientUser: Creates a new Group DM with the owner of the access tokens. Resolves with an instance of GroupDMChannel. The structure of the array is as following:
ClientUser::createDM() — Method in class ClientUser
$DMChannel#createdTimestamp — Property in class DMChannel: The timestamp of when this channel was created.
$DMChannel#createdAt — Property in class DMChannel: The DateTime instance of createdTimestamp.
$Emoji#createdTimestamp — Property in class Emoji: The timestamp of when this emoji was created, or null for unicode emoji.
$Emoji#createdAt — Property in class Emoji: An DateTime instance of the createdTimestamp, or null for unicode emoji.
$Guild#channels — Property in class Guild: Holds a guild's channels, mapped by their ID.
$Guild#createdTimestamp — Property in class Guild: The timestamp when this guild was created.
$Guild#createdAt — Property in class Guild: The DateTime instance of createdTimestamp.
Guild::createChannel() — Method in class Guild: Creates a new channel in the guild. Resolves with an instance of GuildChannelInterface.
Guild::createEmoji() — Method in class Guild: Creates a new custom emoji in the guild. Resolves with an instance of Emoji.
Guild::createRole() — Method in class Guild: Creates a new role in the guild. Resolves with an instance of Role.
$GuildForumChannel#createdTimestamp — Property in class GuildForumChannel: The timestamp of when this channel was created.
$GuildStoreChannel#createdTimestamp — Property in class GuildStoreChannel: The timestamp of when this channel was created.
$GuildStoreChannel#createdAt — Property in class GuildStoreChannel: The DateTime instance of createdTimestamp.
$Invite#code — Property in class Invite: The invite code.
$Invite#channel — Property in class Invite: The channel which this invite belongs to.
$Invite#createdTimestamp — Property in class Invite: When this invite was created, or null.
$Invite#createdAt — Property in class Invite: The DateTime instance of the createdTimestamp, or null.
$Message#channel — Property in class Message: The channel this message was created in.
$Message#content — Property in class Message: The message content.
$Message#createdTimestamp — Property in class Message: The timestamp of when this message was created.
$Message#cleanContent — Property in class Message: The message content with all mentions replaced.
$Message#createdAt — Property in class Message: An DateTime instance of the createdTimestamp.
Message::clearReactions() — Method in class Message: Removes all reactions from the message. Resolves with $this.
Message::collectReactions() — Method in class Message: Collects reactions during a specific duration. Resolves with a Collection of [ $messageReaction, $user ] arrays, mapped by their IDs or names (unicode emojis).
Message::crosspost() — Method in class Message: Crossposts the message. Resolves with $this.
$MessageApplication#coverImage — Property in class MessageApplication: The hash of the application cover image, or null.
$MessageAttachment#createdTimestamp — Property in class MessageAttachment: The timestamp of when this attachment was created.
$MessageAttachment#createdAt — Property in class MessageAttachment: An DateTime instance of the createdTimestamp.
$MessageEmbed#color — Property in class MessageEmbed: The color, or null.
$MessageMentions#channels — Property in class MessageMentions: The collection which holds all channel mentions, mapped by their ID.
$MessageReaction#count — Property in class MessageReaction: Times this emoji has been reacted.
$MessageStorage#channel — Property in class MessageStorage: The channel this storage belongs to.
$PartialChannel#createdTimestamp — Property in class PartialChannel: The timestamp when this channel was created.
$PartialChannel#createdAt — Property in class PartialChannel: The DateTime instance of createdTimestamp.
$PartialGuild#createdTimestamp — Property in class PartialGuild: The timestamp when this guild was created.
$PartialGuild#createdAt — Property in class PartialGuild: The DateTime instance of createdTimestamp.
$PermissionOverwrite#channel — Property in class PermissionOverwrite: The channel this Permission Overwrite belongs to.
$Presence#clientStatus — Property in class Presence: The client's status on desktop/mobile/web, or null.
$Role#color — Property in class Role: The color of the role.
$Role#createdTimestamp — Property in class Role: The timestamp of when the role was created.
$Role#createdAt — Property in class Role: The DateTime instance of createdTimestamp.
Role::comparePositionTo() — Method in class Role: Compares the position from the role to the given role.
$Storage#client — Property in class Storage: The client this storage belongs to.
Storage::copy() — Method in class Storage: Returns a copy of itself. This does not make a copy of the stored data.
$TextChannel#createdTimestamp — Property in class TextChannel: The timestamp of when this channel was created.
$TextChannel#createdAt — Property in class TextChannel: The DateTime instance of createdTimestamp.
TextChannel::createWebhook() — Method in class TextChannel: Create a webhook for the channel. Resolves with the new Webhook instance.
$User#createdTimestamp — Property in class User: The timestamp of when this user was created.
$User#createdAt — Property in class User: An DateTime instance of the createdTimestamp.
User::createDM() — Method in class User: Opens a DM channel to this user. Resolves with an instance of DMChannel.
$VoiceChannel#createdTimestamp — Property in class VoiceChannel: The timestamp of when this channel was created.
VoiceChannel::canSpeak() — Method in class VoiceChannel: Whether the client user can speak in this channel.
$VoiceRegion#custom — Property in class VoiceRegion: Whether the region is custom.
$Webhook#channelID — Property in class Webhook: The channel ID the webhook belongs to.
GuildChannelTrait::createInvite() — Method in class GuildChannelTrait: Creates an invite. Resolves with an instance of Invite.
GuildChannelTrait::clone() — Method in class GuildChannelTrait: Clones a guild channel. Resolves with an instance of GuildChannelInterface.
TextChannelTrait::collectMessages() — Method in class TextChannelTrait: Collects messages during a specific duration (and max. amount). Resolves with a Collection of Message instances, mapped by their IDs.
Collector — Class in namespace CharlotteDunois\Yasmin\Utils: A collector is an util to collect elements from events.
Collector::collect() — Method in class Collector: Starts collecting. Resolves with a collection.
MessageHelpers::cleanContent() — Method in class MessageHelpers: Cleans the text from mentions, by providing a context message.
$ZlibStream#context — Property in class ZlibStream
Etf::convertIDs() — Method in class Etf: Converts all IDs from integer to strings.
ChannelCreate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$ChannelCreate#client — Property in class ChannelCreate: The client.
ChannelDelete — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$ChannelDelete#client — Property in class ChannelDelete: The client.
ChannelPinsUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$ChannelPinsUpdate#client — Property in class ChannelPinsUpdate: The client.
ChannelUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$ChannelUpdate#client — Property in class ChannelUpdate: The client.
$ChannelUpdate#clones — Property in class ChannelUpdate: Whether we do clones.
$GuildBanAdd#client — Property in class GuildBanAdd: The client.
$GuildBanRemove#client — Property in class GuildBanRemove: The client.
$GuildCreate#client — Property in class GuildCreate: The client.
$GuildDelete#client — Property in class GuildDelete: The client.
$GuildEmojisUpdate#client — Property in class GuildEmojisUpdate: The client.
$GuildIntegrationsUpdate#client — Property in class GuildIntegrationsUpdate: The client.
$GuildMemberAdd#client — Property in class GuildMemberAdd: The client.
$GuildMemberRemove#client — Property in class GuildMemberRemove: The client.
$GuildMemberUpdate#client — Property in class GuildMemberUpdate: The client.
$GuildMemberUpdate#clones — Property in class GuildMemberUpdate: Whether we do clones.
$GuildMembersChunk#client — Property in class GuildMembersChunk: The client.
$GuildRoleCreate#client — Property in class GuildRoleCreate: The client.
$GuildRoleDelete#client — Property in class GuildRoleDelete: The client.
$GuildRoleUpdate#client — Property in class GuildRoleUpdate: The client.
$GuildRoleUpdate#clones — Property in class GuildRoleUpdate: Whether we do clones.
$GuildUpdate#client — Property in class GuildUpdate: The client.
$GuildUpdate#clones — Property in class GuildUpdate: Whether we do clones.
$InviteCreate#client — Property in class InviteCreate: The client.
$InviteDelete#client — Property in class InviteDelete: The client.
$MessageCreate#client — Property in class MessageCreate: The client.
$MessageDelete#client — Property in class MessageDelete: The client.
$MessageDeleteBulk#client — Property in class MessageDeleteBulk: The client.
$MessageReactionAdd#client — Property in class MessageReactionAdd: The client.
$MessageReactionRemove#client — Property in class MessageReactionRemove: The client.
$MessageReactionRemoveAll#client — Property in class MessageReactionRemoveAll: The client.
$MessageUpdate#client — Property in class MessageUpdate: The client.
$MessageUpdate#clones — Property in class MessageUpdate: Whether we do clones.
$PresenceUpdate#client — Property in class PresenceUpdate: The client.
$PresenceUpdate#clones — Property in class PresenceUpdate: Whether we do clones.
$Ready#client — Property in class Ready: The client.
$Resumed#client — Property in class Resumed: The client.
$TypingStart#client — Property in class TypingStart: The client.
$UserUpdate#client — Property in class UserUpdate: The client.
$UserUpdate#clones — Property in class UserUpdate: Whether we do clones.
$VoiceServerUpdate#client — Property in class VoiceServerUpdate: The client.
$VoiceStateUpdate#client — Property in class VoiceStateUpdate: The client.
$VoiceStateUpdate#clones — Property in class VoiceStateUpdate: Whether we do clones.
$WSConnection#compressContext — Property in class WSConnection
WSConnection::connect() — Method in class WSConnection: Connects to the gateway url. Resolves with $this.
$WSManager#client — Property in class WSManager
$WSManager#connector — Property in class WSManager
$WSManager#connections — Property in class WSManager
$WSManager#compression — Property in class WSManager
WSManager::connectShard() — Method in class WSManager: Connects the specified shard to the gateway url. Resolves with an instance of WSConnection.
WSManager::createConnection() — Method in class WSManager: Creates a new ws connection for a specific shard, if necessary.
$WebhookClient#channelID — Property in class WebhookClient: The channel the webhook belongs to.

D

Client::destroy() — Method in class Client: Cleanly logs out of Discord.
Client::destroyUtil() — Method in class Client: Destroys an Util and calls destroy (requires that it is registered as such).
Client::destroyUtils() — Method in class Client: Destroys or stops all timers from Utils (requires that they are registered as such).
ClientEvents::disconnect() — Method in class ClientEvents: Emitted when the shard gets disconnected from the gateway.
ClientEvents::debug() — Method in class ClientEvents: Debug messages.
DiscordException — Class in namespace CharlotteDunois\Yasmin: Exception for Discord.
$APIRequest#deferred — Property in class APIRequest: The used deferred.
APIRequest::decodeBody() — Method in class APIRequest: Gets the response body from the response.
DiscordAPIException — Class in namespace CharlotteDunois\Yasmin\HTTP: Represents an error from the Discord HTTP API.
Channel::deleteChannel() — Method in class Channel
Channel::deleteMessage() — Method in class Channel
Channel::deleteMessageUserReaction() — Method in class Channel
Channel::deleteMessageReactions() — Method in class Channel
Channel::deleteMessageReactionsForEmoji() — Method in class Channel
Channel::deleteChannelPermission() — Method in class Channel
Emoji::deleteGuildEmoji() — Method in class Emoji
Guild::deleteGuild() — Method in class Guild
Guild::deleteGuildRole() — Method in class Guild
Guild::deleteGuildIntegration() — Method in class Guild
Invite::deleteInvite() — Method in class Invite
Webhook::deleteWebhook() — Method in class Webhook
Webhook::deleteWebhookToken() — Method in class Webhook
DMChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all direct message channels implement.
GuildChannelInterface::delete() — Method in class GuildChannelInterface: Deletes the channel.
StorageInterface::delete() — Method in class StorageInterface: Removes an item.
WSCompressionInterface::destroy() — Method in class WSCompressionInterface: Destroys the context.
WSCompressionInterface::decompress() — Method in class WSCompressionInterface: Decompresses data.
WSEncodingInterface::decode() — Method in class WSEncodingInterface: Decodes data.
$Activity#details — Property in class Activity: Details about the activity, or null.
ChannelStorage::delete() — Method in class ChannelStorage: Removes an item.
$ClientStatus#desktop — Property in class ClientStatus: The status of the user on the desktop client.
ClientUser::deleteDM() — Method in class ClientUser
DMChannel — Class in namespace CharlotteDunois\Yasmin\Models: Represents a classic DM channel.
Emoji::delete() — Method in class Emoji: Deletes the emoji.
EmojiStorage::delete() — Method in class EmojiStorage: Removes an item.
$Guild#defaultMessageNotifications — Property in class Guild: The type of message that should notify you. ({see Guild::DEFAULT_MESSAGE_NOTIFICATIONS})
$Guild#description — Property in class Guild: Guild description used for Server Discovery, or null.
$Guild#defaultRole — Property in class Guild: The guild's default role.
Guild::delete() — Method in class Guild: Deletes the guild.
$GuildMember#deaf — Property in class GuildMember: Whether the member is server deafened.
$GuildMember#displayName — Property in class GuildMember: The displayed name.
GuildMemberStorage::delete() — Method in class GuildMemberStorage: Removes an item.
GuildStorage::delete() — Method in class GuildStorage: Removes an item.
Invite::delete() — Method in class Invite: Deletes the invite.
Message::delete() — Method in class Message: Deletes the message.
$MessageApplication#description — Property in class MessageApplication: The description of the application.
$MessageEmbed#description — Property in class MessageEmbed: The description, or null.
$MessageEmbed#datetime — Property in class MessageEmbed: The DateTime instance of timestamp, or null.
MessageStorage::delete() — Method in class MessageStorage: Removes an item.
$OAuthApplication#description — Property in class OAuthApplication: The application's description, or null.
$PermissionOverwrite#deny — Property in class PermissionOverwrite: The denied Permissions instance.
PermissionOverwrite::delete() — Method in class PermissionOverwrite: Deletes the permission overwrite.
PresenceStorage::delete() — Method in class PresenceStorage: Removes an item.
Role::delete() — Method in class Role: Deletes the role.
RoleStorage::delete() — Method in class RoleStorage: Removes an item.
Storage::delete() — Method in class Storage: Removes an item.
$User#discriminator — Property in class User: The discriminator of this user.
User::deleteDM() — Method in class User: Deletes an existing DM channel to this user. Resolves with $this.
UserStorage::delete() — Method in class UserStorage: Removes an item.
$VoiceRegion#deprecated — Property in class VoiceRegion: Whether this voice region is deprecated and therefore should be avoided.
Webhook::delete() — Method in class Webhook: Deletes the webhook.
GuildChannelTrait::delete() — Method in class GuildChannelTrait: Deletes the channel.
DataHelpers — Class in namespace CharlotteDunois\Yasmin\Utils: Data Helper methods.
$Snowflake#date — Property in class Snowflake: A DateTime instance of the timestamp.
Snowflake::deconstruct() — Method in class Snowflake: Deconstruct a snowflake.
ZlibStream::destroy() — Method in class ZlibStream: Destroys the context.
ZlibStream::decompress() — Method in class ZlibStream: Decompresses data.
DiscordGatewayException — Class in namespace CharlotteDunois\Yasmin\WebSocket: Represents an exception of the Discord Gateway component.
Etf::decode() — Method in class Etf: Decodes data.
Json::decode() — Method in class Json: Decodes data.
Dispatch — Class in namespace CharlotteDunois\Yasmin\WebSocket\Handlers: WS Event handler
WSConnection::destroy() — Method in class WSConnection: Disconnects.
WSConnection::disconnect() — Method in class WSConnection: Closes the WS connection.
WSManager::destroy() — Method in class WSManager: Disconnects.

E

$Client#emojis — Property in class Client: Holds all emojis, mapped by ID (custom emojis) and/or name (unicode emojis).
$Client#eventsQueue — Property in class Client: Events queue, until client turns ready.
ClientEvents::error() — Method in class ClientEvents: Emitted when an error happens (inside the library or any listeners). You should always listen on this event.
$APIEndpoints#emoji — Property in class APIEndpoints: The emoji endpoints.
$APIManager#endpoints — Property in class APIManager
APIManager::extractFromBucket() — Method in class APIManager: Extracts an item from a ratelimit bucket.
APIManager::execute() — Method in class APIManager: Executes an API Request.
APIManager::extractRatelimit() — Method in class APIManager: Extracts ratelimits from a response.
APIManager::extractRatelimitResetTime() — Method in class APIManager: Returns the ratelimit reset time.
APIRequest::execute() — Method in class APIRequest: Executes the request.
$AthenaRatelimitBucket#endpoint — Property in class AthenaRatelimitBucket: The endpoint.
Channel::editMessage() — Method in class Channel
Channel::editChannelPermissions() — Method in class Channel
Emoji — Class in namespace CharlotteDunois\Yasmin\HTTP\Endpoints: Handles the API endpoints "Emoji".
Webhook::executeWebhook() — Method in class Webhook
$RatelimitBucket#endpoint — Property in class RatelimitBucket: The endpoint.
EmojiStorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all emoji storages implement. The storage also is used as factory.
GuildChannelInterface::edit() — Method in class GuildChannelInterface: Edits the channel. Resolves with $this.
WSEncodingInterface::encode() — Method in class WSEncodingInterface: Encodes data.
$Activity#emoji — Property in class Activity: The emoji of a custom status, or null.
$AuditLog#entries — Property in class AuditLog: Holds the entries, mapped by their ID.
$AuditLogEntry#extra — Property in class AuditLogEntry: Any extra data from the entry, or null.
Emoji — Class in namespace CharlotteDunois\Yasmin\Models: Represents an emoji - both custom and unicode emojis.
Emoji::edit() — Method in class Emoji: Edits the emoji. Resolves with $this.
EmojiStorage — Class in namespace CharlotteDunois\Yasmin\Models: Emoji Storage to store emojis, utilizes Collection.
$Guild#emojis — Property in class Guild: Holds a guild's emojis, mapped by their ID.
$Guild#explicitContentFilter — Property in class Guild: The explicit content filter level of the guild. ({see Guild::EXPLICIT_CONTENT_FILTER})
Guild::edit() — Method in class Guild: Edits the guild. Resolves with $this.
GuildMember::edit() — Method in class GuildMember: Edits the guild member. Resolves with $this.
$Message#editedTimestamp — Property in class Message: The timestamp of when this message was edited, or null.
$Message#embeds — Property in class Message: An array of embeds in the message.
$Message#editedAt — Property in class Message: An DateTime instance of the editedTimestamp, or null.
Message::edit() — Method in class Message: Edits the message. You need to be the author of the message. Resolves with $this.
MessageEmbed::exceedsOverallLimit() — Method in class MessageEmbed: Checks to see if adding a property has put us over Discord's 6000-char overall limit.
$MessageMentions#everyone — Property in class MessageMentions: Whether the message mentions @everyone or @here.
$MessageReaction#emoji — Property in class MessageReaction: The emoji this message reaction is for.
$MessageStorage#enabled — Property in class MessageStorage: Whether the message cache is enabled.
PermissionOverwrite::edit() — Method in class PermissionOverwrite: Edits the permission overwrite. Resolves with $this.
$PresenceStorage#enabled — Property in class PresenceStorage: Whether the presence cache is enabled.
Role::edit() — Method in class Role: Edits the role with the given options. Resolves with $this.
$User#email — Property in class User: An email address or maybe nothing at all. More likely to be nothing at all.
Webhook::edit() — Method in class Webhook: Edits the webhook. Resolves with $this.
Webhook::executeWebhook() — Method in class Webhook: Executes the webhook effectively. Resolves with an instance of Message.
GuildChannelTrait::edit() — Method in class GuildChannelTrait: Edits the channel. Resolves with $this.
$Collector#emitter — Property in class Collector
$Collector#event — Property in class Collector
EventHelpers — Class in namespace CharlotteDunois\Yasmin\Utils: Event Helper methods.
MessageHelpers::escapeMarkdown() — Method in class MessageHelpers: Escapes any Discord-flavour markdown in a string.
Etf — Class in namespace CharlotteDunois\Yasmin\WebSocket\Encoding: Handles WS encoding.
$Etf#etf — Property in class Etf
Etf::encode() — Method in class Etf: Encodes data.
Json::encode() — Method in class Json: Encodes data.
$WSConnection#expectedClose — Property in class WSConnection: If the connection gets closed, did we expect it?
$WSConnection#encoding — Property in class WSConnection
$WSManager#encoding — Property in class WSManager

F

Client::fetchApplication() — Method in class Client: Obtains the OAuth Application of the bot from Discord.
Client::fetchInvite() — Method in class Client: Obtains an invite from Discord. Resolves with an instance of Invite.
Client::fetchUser() — Method in class Client: Fetches an User from the API. Resolves with an User.
Client::fetchVoiceRegions() — Method in class Client: Obtains the available voice regions from Discord. Resolves with a Collection of Voice Region instances, mapped by their ID.
Client::fetchWebhook() — Method in class Client: Fetches a webhook from Discord. Resolves with an instance of Webhook.
APIEndpoints::format() — Method in class APIEndpoints: Formats Endpoints strings.
DiscordAPIException::flattenErrors() — Method in class DiscordAPIException: Flattens an errors object returned from the API into an array.
ChannelStorageInterface::factory() — Method in class ChannelStorageInterface: Factory to create (or retrieve existing) channels.
EmojiStorageInterface::factory() — Method in class EmojiStorageInterface: Factory to create (or retrieve existing) emojis.
GuildMemberStorageInterface::factory() — Method in class GuildMemberStorageInterface: Factory to create (or retrieve existing) guild members.
GuildNewsChannelInterface::fetchInvites() — Method in class GuildNewsChannelInterface: Fetches all invites of this channel. Resolves with a Collection of Invite instances, mapped by their code.
GuildStorageInterface::factory() — Method in class GuildStorageInterface: Factory to create (or retrieve existing) guilds.
GuildTextChannelInterface::fetchInvites() — Method in class GuildTextChannelInterface: Fetches all invites of this channel. Resolves with a Collection of Invite instances, mapped by their code.
PresenceStorageInterface::factory() — Method in class PresenceStorageInterface: Factory to create presences.
RoleStorageInterface::factory() — Method in class RoleStorageInterface: Factory to create (or retrieve existing) roles.
StorageInterface::filter() — Method in class StorageInterface: Filters the storage by a given callback, keeping only those items that pass a given truth test. Returns a new Storage instance.
StorageInterface::first() — Method in class StorageInterface: Returns the first element that passes a given truth test.
TextChannelInterface::fetchMessage() — Method in class TextChannelInterface: Fetches a specific message using the ID. Resolves with an instance of Message.
TextChannelInterface::fetchMessages() — Method in class TextChannelInterface: Fetches messages of this channel. Resolves with a Collection of Message instances, mapped by their ID.
UserStorageInterface::factory() — Method in class UserStorageInterface: Factory to create (or retrieve existing) users.
$Activity#flags — Property in class Activity: The activity flags (as bitfield), like if an activity is a spectate activity.
ChannelStorage::factory() — Method in class ChannelStorage: Factory to create (or retrieve existing) channels.
ClientUser::fetchUserConnections() — Method in class ClientUser
EmojiStorage::factory() — Method in class EmojiStorage: Factory to create (or retrieve existing) emojis.
$Guild#features — Property in class Guild: An array of guild features.
Guild::fetchAuditLog() — Method in class Guild: Fetch audit log for the guild. Resolves with an instance of AuditLog.
Guild::fetchBan() — Method in class Guild: Fetches a specific ban for a user. Resolves with an instance of GuildBan.
Guild::fetchBans() — Method in class Guild: Fetch all bans of the guild. Resolves with a Collection of GuildBan instances, mapped by the user ID.
Guild::fetchInvites() — Method in class Guild: Fetches all invites of the guild. Resolves with a Collection of Invite instances, mapped by their code.
Guild::fetchMember() — Method in class Guild: Fetches a specific guild member. Resolves with an instance of GuildMember.
Guild::fetchMembers() — Method in class Guild: Fetches all guild members. If $query is used, $limit must be set to a non-zero integer. Resolves with $this.
Guild::fetchPruneMembers() — Method in class Guild: Fetches the amount of members from the guild based on how long they have been inactive which would be pruned. Resolves with an integer.
Guild::fetchVanityInvite() — Method in class Guild: Returns the vanity invite. The guild must be partnered, i.e. have 'VANITY_URL' in guild features. Resolves with an instance of Invite.
Guild::fetchVoiceRegions() — Method in class Guild: Fetches the guild voice regions. Resolves with a Collection of Voice Region instances, mapped by their ID.
Guild::fetchWebhooks() — Method in class Guild: Fetches the guild's webhooks. Resolves with a Collection of Webhook instances, mapped by their ID.
GuildMemberStorage::factory() — Method in class GuildMemberStorage: Factory to create (or retrieve existing) guild members.
GuildStorage::factory() — Method in class GuildStorage: Factory to create (or retrieve existing) guilds.
Message::fetchWebhook() — Method in class Message: Fetches the webhook used to create this message. Resolves with an instance of Webhook.
$MessageAttachment#filename — Property in class MessageAttachment: The filename.
$MessageEmbed#footer — Property in class MessageEmbed: The footer in the format [ 'name' => string, 'icon' => string ], or null.
$MessageEmbed#fields — Property in class MessageEmbed: An array of embed fields in the format [ 'name' > string, 'value' => string, 'inline' => bool ].
MessageReaction::fetchUsers() — Method in class MessageReaction: Fetches all the users that gave this reaction. Resolves with a Collection of User instances, mapped by their IDs.
PresenceStorage::factory() — Method in class PresenceStorage: Factory to create presences.
RoleStorage::factory() — Method in class RoleStorage: Factory to create (or retrieve existing) roles.
Storage::filter() — Method in class Storage: Filters the storage by a given callback, keeping only those items that pass a given truth test. Returns a new Storage instance.
TextChannel::fetchWebhooks() — Method in class TextChannel: Fetches the channel's webhooks. Resolves with a Collection of Webhook instances, mapped by their ID.
User::fetchUserConnections() — Method in class User: Fetches the User's connections. Requires connections scope. Resolves with a Collection of UserConnection instances, mapped by their ID.
UserStorage::factory() — Method in class UserStorage: Factory to create (or retrieve existing) users.
$VoiceChannel#full — Property in class VoiceChannel: Checks if the voice channel is full.
GuildChannelTrait::fetchInvites() — Method in class GuildChannelTrait: Fetches all invites of this channel. Resolves with a Collection of Invite instances, mapped by their code.
TextChannelTrait::fetchMessage() — Method in class TextChannelTrait: Fetches a specific message using the ID. Resolves with an instance of Message.
TextChannelTrait::fetchMessages() — Method in class TextChannelTrait: Fetches messages of this channel. Resolves with a Collection of Message instances, mapped by their ID.
$Collector#filter — Property in class Collector
FileHelpers — Class in namespace CharlotteDunois\Yasmin\Utils: File Helper methods.
$FileHelpers#filesystem — Property in class FileHelpers

G

$Client#guilds — Property in class Client: Holds all guilds, mapped by ID.
$Client#gateway — Property in class Client: Gateway address information.
Client::getLoop() — Method in class Client: Get the React Event Loop that is stored in this class.
Client::getOption() — Method in class Client: Get a specific option, or the default value.
Client::getPing() — Method in class Client: Calculates the average ping. Or NAN.
Client::getWSstatus() — Method in class Client: Returns the computed WS status across all shards.
Client::generateOAuthInvite() — Method in class Client: Generates a link that can be used to invite the bot to a guild. Resolves with a string.
Client::getAllIntents() — Method in class Client
Client::getUtils() — Method in class Client: Returns an array of classes with are registered as Util.
ClientEvents::guildCreate() — Method in class ClientEvents: Emitted when a guild gets joined.
ClientEvents::guildUpdate() — Method in class ClientEvents: Emitted when a guild gets updated.
ClientEvents::guildDelete() — Method in class ClientEvents: Emitted when a guild gets left.
ClientEvents::guildUnavailable() — Method in class ClientEvents: Emitted when a guild becomes (un)available.
ClientEvents::guildBanAdd() — Method in class ClientEvents: Emitted when someone gets banned.
ClientEvents::guildBanRemove() — Method in class ClientEvents: Emitted when someone gets unbanned.
ClientEvents::guildMemberAdd() — Method in class ClientEvents: Emitted when an user joins a guild.
ClientEvents::guildMemberUpdate() — Method in class ClientEvents: Emitted when a member gets updated.
ClientEvents::guildMemberRemove() — Method in class ClientEvents: Emitted when an user leaves a guild.
ClientEvents::guildMembersChunk() — Method in class ClientEvents: Emitted when the gateway sends requested members. The collection consists of GuildMember instances, mapped by their user ID.
$APIEndpoints#guild — Property in class APIEndpoints: The guild endpoints.
APIEndpoints::getCurrentApplication() — Method in class APIEndpoints: Gets the current OAuth application.
APIManager::getGateway() — Method in class APIManager: Gets the Gateway from the Discord API.
APIManager::getRatelimitEndpoint() — Method in class APIManager: Turns an endpoint path to the ratelimit path.
APIManager::getRatelimitBucket() — Method in class APIManager: Gets the ratelimit bucket for the specific endpoint.
APIRequest::getMethod() — Method in class APIRequest: Returns the request method.
APIRequest::getEndpoint() — Method in class APIRequest: Returns the endpoint path.
AthenaRatelimitBucket::getEndpoint() — Method in class AthenaRatelimitBucket: Returns the endpoint this bucket is for.
AthenaRatelimitBucket::getMeta() — Method in class AthenaRatelimitBucket: Retrieves ratelimit meta data.
AthenaRatelimitBucket::get() — Method in class AthenaRatelimitBucket: Retrieves the cache data.
Channel::getChannel() — Method in class Channel
Channel::getChannelMessages() — Method in class Channel
Channel::getChannelMessage() — Method in class Channel
Channel::getMessageReactions() — Method in class Channel
Channel::getChannelInvites() — Method in class Channel
Channel::getPinnedChannelMessages() — Method in class Channel
Channel::groupDMAddRecipient() — Method in class Channel
Channel::groupDMRemoveRecipient() — Method in class Channel
Emoji::getGuildEmoji() — Method in class Emoji
Guild — Class in namespace CharlotteDunois\Yasmin\HTTP\Endpoints: Handles the API endpoints "Guild".
Guild::getGuild() — Method in class Guild
Guild::getGuildChannels() — Method in class Guild
Guild::getGuildMember() — Method in class Guild
Guild::getGuildBan() — Method in class Guild
Guild::getGuildBans() — Method in class Guild
Guild::getGuildRoles() — Method in class Guild
Guild::getGuildPruneCount() — Method in class Guild
Guild::getGuildVoiceRegions() — Method in class Guild
Guild::getGuildInvites() — Method in class Guild
Guild::getGuildIntegrations() — Method in class Guild
Guild::getGuildEmbed() — Method in class Guild
Guild::getGuildAuditLog() — Method in class Guild
Guild::getGuildVanityURL() — Method in class Guild
Invite::getInvite() — Method in class Invite
User::getCurrentUser() — Method in class User
User::getUser() — Method in class User
User::getCurrentUserGuilds() — Method in class User
User::getUserDMs() — Method in class User
User::getUserConnections() — Method in class User
Webhook::getChannelWebhooks() — Method in class Webhook
Webhook::getGuildsWebhooks() — Method in class Webhook
Webhook::getWebhook() — Method in class Webhook
Webhook::getWebhookToken() — Method in class Webhook
RatelimitBucket::getEndpoint() — Method in class RatelimitBucket: Returns the endpoint this bucket is for.
RatelimitBucket::getMeta() — Method in class RatelimitBucket: Retrieves ratelimit meta data.
ChannelInterface::getId() — Method in class ChannelInterface: Gets the channel's ID.
ChannelInterface::getCreatedTimestamp() — Method in class ChannelInterface: Gets the timestamp of when this channel was created.
ChannelStorageInterface::get() — Method in class ChannelStorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
EmojiStorageInterface::get() — Method in class EmojiStorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
GroupDMChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all group direct message channels implement.
GuildChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all guild channels implement.
GuildChannelInterface::getName() — Method in class GuildChannelInterface: Gets the channel's name.
GuildChannelInterface::getGuild() — Method in class GuildChannelInterface: Gets the associated guild.
GuildChannelInterface::getPosition() — Method in class GuildChannelInterface: Gets the channel's position.
GuildChannelInterface::getPermissionOverwrites() — Method in class GuildChannelInterface: Gets the channel's permission overwrites.
GuildChannelInterface::getParent() — Method in class GuildChannelInterface: Gets the channel's parent, or null.
GuildMemberStorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all guild member storages implement. The storage also is used as factory.
GuildMemberStorageInterface::get() — Method in class GuildMemberStorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
GuildNewsChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all guild news channels implement.
GuildStorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all guild storages implement. The storage also is used as factory.
GuildStorageInterface::get() — Method in class GuildStorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
GuildStoreChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all guild store channels implement.
GuildTextChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all guild text channels implement.
GuildVoiceChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all guild voice channels implement.
MessageStorageInterface::get() — Method in class MessageStorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
PresenceStorageInterface::get() — Method in class PresenceStorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
RatelimitBucketInterface::getEndpoint() — Method in class RatelimitBucketInterface: Returns the endpoint this bucket is for.
RatelimitBucketInterface::getMeta() — Method in class RatelimitBucketInterface: Retrieves ratelimit meta data.
RoleStorageInterface::get() — Method in class RoleStorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
StorageInterface::get() — Method in class StorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
TextChannelInterface::getMessages() — Method in class TextChannelInterface: Gets the storage with all cached messages.
TextChannelInterface::getLastMessageID() — Method in class TextChannelInterface: Gets the ID of the last sent message in this channel.
UserStorageInterface::get() — Method in class UserStorageInterface: Returns the item at a given key. If the key does not exist, null is returned.
WSCompressionInterface::getName() — Method in class WSCompressionInterface: Returns compression name (for gateway query string).
WSEncodingInterface::getName() — Method in class WSEncodingInterface: Returns encoding name (for gateway query string).
$AuditLog#guild — Property in class AuditLog: Which guild this audit log is for.
AuditLogEntry::getActionType() — Method in class AuditLogEntry: Finds the action type from the entry action.
AuditLogEntry::getTargetType() — Method in class AuditLogEntry: Finds the target type from the entry action.
$CategoryChannel#guild — Property in class CategoryChannel: The guild this category channel belongs to.
CategoryChannel::getChildren() — Method in class CategoryChannel: Returns all channels which are childrens of this category.
ChannelStorage::get() — Method in class ChannelStorage: Returns the item at a given key. If the key does not exist, null is returned.
ChannelStorage::getTypeForChannel() — Method in class ChannelStorage: Get the type for the channel.
$Emoji#guild — Property in class Emoji: The guild this emoji belongs to, or null.
Emoji::getImageURL() — Method in class Emoji: Get the image URL of the custom emoji.
$EmojiStorage#guild — Property in class EmojiStorage: The guild this storage belongs to.
EmojiStorage::get() — Method in class EmojiStorage: Returns the item at a given key. If the key does not exist, null is returned.
GroupDMChannel — Class in namespace CharlotteDunois\Yasmin\Models: Represents a Group DM channel.
GroupDMChannel::getIconURL() — Method in class GroupDMChannel: Returns the group DM's icon URL, or null.
Guild — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild. It's recommended to see if a guild is available before performing operations or reading data from it.
Guild::getBannerURL() — Method in class Guild: Returns the guild's banner URL, or null.
Guild::getIconURL() — Method in class Guild: Returns the guild's icon URL, or null.
Guild::getNameAcronym() — Method in class Guild: Returns the guild's name acronym.
Guild::getSplashURL() — Method in class Guild: Returns the guild's splash URL, or null.
GuildBan — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild ban.
$GuildBan#guild — Property in class GuildBan: The guild this ban is from.
GuildForumChannel — Class in namespace CharlotteDunois\Yasmin\Models
$GuildForumChannel#guild — Property in class GuildForumChannel: The associated guild.
GuildMember — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild member.
$GuildMember#guild — Property in class GuildMember: The guild this member belongs to.
GuildMember::getGuildAvatarURL() — Method in class GuildMember: Get the guild avatar URL.
GuildMember::getDisplayAvatarURL() — Method in class GuildMember: Get the URL of the displayed avatar.
GuildMember::getGuildBannerURL() — Method in class GuildMember: Get the guild banner URL. Currently not exposed to bots.
GuildMember::getDisplayBannerURL() — Method in class GuildMember: Get the URL of the displayed banner. Currently not exposed to bots.
GuildMember::getColorRole() — Method in class GuildMember: Gets the role the member is displayed with.
GuildMember::getDisplayColor() — Method in class GuildMember: Gets the displayed color of the member.
GuildMember::getDisplayHexColor() — Method in class GuildMember: Gets the displayed color of the member as hex string.
GuildMember::getHighestRole() — Method in class GuildMember: Gets the highest role of the member.
GuildMember::getHoistRole() — Method in class GuildMember: Gets the role the member is hoisted with.
GuildMemberStorage — Class in namespace CharlotteDunois\Yasmin\Models: Guild Member Storage to store guild members, utilizes Collection.
$GuildMemberStorage#guild — Property in class GuildMemberStorage: The guild this storage belongs to.
GuildMemberStorage::get() — Method in class GuildMemberStorage: Returns the item at a given key. If the key does not exist, null is returned.
GuildStorage — Class in namespace CharlotteDunois\Yasmin\Models: Guild Storage to store guilds, utilizes Collection.
GuildStorage::get() — Method in class GuildStorage: Returns the item at a given key. If the key does not exist, null is returned.
GuildStoreChannel — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild's store channel.
$GuildStoreChannel#guild — Property in class GuildStoreChannel: The associated guild.
$Invite#guild — Property in class Invite: The guild which this invite belongs to, or null.
$Message#guild — Property in class Message: The correspondending guild (if message posted in a guild), or null.
Message::getJumpURL() — Method in class Message: Returns the jump to message link for this message.
MessageApplication::getCoverImageURL() — Method in class MessageApplication: Returns the URL of the cover image.
MessageStorage::get() — Method in class MessageStorage: Returns the item at a given key. If the key does not exist, null is returned.
OAuthApplication::getIconURL() — Method in class OAuthApplication: Returns the application's icon URL, or null.
PartialChannel::getIconURL() — Method in class PartialChannel: Returns the group DM's icon URL, or null.
PartialGuild::getIconURL() — Method in class PartialGuild: Returns the guild's icon URL, or null.
PartialGuild::getSplashURL() — Method in class PartialGuild: Returns the guild's splash URL, or null.
$PermissionOverwrite#guild — Property in class PermissionOverwrite: The guild this Permission Overwrite belongs to.
PresenceStorage::get() — Method in class PresenceStorage: Returns the item at a given key. If the key does not exist, null is returned.
RichPresenceAssets::getLargeImageURL() — Method in class RichPresenceAssets: Returns the URL of the large image.
RichPresenceAssets::getSmallImageURL() — Method in class RichPresenceAssets: Returns the URL of the small image.
$Role#guild — Property in class Role: The guild the role belongs to.
Role::getCalculatedPosition() — Method in class Role: Calculates the positon of the role in the Discord client.
$RoleStorage#guild — Property in class RoleStorage: The guild this storage belongs to.
RoleStorage::get() — Method in class RoleStorage: Returns the item at a given key. If the key does not exist, null is returned.
Storage::get() — Method in class Storage: Returns the item at a given key. If the key does not exist, null is returned.
$TextChannel#guild — Property in class TextChannel: The associated guild.
User::getDefaultAvatarURL() — Method in class User: Get the default avatar URL.
User::getAvatarURL() — Method in class User: Get the avatar URL.
User::getBannerURL() — Method in class User: Get the banner URL. Note that discord does not currently expose this to bots 🙃
User::getDisplayAvatarURL() — Method in class User: Get the URL of the displayed avatar.
User::getPresence() — Method in class User: Gets the presence for this user, or null.
UserStorage::get() — Method in class UserStorage: Returns the item at a given key. If the key does not exist, null is returned.
$VoiceChannel#guild — Property in class VoiceChannel: The guild the channel is in.
$Webhook#guildID — Property in class Webhook: The guild ID the webhook belongs to, or null.
GuildChannelTrait — Class in namespace CharlotteDunois\Yasmin\Traits: The trait all guild channels use.
TextChannelTrait::getLastMessage() — Method in class TextChannelTrait: Gets the last message in this channel if cached, or null.
FileHelpers::getFilesystem() — Method in class FileHelpers: Returns the stored React Filesystem instance, or null.
ImageHelpers::getImageExtension() — Method in class ImageHelpers: Returns the default extension for an image.
Snowflake::generate() — Method in class Snowflake: Generates a new snowflake.
Snowflake::getShardID() — Method in class Snowflake: Compute the shard ID from the snowflake.
URLHelpers::getHTTPClient() — Method in class URLHelpers: Returns the client. This method may be changed at any time.
ZlibStream::getName() — Method in class ZlibStream: Returns compression name (for gateway query string).
Etf::getName() — Method in class Etf: Returns encoding name (for gateway query string).
Json::getName() — Method in class Json: Returns encoding name (for gateway query string).
GuildBanAdd — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildBanRemove — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildCreate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildDelete — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildEmojisUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildIntegrationsUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildMemberAdd — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildMemberRemove — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildMemberUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildMembersChunk — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildRoleCreate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildRoleDelete — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildRoleUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
GuildUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
Dispatch::getEvent() — Method in class Dispatch: Returns a WS event.
WSConnection::getSessionID() — Method in class WSConnection: Get the session ID.
WSHandler::getHandler() — Method in class WSHandler: Returns a WS handler.
$WSManager#gateway — Property in class WSManager
$WSManager#gatewayQS — Property in class WSManager: The WS gateway query string.
$WebhookClient#guildID — Property in class WebhookClient: The guild the webhook belongs to, or null.

H

Client::handlePromiseRejection() — Method in class Client: Emits an error for an unhandled promise rejection.
APIManager::handleRatelimit() — Method in class APIManager: Handles ratelimits.
APIRequest::handleAPIError() — Method in class APIRequest: Handles an API error.
AthenaRatelimitBucket::handleRatelimit() — Method in class AthenaRatelimitBucket: Sets the ratelimits from the response
RatelimitBucket::handleRatelimit() — Method in class RatelimitBucket: Sets the ratelimits from the response.
ChannelStorageInterface::has() — Method in class ChannelStorageInterface: Determines if a given key exists in the collection.
EmojiStorageInterface::has() — Method in class EmojiStorageInterface: Determines if a given key exists in the collection.
GuildMemberStorageInterface::has() — Method in class GuildMemberStorageInterface: Determines if a given key exists in the collection.
GuildStorageInterface::has() — Method in class GuildStorageInterface: Determines if a given key exists in the collection.
MessageStorageInterface::has() — Method in class MessageStorageInterface: Determines if a given key exists in the collection.
PresenceStorageInterface::has() — Method in class PresenceStorageInterface: Determines if a given key exists in the collection.
RatelimitBucketInterface::handleRatelimit() — Method in class RatelimitBucketInterface: Sets the ratelimits from the response.
StorageInterface::has() — Method in class StorageInterface: Determines if a given key exists in the collection.
UserStorageInterface::has() — Method in class UserStorageInterface: Determines if a given key exists in the collection.
WSEventInterface::handle() — Method in class WSEventInterface: Handles events.
WSHandlerInterface::handle() — Method in class WSHandlerInterface: Handles packets.
ChannelStorage::has() — Method in class ChannelStorage: Determines if a given key exists in the collection.
EmojiStorage::has() — Method in class EmojiStorage: Determines if a given key exists in the collection.
GuildMemberStorage::has() — Method in class GuildMemberStorage: Determines if a given key exists in the collection.
GuildStorage::has() — Method in class GuildStorage: Determines if a given key exists in the collection.
$MessageAttachment#height — Property in class MessageAttachment: The height (if image), or null.
MessageStorage::has() — Method in class MessageStorage: Determines if a given key exists in the collection.
Permissions::has() — Method in class Permissions: Checks if a given permission is granted.
PresenceStorage::has() — Method in class PresenceStorage: Determines if a given key exists in the collection.
$Role#hoist — Property in class Role: Whether the role gets displayed separately in the member list.
$Role#hexColor — Property in class Role: Returns the hex color of the role color.
RoleStorage::has() — Method in class RoleStorage: Determines if a given key exists in the collection.
Storage::has() — Method in class Storage: Determines if a given key exists in the collection.
UserStorage::has() — Method in class UserStorage: Determines if a given key exists in the collection.
$Collector#handler — Property in class Collector
$URLHelpers#http — Property in class URLHelpers
ChannelCreate::handle() — Method in class ChannelCreate: Handles events.
ChannelDelete::handle() — Method in class ChannelDelete: Handles events.
ChannelPinsUpdate::handle() — Method in class ChannelPinsUpdate: Handles events.
ChannelUpdate::handle() — Method in class ChannelUpdate: Handles events.
GuildBanAdd::handle() — Method in class GuildBanAdd: Handles events.
GuildBanRemove::handle() — Method in class GuildBanRemove: Handles events.
GuildCreate::handle() — Method in class GuildCreate: Handles events.
GuildDelete::handle() — Method in class GuildDelete: Handles events.
GuildEmojisUpdate::handle() — Method in class GuildEmojisUpdate: Handles events.
GuildIntegrationsUpdate::handle() — Method in class GuildIntegrationsUpdate: Handles events.
GuildMemberAdd::handle() — Method in class GuildMemberAdd: Handles events.
GuildMemberRemove::handle() — Method in class GuildMemberRemove: Handles events.
GuildMemberUpdate::handle() — Method in class GuildMemberUpdate: Handles events.
GuildMembersChunk::handle() — Method in class GuildMembersChunk: Handles events.
GuildRoleCreate::handle() — Method in class GuildRoleCreate: Handles events.
GuildRoleDelete::handle() — Method in class GuildRoleDelete: Handles events.
GuildRoleUpdate::handle() — Method in class GuildRoleUpdate: Handles events.
GuildUpdate::handle() — Method in class GuildUpdate: Handles events.
InviteCreate::handle() — Method in class InviteCreate: Handles events.
InviteDelete::handle() — Method in class InviteDelete: Handles events.
MessageCreate::handle() — Method in class MessageCreate: Handles events.
MessageDelete::handle() — Method in class MessageDelete: Handles events.
MessageDeleteBulk::handle() — Method in class MessageDeleteBulk: Handles events.
MessageReactionAdd::handle() — Method in class MessageReactionAdd: Handles events.
MessageReactionRemove::handle() — Method in class MessageReactionRemove: Handles events.
MessageReactionRemoveAll::handle() — Method in class MessageReactionRemoveAll: Handles events.
MessageUpdate::handle() — Method in class MessageUpdate: Handles events.
PresenceUpdate::handle() — Method in class PresenceUpdate: Handles events.
Ready::handle() — Method in class Ready: Handles events.
Resumed::handle() — Method in class Resumed: Handles events.
TypingStart::handle() — Method in class TypingStart: Handles events.
UserUpdate::handle() — Method in class UserUpdate: Handles events.
VoiceServerUpdate::handle() — Method in class VoiceServerUpdate: Handles events.
VoiceStateUpdate::handle() — Method in class VoiceStateUpdate: Handles events.
Dispatch::handle() — Method in class Dispatch: Handles packets.
Heartbeat — Class in namespace CharlotteDunois\Yasmin\WebSocket\Handlers: WS Event handler
$Heartbeat#heartbeat — Property in class Heartbeat
Heartbeat::handle() — Method in class Heartbeat: Handles packets.
HeartbeatAck — Class in namespace CharlotteDunois\Yasmin\WebSocket\Handlers: WS Event handler
HeartbeatAck::handle() — Method in class HeartbeatAck: Handles packets.
Hello — Class in namespace CharlotteDunois\Yasmin\WebSocket\Handlers: WS Event handler
Hello::handle() — Method in class Hello: Handles packets.
InvalidSession::handle() — Method in class InvalidSession: Handles packets.
Reconnect::handle() — Method in class Reconnect: Handles packets.
$WSConnection#heartbeat — Property in class WSConnection
WSConnection::heartbeat() — Method in class WSConnection: Sends a heartbeat.
WSConnection::heartFailure() — Method in class WSConnection: Handles heart failures.
$WSHandler#handlers — Property in class WSHandler: The handlers for WS messages, mapped by name.
WSHandler::handle() — Method in class WSHandler: Handles a message.
WSManager::handleConnectEncoding() — Method in class WSManager: Handles the connect encoding for the query string.
WSManager::handleConnectGateway() — Method in class WSManager: Handles the connect gateway URL in terms to the query string.

I

ClientEvents::inviteCreate() — Method in class ClientEvents: Emitted when an invite is created
ClientEvents::inviteDelete() — Method in class ClientEvents: Emitted when an invite is deleted
$APIEndpoints#invite — Property in class APIEndpoints: The invite endpoints.
APIRequest::isReactionEndpoint() — Method in class APIRequest: Returns whether this request is to a reaction endpoint.
AthenaRatelimitBucket::isBusy() — Method in class AthenaRatelimitBucket: Whether we are busy.
Invite — Class in namespace CharlotteDunois\Yasmin\HTTP\Endpoints: Handles the API endpoints "Invite".
RatelimitBucket::isBusy() — Method in class RatelimitBucket: Whether we are busy.
DMChannelInterface::isRecipient() — Method in class DMChannelInterface: Determines whether a given user is a recipient of this channel.
RatelimitBucketInterface::isBusy() — Method in class RatelimitBucketInterface: Whether we are busy.
StorageInterface::indexOf() — Method in class StorageInterface: Returns the position of the given value in the storage. Returns null if the given value couldn't be found.
TextChannelInterface::isTyping() — Method in class TextChannelInterface: Determines whether the given user is typing in this channel or not.
WSCompressionInterface::isPayloadCompression() — Method in class WSCompressionInterface: Returns a boolean for the OP code 2 IDENTIFY packet 'compress' parameter. The parameter is for payload compression.
WSCompressionInterface::init() — Method in class WSCompressionInterface: Initializes the context.
Activity::isRichPresence() — Method in class Activity: Whether this activity is a rich presence.
$AuditLogEntry#id — Property in class AuditLogEntry: The ID of the audit log.
$CategoryChannel#id — Property in class CategoryChannel: The ID of the channel.
$DMChannel#id — Property in class DMChannel: The channel ID.
DMChannel::isRecipient() — Method in class DMChannel: Determines whether a given user is a recipient of this channel.
$Emoji#id — Property in class Emoji: The emoji ID, or null for unicode emoji.
$Emoji#identifier — Property in class Emoji: The identifier for the emoji.
$GroupDMChannel#icon — Property in class GroupDMChannel: The icon of the Group DM channel.
$Guild#id — Property in class Guild: The guild ID.
$Guild#icon — Property in class Guild: The guild icon hash, or null.
$GuildForumChannel#id — Property in class GuildForumChannel: The channel ID.
$GuildMember#id — Property in class GuildMember: The ID of the member.
GuildMember::isBannable() — Method in class GuildMember: Whether the member can be banned by the client user.
GuildMember::isKickable() — Method in class GuildMember: Whether the member can be kicked by the client user.
$GuildStoreChannel#id — Property in class GuildStoreChannel: The channel ID.
Invite — Class in namespace CharlotteDunois\Yasmin\Models: Represents an invite.
$Invite#inviter — Property in class Invite: The inviter, or null.
$Message#id — Property in class Message: The message ID.
$MessageApplication#id — Property in class MessageApplication: The ID of the application.
$MessageApplication#icon — Property in class MessageApplication: The hash of the application icon, or null.
$MessageAttachment#id — Property in class MessageAttachment: The attachment ID.
$MessageEmbed#image — Property in class MessageEmbed: The image in the format [ 'url' => string, 'height' => int, 'width' => int ], or null.
$OAuthApplication#id — Property in class OAuthApplication: The application ID.
$OAuthApplication#icon — Property in class OAuthApplication: The hash of the application hash, or null.
$PartialChannel#id — Property in class PartialChannel: The channel ID.
$PartialChannel#icon — Property in class PartialChannel: The icon of the channel, or null.
$PartialGuild#id — Property in class PartialGuild: The guild ID.
$PartialGuild#icon — Property in class PartialGuild: The guild icon, or null.
$PermissionOverwrite#id — Property in class PermissionOverwrite: The ID of the Permission Overwrite.
$Role#id — Property in class Role: The role ID.
Role::isEditable() — Method in class Role: Whether the role can be edited by the client user.
$Shard#id — Property in class Shard: The shard ID.
$TextChannel#id — Property in class TextChannel: The channel ID.
$User#id — Property in class User: The user ID.
$UserConnection#id — Property in class UserConnection: The ID of the connection account.
$VoiceChannel#id — Property in class VoiceChannel: The ID of the channel.
$VoiceRegion#id — Property in class VoiceRegion: The ID of the region.
$Webhook#id — Property in class Webhook: The webhook ID.
GuildChannelTrait::isPermissionsLocked() — Method in class GuildChannelTrait: Whether the permission overwrites match the parent channel (permissions synced).
TextChannelTrait::isTyping() — Method in class TextChannelTrait: Determines whether the given user is typing in this channel or not.
TextChannelTrait::isTypingSince() — Method in class TextChannelTrait: Determines whether how long the given user has been typing in this channel. Returns -1 if the user is not typing.
ImageHelpers — Class in namespace CharlotteDunois\Yasmin\Utils: Image Helper utilities.
ImageHelpers::isPowerOfTwo() — Method in class ImageHelpers: Returns whether the input number is a power of 2.
$Snowflake#incrementIndex — Property in class Snowflake
$Snowflake#incrementTime — Property in class Snowflake
$Snowflake#increment — Property in class Snowflake: The increment index of the snowflake.
URLHelpers::internalSetClient() — Method in class URLHelpers: Sets the client.
ZlibStream::isPayloadCompression() — Method in class ZlibStream: Returns a boolean for the OP code 2 IDENTIFY packet 'compress' parameter. The parameter is for payload compression.
ZlibStream::init() — Method in class ZlibStream: Initializes the context.
InviteCreate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
InviteDelete — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$PresenceUpdate#ignoreUnknown — Property in class PresenceUpdate: Whether we ignore events from unknown users.
InvalidSession — Class in namespace CharlotteDunois\Yasmin\WebSocket\Handlers: WS Event handler
WSConnection::initWS() — Method in class WSConnection: Initializes the websocet.
WSConnection::initWSSelfReady() — Method in class WSConnection: Returns the handler for self.ready event.
WSConnection::initWSSelfError() — Method in class WSConnection: Returns the handler for self.error event.
WSConnection::initWSMessage() — Method in class WSConnection: Returns the handler for message event.
WSConnection::initWSError() — Method in class WSConnection: Returns the handler for error event.
WSConnection::initWSClose() — Method in class WSConnection: Returns the handler for close event.
$WebhookClient#id — Property in class WebhookClient: The webhook ID.

J

$APIRequest#jsonOptions — Property in class APIRequest: The JSON encode/decode options.
Activity::jsonSerialize() — Method in class Activity
AuditLogEntry::jsonSerialize() — Method in class AuditLogEntry
Base::jsonSerialize() — Method in class Base
ClientBase::jsonSerialize() — Method in class ClientBase
ClientStatus::jsonSerialize() — Method in class ClientStatus
$GuildMember#joinedTimestamp — Property in class GuildMember: The timestamp of when this member joined.
$GuildMember#joinedAt — Property in class GuildMember: An DateTime instance of joinedTimestamp.
PermissionOverwrite::jsonSerialize() — Method in class PermissionOverwrite
Permissions::jsonSerialize() — Method in class Permissions
Presence::jsonSerialize() — Method in class Presence
RichPresenceAssets::jsonSerialize() — Method in class RichPresenceAssets
Json — Class in namespace CharlotteDunois\Yasmin\WebSocket\Encoding: Handles WS encoding.

K

ChannelStorageInterface::key() — Method in class ChannelStorageInterface: Fetch the key from the current element. From Iterator interface.
EmojiStorageInterface::key() — Method in class EmojiStorageInterface: Fetch the key from the current element. From Iterator interface.
GuildMemberStorageInterface::key() — Method in class GuildMemberStorageInterface: Fetch the key from the current element. From Iterator interface.
GuildStorageInterface::key() — Method in class GuildStorageInterface: Fetch the key from the current element. From Iterator interface.
MessageStorageInterface::key() — Method in class MessageStorageInterface: Fetch the key from the current element. From Iterator interface.
PresenceStorageInterface::key() — Method in class PresenceStorageInterface: Fetch the key from the current element. From Iterator interface.
RoleStorageInterface::key() — Method in class RoleStorageInterface: Fetch the key from the current element. From Iterator interface.
StorageInterface::key() — Method in class StorageInterface: Fetch the key from the current element. From Iterator interface.
UserStorageInterface::key() — Method in class UserStorageInterface: Fetch the key from the current element. From Iterator interface.
GuildMember::kick() — Method in class GuildMember: Kicks the guild member.

L

$Client#loop — Property in class Client: The event loop.
Client::login() — Method in class Client: Login into Discord. Opens a WebSocket Gateway connection. Resolves once a WebSocket connection has been successfully established (does not mean the client is ready).
$APIManager#loop — Property in class APIManager
$APIManager#limited — Property in class APIManager: Are we globally ratelimited?
$APIManager#limit — Property in class APIManager: Global rate limit limit.
Emoji::listGuildEmojis() — Method in class Emoji
Guild::listGuildMembers() — Method in class Guild
User::leaveUserGuild() — Method in class User
Voice::listVoiceRegions() — Method in class Voice
$RatelimitBucket#limit — Property in class RatelimitBucket: The requests limit.
GuildChannelInterface::lockPermissions() — Method in class GuildChannelInterface: Locks in the permission overwrites from the parent channel. Resolves with $this.
StorageInterface::last() — Method in class StorageInterface: Returns the last element that passes a given truth test.
$AuditLogEntry#log — Property in class AuditLogEntry: The guild audit log which this entry belongs to.
$DMChannel#lastMessageID — Property in class DMChannel: The last message ID, or null.
$Guild#large — Property in class Guild: Whether the guild is considered large.
$Guild#lazy — Property in class Guild: Whether this guild is run in lazy mode (on the Discord node).
Guild::leave() — Method in class Guild: Leaves the guild.
$RichPresenceAssets#largeImage — Property in class RichPresenceAssets: The ID of the large image, or null.
$RichPresenceAssets#largeText — Property in class RichPresenceAssets: The text of the large image, or null.
$TextChannel#lastMessageID — Property in class TextChannel: The last message ID, or null.
GuildChannelTrait::lockPermissions() — Method in class GuildChannelTrait: Locks in the permission overwrites from the parent channel. Resolves with $this.
$TextChannelTrait#lastMessageID — Property in class TextChannelTrait: The last message's ID, or null.
$Collector#listener — Property in class Collector
$Collector#loop — Property in class Collector
$FileHelpers#loop — Property in class FileHelpers
$URLHelpers#loop — Property in class URLHelpers
$WSConnection#lastPacketTime — Property in class WSConnection: The timestamp of when we received the last event.
$WSManager#lastIdentify — Property in class WSManager

M

ClientEvents::messageDeleteRaw() — Method in class ClientEvents: Emitted when an uncached message gets deleted.
ClientEvents::messageDeleteBulkRaw() — Method in class ClientEvents: Emitted when multple uncached messages gets deleted.
ClientEvents::messageUpdateRaw() — Method in class ClientEvents: Emitted when an uncached message gets updated (does not mean the message got edited, check the edited timestamp for that).
ClientEvents::message() — Method in class ClientEvents: Emitted when a message gets received.
ClientEvents::messageUpdate() — Method in class ClientEvents: Emitted when a (cached) message gets updated (does not mean the message got edited, check the edited timestamp for that).
ClientEvents::messageDelete() — Method in class ClientEvents: Emitted when a (cached) message gets deleted.
ClientEvents::messageDeleteBulk() — Method in class ClientEvents: Emitted when multiple (cached) message gets deleted. The collection consists of Message instances, mapped by their ID.
ClientEvents::messageReactionAdd() — Method in class ClientEvents: Emitted when someone reacts to a (cached) message.
ClientEvents::messageReactionRemove() — Method in class ClientEvents: Emitted when a reaction from a (cached) message gets removed.
ClientEvents::messageReactionRemoveAll() — Method in class ClientEvents: Emitted when all reactions from a (cached) message gets removed.
APIManager::makeRequest() — Method in class APIManager: Makes an API request.
Channel::modifyChannel() — Method in class Channel
Emoji::modifyGuildEmoji() — Method in class Emoji
Guild::modifyGuild() — Method in class Guild
Guild::modifyGuildChannelPositions() — Method in class Guild
Guild::modifyGuildMember() — Method in class Guild
Guild::modifyCurrentNick() — Method in class Guild
Guild::modifyGuildRolePositions() — Method in class Guild
Guild::modifyGuildRole() — Method in class Guild
Guild::modifyGuildIntegration() — Method in class Guild
Guild::modifyGuildEmbed() — Method in class Guild
User::modifyCurrentUser() — Method in class User
Webhook::modifyWebhook() — Method in class Webhook
Webhook::modifyWebhookToken() — Method in class Webhook
MessageStorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all message storages implement. The storage also is used as factory.
StorageInterface::max() — Method in class StorageInterface: Return the maximum value of a given key.
StorageInterface::min() — Method in class StorageInterface: Return the minimum value of a given key.
$ClientStatus#mobile — Property in class ClientStatus: The status of the user on the mobile client.
$DMChannel#messages — Property in class DMChannel: The storage with all cached messages.
$Emoji#managed — Property in class Emoji: Is the emoji managed?
$Guild#members — Property in class Guild: Holds a guild's cached members, mapped by their ID.
$Guild#memberCount — Property in class Guild: How many members the guild has.
$Guild#mfaLevel — Property in class Guild: The required MFA level for the guild. ({see Guild::MFA_LEVEL})
$Guild#maxPresences — Property in class Guild: The maximum amount of presences the guild can have, or null.
$Guild#maxMembers — Property in class Guild: The maximum amount of members the guild can have, or null.
$Guild#me — Property in class Guild: The guild member of the client user.
$GuildMember#mute — Property in class GuildMember: Whether the member is server muted.
$Invite#maxUses — Property in class Invite: Maximum uses until the invite expires, or null.
$Invite#maxAge — Property in class Invite: Duration (in seconds) until the invite expires, or null.
$Invite#memberCount — Property in class Invite: Approximate amount of members, or null.
Message — Class in namespace CharlotteDunois\Yasmin\Models: Represents a message.
$Message#mentions — Property in class Message: All valid mentions that the message contains.
$Message#member — Property in class Message: The correspondending guildmember of the author (if message posted in a guild), or null.
MessageActivity — Class in namespace CharlotteDunois\Yasmin\Models: Represents a message activity.
MessageApplication — Class in namespace CharlotteDunois\Yasmin\Models: Represents a message application.
MessageAttachment — Class in namespace CharlotteDunois\Yasmin\Models: Represents an attachment (from a message).
MessageEmbed — Class in namespace CharlotteDunois\Yasmin\Models: Represents a received embed from a message. This class can also be used to make a Rich Embed.
MessageMentions — Class in namespace CharlotteDunois\Yasmin\Models: Holds message mentions.
$MessageMentions#message — Property in class MessageMentions: The message these mentions belongs to.
$MessageMentions#members — Property in class MessageMentions: The collection which holds all members mentions (only in guild channels), mapped by their ID. Only cached members can be put into this Collection.
MessageReaction — Class in namespace CharlotteDunois\Yasmin\Models: Represents a message reaction.
$MessageReaction#message — Property in class MessageReaction: The message this reaction belongs to.
$MessageReaction#me — Property in class MessageReaction: Whether the current user has reacted using this emoji.
MessageStorage — Class in namespace CharlotteDunois\Yasmin\Models: Message Storage to store and handle messages, utilizes Collection.
Permissions::missing() — Method in class Permissions: Checks if a given permission is missing.
$Role#managed — Property in class Role: Whether the role is managed by an integration.
$Role#mentionable — Property in class Role: Whether the role is mentionable.
$Role#members — Property in class Role: A collection of all (cached) guild members which have the role.
$TextChannel#messages — Property in class TextChannel: The storage with all cached messages.
$User#mfaEnabled — Property in class User: Whether the user has two factor enabled on their account, or null if no information provided.
$VoiceChannel#members — Property in class VoiceChannel: Holds all members which currently are in the voice channel. ({see \CharlotteDunois\Yasmin\Models\GuildMember})
DataHelpers::makeDateTime() — Method in class DataHelpers: Makes a DateTime instance from an UNIX timestamp and applies the default timezone.
DataHelpers::makeBase64URI() — Method in class DataHelpers: Turns input into a base64-encoded data URI.
MessageHelpers — Class in namespace CharlotteDunois\Yasmin\Utils: Message Helper methods.
URLHelpers::makeRequest() — Method in class URLHelpers: Makes an asynchronous request. Resolves with an instance of ResponseInterface.
MessageCreate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
MessageDelete — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
MessageDeleteBulk — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
MessageReactionAdd — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
MessageReactionRemove — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
MessageReactionRemoveAll — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
MessageUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event

N

ChannelStorageInterface::next() — Method in class ChannelStorageInterface: Advances the internal pointer. From Iterator interface.
EmojiStorageInterface::next() — Method in class EmojiStorageInterface: Advances the internal pointer. From Iterator interface.
GuildMemberStorageInterface::next() — Method in class GuildMemberStorageInterface: Advances the internal pointer. From Iterator interface.
GuildStorageInterface::next() — Method in class GuildStorageInterface: Advances the internal pointer. From Iterator interface.
MessageStorageInterface::next() — Method in class MessageStorageInterface: Advances the internal pointer. From Iterator interface.
PresenceStorageInterface::next() — Method in class PresenceStorageInterface: Advances the internal pointer. From Iterator interface.
RoleStorageInterface::next() — Method in class RoleStorageInterface: Advances the internal pointer. From Iterator interface.
StorageInterface::next() — Method in class StorageInterface: Advances the internal pointer. From Iterator interface.
UserStorageInterface::next() — Method in class UserStorageInterface: Advances the internal pointer. From Iterator interface.
$Activity#name — Property in class Activity: The name of the activity.
$CategoryChannel#name — Property in class CategoryChannel: The channel name.
$Emoji#name — Property in class Emoji: The emoji name.
$Guild#name — Property in class Guild: The guild name.
$GuildForumChannel#name — Property in class GuildForumChannel: The channel name.
$GuildForumChannel#nsfw — Property in class GuildForumChannel: Whether the channel is marked as NSFW or not.
$GuildMember#nickname — Property in class GuildMember: The nickname of the member, or null.
$GuildStoreChannel#name — Property in class GuildStoreChannel: The channel name.
$GuildStoreChannel#nsfw — Property in class GuildStoreChannel: Whether the channel is marked as NSFW or not.
$Message#nonce — Property in class Message: A snowflake used for checking message delivery, or null.
$MessageApplication#name — Property in class MessageApplication: The name of the application.
$OAuthApplication#name — Property in class OAuthApplication: The name of the application.
$PartialChannel#name — Property in class PartialChannel: The channel name, or null.
$PartialGuild#name — Property in class PartialGuild: The guild name.
$Role#name — Property in class Role: The role name.
$TextChannel#name — Property in class TextChannel: The channel name.
$TextChannel#nsfw — Property in class TextChannel: Whether the channel is marked as NSFW or not.
$UserConnection#name — Property in class UserConnection: The username of the connection account.
$VoiceChannel#name — Property in class VoiceChannel: The name of the channel.
$VoiceRegion#name — Property in class VoiceRegion: The name of the region.
$Webhook#name — Property in class Webhook: The webhook default name, or null.
$WebhookClient#name — Property in class WebhookClient: The webhook default name, or null.

O

$Client#options — Property in class Client: Client Options.
Client::on() — Method in class Client: Attach a listener to an event. The method is from the trait - only for documentation purpose here.
Client::once() — Method in class Client: Attach a listener to an event, for exactly once. The method is from the trait - only for documentation purpose here.
$APIRequest#options — Property in class APIRequest: Any request options.
GuildChannelInterface::overwritesFor() — Method in class GuildChannelInterface: Returns the permissions overwrites for the given member.
GuildChannelInterface::overwritePermissions() — Method in class GuildChannelInterface: Overwrites the permissions for a member or role in this channel. Resolves with an instance of PermissionOverwrite.
$DMChannel#ownerID — Property in class DMChannel: The owner ID of this channel, or null.
$DMChannel#owner — Property in class DMChannel: The owner of this channel, or null.
$Guild#ownerID — Property in class Guild: The ID of the owner.
OAuthApplication — Class in namespace CharlotteDunois\Yasmin\Models: Represents an OAuth Application.
$OAuthApplication#owner — Property in class OAuthApplication: The User instance of the owner, or null.
$VoiceRegion#optimal — Property in class VoiceRegion: Whether this is an optimal voice region for the client user.
$Webhook#owner — Property in class Webhook: The owner of the webhook, or null.
GuildChannelTrait::overwritesFor() — Method in class GuildChannelTrait: Returns the permissions overwrites for the given member as an associative array.
GuildChannelTrait::overwritePermissions() — Method in class GuildChannelTrait: Overwrites the permissions for a member or role in this channel. Resolves with an instance of PermissionOverwrite.
$Collector#options — Property in class Collector
$WebhookClient#owner — Property in class WebhookClient: The owner of the webhook, or null.

P

$Client#presences — Property in class Client: Holds all cached presences (latest ones), mapped by user ID.
$Client#pings — Property in class Client: The last 3 websocket pings of each shard.
ClientEvents::presenceUpdate() — Method in class ClientEvents: Emitted when a presence updates.
APIManager::processFuture() — Method in class APIManager: Processes the queue on future tick.
APIManager::processDelayed() — Method in class APIManager: Processes the queue delayed, depends on rest time offset.
APIManager::process() — Method in class APIManager: Processes the queue.
APIManager::processItem() — Method in class APIManager: Processes a queue item.
AthenaRatelimitBucket::push() — Method in class AthenaRatelimitBucket: Pushes a new request into the queue.
$DiscordAPIException#path — Property in class DiscordAPIException: The path of the request relative to the HTTP endpoint.
Channel::pinChannelMessage() — Method in class Channel
RatelimitBucket::push() — Method in class RatelimitBucket: Pushes a new request into the queue.
GuildChannelInterface::permissionsFor() — Method in class GuildChannelInterface: Returns the permissions for the given member.
PresenceStorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all presence storages implement. The storage also is used as factory.
RatelimitBucketInterface::push() — Method in class RatelimitBucketInterface: Pushes a new request into the queue.
UserStorageInterface::patch() — Method in class UserStorageInterface: Patches an user (retrieves the user if the user exists), returns null if only the ID is in the array, or creates an user.
WSEncodingInterface::prepareMessage() — Method in class WSEncodingInterface: Prepares the data to be sent.
$Activity#party — Property in class Activity: Party of the activity, an array in the format [ 'id' => string, 'size' => [ size (int), max (int|null) ]|null ], or null.
$CategoryChannel#position — Property in class CategoryChannel: The channel position.
$CategoryChannel#permissionOverwrites — Property in class CategoryChannel: A collection of PermissionOverwrite instances.
$Guild#presences — Property in class Guild: Holds a guild's presences of members, mapped by user ID.
$Guild#premiumTier — Property in class Guild: The premium (discord nitro) tier of the Guild. see the PREMIUM_TIER const
Guild::pruneMembers() — Method in class Guild: Prunes members from the guild based on how long they have been inactive. Resolves with an integer or null.
$GuildForumChannel#parentID — Property in class GuildForumChannel: The ID of the parent channel, or null.
$GuildForumChannel#position — Property in class GuildForumChannel: The channel position.
$GuildForumChannel#permissionOverwrites — Property in class GuildForumChannel: A collection of PermissionOverwrite instances, mapped by their ID.
$GuildMember#permissions — Property in class GuildMember: The permissions of the member, only taking roles into account.
$GuildMember#presence — Property in class GuildMember: The presence of the member in this guild, or null.
GuildMember::permissionsIn() — Method in class GuildMember: Returns permissions for a member in a guild channel, taking into account roles and permission overwrites.
$GuildStoreChannel#parentID — Property in class GuildStoreChannel: The ID of the parent channel, or null.
$GuildStoreChannel#position — Property in class GuildStoreChannel: The channel position.
$GuildStoreChannel#permissionOverwrites — Property in class GuildStoreChannel: A collection of PermissionOverwrite instances, mapped by their ID.
$GuildStoreChannel#parent — Property in class GuildStoreChannel: The channel's parent, or null.
$Invite#presenceCount — Property in class Invite: Approximate amount of presences, or null.
$Message#pinned — Property in class Message: Whether the message is pinned or not.
Message::pin() — Method in class Message: Pins the message. Resolves with $this.
$MessageActivity#partyID — Property in class MessageActivity: The party ID associated with this message activity, or null.
$MessageEmbed#provider — Property in class MessageEmbed: The provider in the format [ 'name' => string, 'url' => string ], or null.
PartialChannel — Class in namespace CharlotteDunois\Yasmin\Models: Represents a partial channel (of a guild or a group DM).
PartialGuild — Class in namespace CharlotteDunois\Yasmin\Models: Represents a partial guild.
PermissionOverwrite — Class in namespace CharlotteDunois\Yasmin\Models: Represents a permission overwrite.
Permissions — Class in namespace CharlotteDunois\Yasmin\Models: Permissions. Something fabulous.
Presence — Class in namespace CharlotteDunois\Yasmin\Models: Represents a presence.
PresenceStorage — Class in namespace CharlotteDunois\Yasmin\Models: Presence Storage, which utilizes Collection.
$Role#position — Property in class Role: The position of the role in the API.
$Role#permissions — Property in class Role: The permissions of the role.
$TextChannel#parentID — Property in class TextChannel: The ID of the parent channel, or null.
$TextChannel#position — Property in class TextChannel: The channel position.
$TextChannel#permissionOverwrites — Property in class TextChannel: A collection of PermissionOverwrite instances, mapped by their ID.
$TextChannel#parent — Property in class TextChannel: The channel's parent, or null.
UserStorage::patch() — Method in class UserStorage: Patches an user (retrieves the user if the user exists), returns null if only the ID is in the array, or creates an user.
$VoiceChannel#parentID — Property in class VoiceChannel: The ID of the parent channel, or null.
$VoiceChannel#position — Property in class VoiceChannel: The position of the channel.
$VoiceChannel#permissionOverwrites — Property in class VoiceChannel: A collection of PermissionOverwrite instances, mapped by their ID.
$VoiceChannel#parent — Property in class VoiceChannel: Returns the channel's parent, or null.
GuildChannelTrait::permissionsFor() — Method in class GuildChannelTrait: Returns the permissions for the given member.
MessageHelpers::parseMentions() — Method in class MessageHelpers: Parses mentions in a text. Resolves with an array of [ 'type' => string, 'ref' => Models ] arrays, in the order they were parsed.
$Snowflake#processID — Property in class Snowflake: The ID of the process which generated this snowflake.
Etf::prepareMessage() — Method in class Etf: Prepares the data to be sent.
Json::prepareMessage() — Method in class Json: Prepares the data to be sent.
PresenceUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$WSConnection#previous — Property in class WSConnection: Whether we should use the previous sequence for RESUME (for after compress context failure).
$WSConnection#previousSequence — Property in class WSConnection: The previous sequence.
$WSConnection#pings — Property in class WSConnection
WSConnection::processQueue() — Method in class WSConnection: Processes the WS queue.

Q

Client::queuedEmit() — Method in class Client: Puts events into a queue, if the client is not ready yet.
$APIManager#queue — Property in class APIManager: The queue for our API requests.
$AthenaRatelimitBucket#queue — Property in class AthenaRatelimitBucket: The request queue.
$RatelimitBucket#queue — Property in class RatelimitBucket: The request queue.
$WSConnection#queue — Property in class WSConnection: The WS queue.

R

$Client#readyTimestamp — Property in class Client: The UNIX timestamp of the last emitted ready event (or null if none yet).
Client::registerUtil() — Method in class Client: Registers an Util, if it has a setLoop method. All methods used need to be static.
Client::registerUtils() — Method in class Client: Registers Utils which have a setLoop method.
Client::removeListener() — Method in class Client: Remove specified listener from an event. The method is from the trait - only for documentation purpose here.
Client::removeAllListeners() — Method in class Client: Remove all listeners from an event (or all listeners).
ClientEvents::ready() — Method in class ClientEvents: Emitted each time the client turns ready.
ClientEvents::reconnect() — Method in class ClientEvents: Emitted when the shard tries to reconnect.
ClientEvents::raw() — Method in class ClientEvents: Emitted when we receive a message from the gateway.
ClientEvents::ratelimit() — Method in class ClientEvents: Ratelimit information.
ClientEvents::roleCreate() — Method in class ClientEvents: Emitted when a role gets created.
ClientEvents::roleUpdate() — Method in class ClientEvents: Emitted when a role gets updated.
ClientEvents::roleDelete() — Method in class ClientEvents: Emitted when a role gets deleted.
$APIManager#ratelimits — Property in class APIManager
$APIManager#remaining — Property in class APIManager: Global rate limit remaining.
$APIManager#resetTime — Property in class APIManager: When can we send again?
$APIRequest#retries — Property in class APIRequest: How many times we've retried.
APIRequest::request() — Method in class APIRequest: Returns the Guzzle Request.
Guild::removeGuildMember() — Method in class Guild
Guild::removeGuildMemberRole() — Method in class Guild
Guild::removeGuildBan() — Method in class Guild
RatelimitBucket — Class in namespace CharlotteDunois\Yasmin\HTTP: Manages a route's ratelimit in memory.
$RatelimitBucket#remaining — Property in class RatelimitBucket: How many requests can be made.
$RatelimitBucket#resetTime — Property in class RatelimitBucket: When the ratelimit gets reset.
ChannelStorageInterface::rewind() — Method in class ChannelStorageInterface: Resets the internal pointer. From Iterator interface.
ChannelStorageInterface::resolve() — Method in class ChannelStorageInterface: Resolves given data to a channel.
EmojiStorageInterface::rewind() — Method in class EmojiStorageInterface: Resets the internal pointer. From Iterator interface.
EmojiStorageInterface::resolve() — Method in class EmojiStorageInterface: Resolves given data to an emoji.
GuildMemberStorageInterface::rewind() — Method in class GuildMemberStorageInterface: Resets the internal pointer. From Iterator interface.
GuildMemberStorageInterface::resolve() — Method in class GuildMemberStorageInterface: Resolves given data to a guildmember.
GuildStorageInterface::rewind() — Method in class GuildStorageInterface: Resets the internal pointer. From Iterator interface.
GuildStorageInterface::resolve() — Method in class GuildStorageInterface: Resolves given data to a guild.
MessageStorageInterface::rewind() — Method in class MessageStorageInterface: Resets the internal pointer. From Iterator interface.
PresenceStorageInterface::rewind() — Method in class PresenceStorageInterface: Resets the internal pointer. From Iterator interface.
PresenceStorageInterface::resolve() — Method in class PresenceStorageInterface: Resolves given data to a presence.
RatelimitBucketInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: This interface defines required methods and their arguments for managing route ratelimits using various systems.
The ratelimit bucket queue is always managed in memory (as in belongs to that process), however the ratelimits are distributed to the used system.
RoleStorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all role storages implement. The storage also is used as factory.
RoleStorageInterface::rewind() — Method in class RoleStorageInterface: Resets the internal pointer. From Iterator interface.
RoleStorageInterface::resolve() — Method in class RoleStorageInterface: Resolves given data to a Role.
StorageInterface::rewind() — Method in class StorageInterface: Resets the internal pointer. From Iterator interface.
StorageInterface::reduce() — Method in class StorageInterface: Reduces the collection to a single value, passing the result of each iteration into the subsequent iteration.
UserStorageInterface::rewind() — Method in class UserStorageInterface: Resets the internal pointer. From Iterator interface.
UserStorageInterface::resolve() — Method in class UserStorageInterface: Resolves given data to an user.
$AuditLogEntry#reason — Property in class AuditLogEntry: The specified reason, or null.
ChannelStorage::resolve() — Method in class ChannelStorage: Resolves given data to a channel.
$DMChannel#recipients — Property in class DMChannel: The recipients of this channel, mapped by user ID.
$Emoji#roles — Property in class Emoji: A collection of roles that this emoji is active for (empty if all).
$Emoji#requireColons — Property in class Emoji: Does the emoji require colons?
Emoji::removeRestrictedRole() — Method in class Emoji: Removes a role from the list of roles that can use this emoji. Resolves with $this.
Emoji::removeRestrictedRoles() — Method in class Emoji: Removes multiple roles from the list of roles that can use this emoji. Resolves with $this.
EmojiStorage::resolve() — Method in class EmojiStorage: Resolves given data to an emoji.
GroupDMChannel::removeRecipient() — Method in class GroupDMChannel: Removes the given user from the Group DM channel. Resolves with $this.
$Guild#roles — Property in class Guild: Holds a guild's roles, mapped by their ID.
$Guild#region — Property in class Guild: The region the guild is located in.
$GuildBan#reason — Property in class GuildBan: The ban reason, or null.
$GuildMember#roles — Property in class GuildMember: A Collection of all roles the member has, mapped by their ID. ({see \CharlotteDunois\Yasmin\Models\Role})
GuildMember::removeRole() — Method in class GuildMember: Removes a role from the guild member. Resolves with $this.
GuildMember::removeRoles() — Method in class GuildMember: Removes roles from the guild member. Resolves with $this.
GuildMemberStorage::resolve() — Method in class GuildMemberStorage: Resolves given data to a guildmember.
GuildStorage::resolve() — Method in class GuildStorage: Resolves given data to a guild.
$Message#replySeparator — Property in class Message: The string used in Message::reply to separate the mention and the content.
$Message#reactions — Property in class Message: A collection of message reactions, mapped by ID (or name). ({see \CharlotteDunois\Yasmin\Models\MessageReaction})
$Message#replyTo — Property in class Message: The message being replied to, or null.
$Message#replyToID — Property in class Message: he message ID being replied to, or null.
Message::react() — Method in class Message: Reacts to the message with the specified unicode or custom emoji. Resolves with an instance of MessageReaction.
Message::reply() — Method in class Message: Replies to the message. Resolves with an instance of Message, or with a Collection of Message instances, mapped by their ID.
$MessageMentions#roles — Property in class MessageMentions: The collection which holds all roles mentions, mapped by their ID.
MessageReaction::remove() — Method in class MessageReaction: Remove all reactions, or specify a User to remove only theirs. Resolves with $this.
$OAuthApplication#rpcOrigins — Property in class OAuthApplication: An array of RPC origin url strings, if RPC is enabled, or null.
Permissions::remove() — Method in class Permissions: Removes permissions from these ones.
Permissions::resolve() — Method in class Permissions: Resolves a permission name to number.
Permissions::resolveToName() — Method in class Permissions: Resolves a permission number to the name. Also checks if a given name is a valid permission.
PresenceStorage::resolve() — Method in class PresenceStorage: Resolves given data to a presence.
RichPresenceAssets — Class in namespace CharlotteDunois\Yasmin\Models: Rich Presence assets.
Role — Class in namespace CharlotteDunois\Yasmin\Models: Represents a role.
RoleStorage — Class in namespace CharlotteDunois\Yasmin\Models: Role Storage to store a guild's roles, utilizes Collection.
RoleStorage::resolve() — Method in class RoleStorage: Resolves given data to a Role.
$UserConnection#revoked — Property in class UserConnection: Whether the connection is revoked.
UserStorage::resolve() — Method in class UserStorage: Resolves given data to an user.
$Collector#resolve — Property in class Collector
$Collector#reject — Property in class Collector
DataHelpers::resolveColor() — Method in class DataHelpers: Resolves a color to an integer.
FileHelpers::resolveFileResolvable() — Method in class FileHelpers: Resolves filepath and URL into file data - returns it if it's neither. Resolves with a string.
MessageHelpers::resolveMessageOptionsFiles() — Method in class MessageHelpers: Resolves files of Message Options.
URLHelpers::resolveURLToData() — Method in class URLHelpers: Asynchronously resolves a given URL to the response body. Resolves with a string.
$GuildCreate#ready — Property in class GuildCreate: Whether we saw the client going ready.
Ready — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$Ready#ready — Property in class Ready: Whether we saw the client going ready.
Resumed — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$TypingStart#ready — Property in class TypingStart: Whether we saw the client going ready.
Dispatch::register() — Method in class Dispatch: Registers an event.
Reconnect — Class in namespace CharlotteDunois\Yasmin\WebSocket\Handlers: WS Event handler
$WSConnection#ratelimits — Property in class WSConnection: The WS ratelimits.
$WSConnection#running — Property in class WSConnection: The WS queue processing status.
$WSConnection#ready — Property in class WSConnection
WSConnection::reconnect() — Method in class WSConnection: Closes the WS connection.
WSConnection::renewConnection() — Method in class WSConnection: Closes the WS connection.
WSHandler::register() — Method in class WSHandler: Registers a handler.
$WSManager#readyConns — Property in class WSManager

S

$Client#shards — Property in class Client: Holds all shards, mapped by shard ID.
Client::setClientUser() — Method in class Client: Make an instance of {ClientUser} and store it.
AthenaRatelimitBucket::setBusy() — Method in class AthenaRatelimitBucket: Sets the busy flag (marking as running).
AthenaRatelimitBucket::size() — Method in class AthenaRatelimitBucket: Returns the size of the queue
AthenaRatelimitBucket::shift() — Method in class AthenaRatelimitBucket: Returns the first queue item or false. Modifies remaining ratelimit.
AthenaRatelimitBucket::set() — Method in class AthenaRatelimitBucket: Sets the cache data.
Guild::syncGuildIntegration() — Method in class Guild
RatelimitBucket::setBusy() — Method in class RatelimitBucket: Sets the busy flag (marking as running).
RatelimitBucket::size() — Method in class RatelimitBucket: Returns the size of the queue.
RatelimitBucket::shift() — Method in class RatelimitBucket: Returns the first queue item or false. Modifies remaining ratelimit.
ChannelStorageInterface::set() — Method in class ChannelStorageInterface: Sets a key-value pair.
EmojiStorageInterface::set() — Method in class EmojiStorageInterface: Sets a key-value pair.
GuildChannelInterface::setName() — Method in class GuildChannelInterface: Sets the name of the channel. Resolves with $this.
GuildChannelInterface::setNSFW() — Method in class GuildChannelInterface: Sets the nsfw flag of the channel. Resolves with $this.
GuildChannelInterface::setParent() — Method in class GuildChannelInterface: Sets the parent of the channel. Resolves with $this.
GuildChannelInterface::setPermissionOverwrites() — Method in class GuildChannelInterface: Sets the permission overwrites of the channel. Resolves with $this.
GuildChannelInterface::setPosition() — Method in class GuildChannelInterface: Sets the position of the channel. Resolves with $this.
GuildMemberStorageInterface::set() — Method in class GuildMemberStorageInterface: Sets a key-value pair.
GuildNewsChannelInterface::setTopic() — Method in class GuildNewsChannelInterface: Sets the topic of the channel. Resolves with $this.
GuildStorageInterface::set() — Method in class GuildStorageInterface: Sets a key-value pair.
GuildTextChannelInterface::setSlowmode() — Method in class GuildTextChannelInterface: Sets the slowmode in seconds for this channel.
GuildTextChannelInterface::setTopic() — Method in class GuildTextChannelInterface: Sets the topic of the channel. Resolves with $this.
GuildVoiceChannelInterface::setTopic() — Method in class GuildVoiceChannelInterface: Sets the topic of the channel. Resolves with $this.
MessageStorageInterface::set() — Method in class MessageStorageInterface: Sets a key-value pair.
PresenceStorageInterface::set() — Method in class PresenceStorageInterface: Sets a key-value pair.
RatelimitBucketInterface::setBusy() — Method in class RatelimitBucketInterface: Sets the busy flag (marking as running).
RatelimitBucketInterface::size() — Method in class RatelimitBucketInterface: Returns the size of the queue.
RatelimitBucketInterface::shift() — Method in class RatelimitBucketInterface: Returns the first queue item or false. Modifies remaining ratelimit.
RoleStorageInterface::set() — Method in class RoleStorageInterface: Sets a key-value pair.
StorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all storages implement. The storage also is used as factory.
StorageInterface::set() — Method in class StorageInterface: Sets a key-value pair.
StorageInterface::sort() — Method in class StorageInterface: Sorts the collection. Returns a new Storage instance.
StorageInterface::sortKey() — Method in class StorageInterface: Sorts the collection by key. Returns a new Storage instance.
StorageInterface::sortCustom() — Method in class StorageInterface: Sorts the collection using a custom sorting function. Returns a new Storage instance.
StorageInterface::sortCustomKey() — Method in class StorageInterface: Sorts the collection by key using a custom sorting function. Returns a new Storage instance.
TextChannelInterface::send() — Method in class TextChannelInterface: Sends a message to a channel. Resolves with an instance of Message, or a Collection of Message instances, mapped by their ID.
TextChannelInterface::startTyping() — Method in class TextChannelInterface: Starts sending the typing indicator in this channel. Counts up a triggered typing counter.
TextChannelInterface::stopTyping() — Method in class TextChannelInterface: Stops sending the typing indicator in this channel. Counts down a triggered typing counter.
UserStorageInterface::set() — Method in class UserStorageInterface: Sets a key-value pair.
WSCompressionInterface::supported() — Method in class WSCompressionInterface: Checks if the system supports it.
WSEncodingInterface::supported() — Method in class WSEncodingInterface: Checks if the system supports it.
$Activity#state — Property in class Activity: State of the activity, or null.
$Activity#sessionID — Property in class Activity: The ID that links to the activity session.
$Activity#syncID — Property in class Activity: The sync ID. For spotify, this is the spotify track ID.
$Activity#streaming — Property in class Activity: Whether or not the activity is being streamed.
Base::serialize() — Method in class Base
ChannelStorage::set() — Method in class ChannelStorage: Sets a key-value pair.
$ClientBase#serializeClient — Property in class ClientBase: The client which will be used to unserialize.
ClientBase::serialize() — Method in class ClientBase
ClientUser::setAvatar() — Method in class ClientUser: Set your avatar. Resolves with $this.
ClientUser::setStatus() — Method in class ClientUser: Set your status. Resolves with $this.
ClientUser::setPresence() — Method in class ClientUser: Set your presence. Ratelimit is 5/60s, the gateway drops all further presence updates. Resolves with $this.
ClientUser::setActivity() — Method in class ClientUser: Set your activity. Resolves with $this.
ClientUser::setUsername() — Method in class ClientUser: Set your username. Resolves with $this.
Emoji::setName() — Method in class Emoji: Sets the new name of the emoji. Resolves with $this.
EmojiStorage::set() — Method in class EmojiStorage: Sets a key-value pair.
$Guild#shardID — Property in class Guild: On which shard this guild is.
$Guild#splash — Property in class Guild: The guild splash hash, or null.
$Guild#systemChannelID — Property in class Guild: The ID of the system channel, or null.
$Guild#systemChannel — Property in class Guild: The guild's system channel, or null.
Guild::setAFKChannel() — Method in class Guild: Edits the AFK channel of the guild. Resolves with $this.
Guild::setAFKTimeout() — Method in class Guild: Edits the AFK timeout of the guild. Resolves with $this.
Guild::setChannelPositions() — Method in class Guild: Batch-updates the guild's channels positions. Channels is an array of channel ID (string)|GuildChannelInterface => position (int) pairs. Resolves with $this.
Guild::setRolePositions() — Method in class Guild: Batch-updates the guild's roles positions. Roles is an array of role ID (string)|Role => position (int) pairs. Resolves with $this.
Guild::setExplicitContentFilter() — Method in class Guild: Edits the level of the explicit content filter. Resolves with $this.
Guild::setIcon() — Method in class Guild: Updates the guild icon. Resolves with $this.
Guild::setName() — Method in class Guild: Edits the name of the guild. Resolves with $this.
Guild::setOwner() — Method in class Guild: Sets a new owner for the guild. Resolves with $this.
Guild::setRegion() — Method in class Guild: Edits the region of the guild. Resolves with $this.
Guild::setSplash() — Method in class Guild: Updates the guild splash. Resolves with $this.
Guild::setSystemChannel() — Method in class Guild: Edits the system channel of the guild. Resolves with $this.
Guild::setVerificationLevel() — Method in class Guild: Edits the verification level of the guild. Resolves with $this.
$GuildMember#selfDeaf — Property in class GuildMember: Whether the member is locally deafened.
$GuildMember#selfMute — Property in class GuildMember: Whether the member is locally muted.
$GuildMember#suppress — Property in class GuildMember: Whether you suppress the member.
GuildMember::setDeaf() — Method in class GuildMember: Deafen/undeafen a guild member. Resolves with $this.
GuildMember::setMute() — Method in class GuildMember: Mute/unmute a guild member. Resolves with $this.
GuildMember::setNickname() — Method in class GuildMember: Set the nickname of the guild member. Resolves with $this.
GuildMember::setRoles() — Method in class GuildMember: Sets the roles of the guild member. Resolves with $this.
GuildMember::setVoiceChannel() — Method in class GuildMember: Moves the guild member to the given voice channel, if connected to voice. Resolves with $this.
GuildMemberStorage::set() — Method in class GuildMemberStorage: Sets a key-value pair.
GuildStorage::set() — Method in class GuildStorage: Sets a key-value pair.
$Message#system — Property in class Message: Whether the message is a system message.
$MessageAttachment#size — Property in class MessageAttachment: The filesize in bytes.
MessageAttachment::setAttachment() — Method in class MessageAttachment: Sets the attachment.
MessageEmbed::setAuthor() — Method in class MessageEmbed: Set the author of this embed.
MessageEmbed::setColor() — Method in class MessageEmbed: Set the color of this embed.
MessageEmbed::setDescription() — Method in class MessageEmbed: Set the description of this embed.
MessageEmbed::setFooter() — Method in class MessageEmbed: Set the footer of this embed.
MessageEmbed::setImage() — Method in class MessageEmbed: Set the image of this embed.
MessageEmbed::setThumbnail() — Method in class MessageEmbed: Set the thumbnail of this embed.
MessageEmbed::setTimestamp() — Method in class MessageEmbed: Set the timestamp of this embed.
MessageEmbed::setTitle() — Method in class MessageEmbed: Set the title of this embed.
MessageEmbed::setURL() — Method in class MessageEmbed: Set the URL of this embed.
MessageStorage::set() — Method in class MessageStorage: Sets a key-value pair.
MessageStorage::sweep() — Method in class MessageStorage: Sweeps messages, deletes messages older than the parameter (timestamp - $time). Returns the amount of sweeped messages.
$PartialGuild#splash — Property in class PartialGuild: The guild splash, or null.
$Presence#status — Property in class Presence: What do you expect this to be?
PresenceStorage::set() — Method in class PresenceStorage: Sets a key-value pair.
$RichPresenceAssets#smallImage — Property in class RichPresenceAssets: The ID of the small image, or null.
$RichPresenceAssets#smallText — Property in class RichPresenceAssets: The text of the small image, or null.
Role::setColor() — Method in class Role: Set the color of the role. Resolves with $this.
Role::setHoist() — Method in class Role: Set whether or not the role should be hoisted. Resolves with $this.
Role::setMentionable() — Method in class Role: Set whether the role is mentionable. Resolves with $this.
Role::setName() — Method in class Role: Set a new name for the role. Resolves with $this.
Role::setPermissions() — Method in class Role: Set the permissions of the role. Resolves with $this.
Role::setPosition() — Method in class Role: Set the position of the role. Resolves with $this.
RoleStorage::set() — Method in class RoleStorage: Sets a key-value pair.
Shard — Class in namespace CharlotteDunois\Yasmin\Models: Represents a shard.
Shard::serialize() — Method in class Shard
Storage — Class in namespace CharlotteDunois\Yasmin\Models: Base class for all storages.
Storage::set() — Method in class Storage: Sets a key-value pair.
Storage::sort() — Method in class Storage: Sorts the collection. Returns a new Storage instance.
Storage::sortKey() — Method in class Storage: Sorts the collection by key. Returns a new Storage instance.
Storage::sortCustom() — Method in class Storage: Sorts the collection using a custom sorting function. Returns a new Storage instance.
Storage::sortCustomKey() — Method in class Storage: Sorts the collection by key using a custom sorting function. Returns a new Storage instance.
$TextChannel#slowmode — Property in class TextChannel: Ratelimit to send one message for each non-bot user, without MANAGE_CHANNEL and MANAGE_MESSAGES permissions, in seconds (0-120).
TextChannel::setSlowmode() — Method in class TextChannel: Sets the slowmode in seconds for this channel.
UserStorage::set() — Method in class UserStorage: Sets a key-value pair.
UserStorage::sweep() — Method in class UserStorage: Sweeps users falling out of scope (no mutual guilds). Returns the amount of sweeped users.
VoiceChannel::setBitrate() — Method in class VoiceChannel: Sets the bitrate of the channel. Resolves with $this.
VoiceChannel::setUserLimit() — Method in class VoiceChannel: Sets the user limit of the channel. Resolves with $this.
Webhook::send() — Method in class Webhook: Executes the webhooks and sends a message to the channel. Resolves with an instance of Message, or a Collection of Message instances, mapped by their ID. Or when using the WebhookClient, it will resolve with a raw Message object (array) or an array of raw Message objects (array).
GuildChannelTrait::setName() — Method in class GuildChannelTrait: Sets the name of the channel. Resolves with $this.
GuildChannelTrait::setNSFW() — Method in class GuildChannelTrait: Sets the nsfw flag of the channel. Resolves with $this.
GuildChannelTrait::setParent() — Method in class GuildChannelTrait: Sets the parent of the channel. Resolves with $this.
GuildChannelTrait::setPermissionOverwrites() — Method in class GuildChannelTrait: Sets the permission overwrites of the channel. Resolves with $this.
GuildChannelTrait::setPosition() — Method in class GuildChannelTrait: Sets the position of the channel. Resolves with $this.
GuildChannelTrait::setTopic() — Method in class GuildChannelTrait: Sets the topic of the channel. Resolves with $this.
TextChannelTrait::serialize() — Method in class TextChannelTrait
TextChannelTrait::send() — Method in class TextChannelTrait: Sends a message to a channel. Resolves with an instance of Message, or a Collection of Message instances, mapped by their ID.
TextChannelTrait::startTyping() — Method in class TextChannelTrait: Starts sending the typing indicator in this channel. Counts up a triggered typing counter.
TextChannelTrait::stopTyping() — Method in class TextChannelTrait: Stops sending the typing indicator in this channel. Counts down a triggered typing counter.
Collector::setLoop() — Method in class Collector: Sets the Event Loop.
Collector::stop() — Method in class Collector: This will stop the collector.
FileHelpers::setLoop() — Method in class FileHelpers: Sets the Event Loop.
FileHelpers::setFilesystem() — Method in class FileHelpers: Sets the React Filesystem instance, or disables it.
MessageHelpers::splitMessage() — Method in class MessageHelpers: Splits a string into multiple chunks at a designated character that do not exceed a specific length.
Snowflake — Class in namespace CharlotteDunois\Yasmin\Utils: Represents a Snowflake.
URLHelpers::setLoop() — Method in class URLHelpers: Sets the Event Loop.
URLHelpers::setHTTPClient() — Method in class URLHelpers: Set the HTTP client used in Yasmin (and in this utility).
ZlibStream::supported() — Method in class ZlibStream: Checks if the system supports it.
Etf::supported() — Method in class Etf: Checks if the system supports it.
Json::supported() — Method in class Json: Checks if the system supports it.
$WSConnection#shardID — Property in class WSConnection
$WSConnection#sequence — Property in class WSConnection: The sequence.
$WSConnection#status — Property in class WSConnection
WSConnection::send() — Method in class WSConnection
WSConnection::setAuthenticated() — Method in class WSConnection: Set authenticated.
WSConnection::setSessionID() — Method in class WSConnection: Set the session ID.
WSConnection::setSequence() — Method in class WSConnection: Sets the sequence.
WSConnection::sendIdentify() — Method in class WSConnection: Sends an IDENTIFY or RESUME payload, depending on ws session ID.
WSManager::setLastIdentified() — Method in class WSManager: Set last identified timestamp

T

$Client#token — Property in class Client: The token.
$Client#timers — Property in class Client: Timers which automatically get cancelled on destroy and only get run when we have a WS connection.
ClientEvents::typingStart() — Method in class ClientEvents: Emitted when someone starts typing in the channel.
ClientEvents::typingStop() — Method in class ClientEvents: Emitted when someone stops typing in the channel.
Channel::triggerChannelTyping() — Method in class Channel
TextChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all text channels implement.
TextChannelInterface::typingCount() — Method in class TextChannelInterface: Returns the amount of user typing in this channel.
$Activity#type — Property in class Activity: The activity type.
$Activity#timestamps — Property in class Activity: Timestamps for the activity, an array in the format [ 'start' => \DateTime|null, 'end' => \DateTime|null ], or null.
$AuditLogEntry#target — Property in class AuditLogEntry: The target of this entry, or null.
$Invite#temporary — Property in class Invite: If this invite grants temporary membership, or null.
$Message#tts — Property in class Message: Whether or not the message is Text-To-Speech.
$Message#type — Property in class Message: The type of the message. ({see Message::MESSAGE_TYPES})
$MessageActivity#type — Property in class MessageActivity: The message activity type. ({see self::TYPES})
$MessageEmbed#type — Property in class MessageEmbed: The embed type.
$MessageEmbed#title — Property in class MessageEmbed: The title, or null.
$MessageEmbed#timestamp — Property in class MessageEmbed: The timestamp, or the set timestamp (as ISO string), or null.
$MessageEmbed#thumbnail — Property in class MessageEmbed: The thumbnail in the format [ 'url' => string, 'height' => int, 'width' => int ], or null.
$MessageStorage#timer — Property in class MessageStorage: The sweep timer, or null.
$PartialChannel#type — Property in class PartialChannel: The type of the channel.
$PermissionOverwrite#type — Property in class PermissionOverwrite: The type of the overwrite (member or role).
$PermissionOverwrite#target — Property in class PermissionOverwrite: The role or guild member, or null if not a cached member.
TextChannel — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild's text channel.
$TextChannel#topic — Property in class TextChannel: The channel topic.
$User#tag — Property in class User: Username#Discriminator.
$UserConnection#type — Property in class UserConnection: The type of the user connection (e.g. twitch, youtube).
$UserStorage#timer — Property in class UserStorage: The sweep timer, or null.
$Webhook#token — Property in class Webhook: The webhook token, or null.
TextChannelTrait — Class in namespace CharlotteDunois\Yasmin\Traits: The text based channel trait.
$TextChannelTrait#typings — Property in class TextChannelTrait: Collection of all typing users (contains arrays).
$TextChannelTrait#typingTriggered — Property in class TextChannelTrait: Triggered typings in this channel.
TextChannelTrait::typingCount() — Method in class TextChannelTrait: Returns the amount of user typing in this channel.
$Collector#timer — Property in class Collector
DataHelpers::typecastVariable() — Method in class DataHelpers: Typecasts the variable to the type, if not null.
$Snowflake#timestamp — Property in class Snowflake: The timestamp of when this snowflake got generated. In seconds with microseconds.
TypingStart — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
$WebhookClient#token — Property in class WebhookClient: The webhook token.

U

$Client#users — Property in class Client: Holds all cached users, mapped by ID.
$Client#user — Property in class Client: User that the client is logged in as. The instance gets created when the client turns ready.
$Client#utils — Property in class Client: Loaded Utils with a loop instance.
ClientEvents::userUpdate() — Method in class ClientEvents: Emitted when someone updates their user account (username/avatar/etc.).
$APIEndpoints#user — Property in class APIEndpoints: The user endpoints.
APIManager::unshiftQueue() — Method in class APIManager: Unshifts an item into the queue.
$APIRequest#url — Property in class APIRequest: The url.
AthenaRatelimitBucket::unshift() — Method in class AthenaRatelimitBucket: Unshifts a new request into the queue. Modifies remaining ratelimit.
Channel::unpinChannelMessage() — Method in class Channel
User — Class in namespace CharlotteDunois\Yasmin\HTTP\Endpoints: Handles the API endpoints "User".
RatelimitBucket::unshift() — Method in class RatelimitBucket: Unshifts a new request into the queue. Modifies remaining ratelimit.
RatelimitBucketInterface::unshift() — Method in class RatelimitBucketInterface: Unshifts a new request into the queue. Modifies remaining ratelimit.
UserStorageInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all user storages implement. The storage also is used as factory.
$Activity#url — Property in class Activity: The stream url, if streaming.
$AuditLog#users — Property in class AuditLog: Holds the found users in the audit log, mapped by their ID.
$AuditLogEntry#userID — Property in class AuditLogEntry: The ID of the user which triggered the audit log.
$AuditLogEntry#user — Property in class AuditLogEntry: The user which triggered the audit log.
Base::unserialize() — Method in class Base
ClientBase::unserialize() — Method in class ClientBase
$Emoji#user — Property in class Emoji: The user that created the emoji, or null.
$Emoji#uid — Property in class Emoji: The used identifier in the system (ID or name, that is).
Guild::unban() — Method in class Guild: Unbans the given user. Resolves with $this.
$GuildBan#user — Property in class GuildBan: The banned user.
GuildBan::unban() — Method in class GuildBan: Unbans the user.
$GuildMember#user — Property in class GuildMember: The User instance of the member. This should never be null, unless you fuck up.
$Invite#uses — Property in class Invite: Number of times this invite has been used, or null.
$Invite#url — Property in class Invite: Returns the URL for the invite.
Message::unpin() — Method in class Message: Unpins the message. Resolves with $this.
$MessageActivity#user — Property in class MessageActivity: The user this message activity is for.
$MessageAttachment#url — Property in class MessageAttachment: The url to the file.
$MessageEmbed#url — Property in class MessageEmbed: The URL, or null.
$MessageMentions#users — Property in class MessageMentions: The collection which holds all users mentions, mapped by their ID.
$MessageReaction#users — Property in class MessageReaction: The users that have given this reaction, mapped by their ID.
$Presence#userID — Property in class Presence: The user ID this presence belongs to.
$Presence#user — Property in class Presence: The user this presence belongs to.
User — Class in namespace CharlotteDunois\Yasmin\Models: Represents an user on Discord.
$User#username — Property in class User: The username.
$User#userFetched — Property in class User: Whether the user fetched this user.
UserConnection — Class in namespace CharlotteDunois\Yasmin\Models: Represents an user connection.
$UserConnection#user — Property in class UserConnection: The user which this user connection belongs to.
UserStorage — Class in namespace CharlotteDunois\Yasmin\Models: User Storage to store and cache users, which utlizies Collection.
$VoiceChannel#userLimit — Property in class VoiceChannel: The maximum amount of users allowed in the channel - 0 means unlimited.
URLHelpers — Class in namespace CharlotteDunois\Yasmin\Utils: URL Helper methods.
UserUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event

V

Client::validateClientOptions() — Method in class Client: Validates the passed client options.
ClientEvents::voiceServerUpdate() — Method in class ClientEvents: Emitted when Discord responds to the user's Voice State Update event.
ClientEvents::voiceStateUpdate() — Method in class ClientEvents: Emitted when a member's voice state changes (leaves/joins/etc.).
$APIEndpoints#voice — Property in class APIEndpoints: The voice endpoints.
Voice — Class in namespace CharlotteDunois\Yasmin\HTTP\Endpoints: Handles the API endpoints "Voice".
ChannelStorageInterface::valid() — Method in class ChannelStorageInterface: Checks if current position is valid. From Iterator interface.
EmojiStorageInterface::valid() — Method in class EmojiStorageInterface: Checks if current position is valid. From Iterator interface.
GuildMemberStorageInterface::valid() — Method in class GuildMemberStorageInterface: Checks if current position is valid. From Iterator interface.
GuildStorageInterface::valid() — Method in class GuildStorageInterface: Checks if current position is valid. From Iterator interface.
MessageStorageInterface::valid() — Method in class MessageStorageInterface: Checks if current position is valid. From Iterator interface.
PresenceStorageInterface::valid() — Method in class PresenceStorageInterface: Checks if current position is valid. From Iterator interface.
RoleStorageInterface::valid() — Method in class RoleStorageInterface: Checks if current position is valid. From Iterator interface.
StorageInterface::valid() — Method in class StorageInterface: Checks if current position is valid. From Iterator interface.
UserStorageInterface::valid() — Method in class UserStorageInterface: Checks if current position is valid. From Iterator interface.
VoiceChannelInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Something all voice channels implement.
$Guild#verificationLevel — Property in class Guild: The verification level of the guild. ({see Guild::VERIFICATION_LEVEL})
$Guild#vanityInviteCode — Property in class Guild: The vanity invite code, or null.
$Guild#vanityURL — Property in class Guild: Whether the guild has a vanity invite url.
$Guild#verified — Property in class Guild: Whether the guild is verified.
$GuildMember#voiceChannelID — Property in class GuildMember: The ID of the voice channel the member is in, or null.
$GuildMember#voiceSessionID — Property in class GuildMember: The voice session ID, or null.
$GuildMember#voiceChannel — Property in class GuildMember: The voice channel the member is in, if connected to voice, or null.
$MessageEmbed#video — Property in class MessageEmbed: The video in the format [ 'url' => string, 'height' => int, 'width' => int ], or null.
$User#verified — Property in class User: Whether the email on this account has been verified, or null if no information provided.
VoiceChannel — Class in namespace CharlotteDunois\Yasmin\Models: Represents a guild's voice channel.
VoiceRegion — Class in namespace CharlotteDunois\Yasmin\Models: Represents a voice region.
$VoiceRegion#vip — Property in class VoiceRegion: Whether this is a VIP voice region.
GuildChannelTrait::validateOverwritePermissions() — Method in class GuildChannelTrait: Validates the given overwritePermissions arguments.
$Snowflake#value — Property in class Snowflake: The snowflake value.
VoiceServerUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event
VoiceStateUpdate — Class in namespace CharlotteDunois\Yasmin\WebSocket\Events: WS Event

W

$Client#ws — Property in class Client: The WS manager.
Client::wsmanager() — Method in class Client: You don't need to know.
$APIEndpoints#webhook — Property in class APIEndpoints: The webhook endpoints.
Webhook — Class in namespace CharlotteDunois\Yasmin\HTTP\Endpoints: Handles the API endpoints "Webhook".
WSCompressionInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Interface for WS compressions. This is used internally.
WSEncodingInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: Interface for WS encodings. This is used internally.
WSEventInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: WS Event interface.
WSHandlerInterface — Class in namespace CharlotteDunois\Yasmin\Interfaces: WS Handler interface.
$AuditLog#webhooks — Property in class AuditLog: Holds the found webhooks in the audit log, mapped by their ID.
$ClientStatus#web — Property in class ClientStatus: The status of the user on the web client.
$Guild#widgetEnabled — Property in class Guild: Whether the guild widget is enabled or not.
$Guild#widgetChannelID — Property in class Guild: The ID of the widget channel, or null.
$Guild#widgetChannel — Property in class Guild: The guild's widget channel, or null.
$Message#webhookID — Property in class Message: ID of the webhook that sent the message, if applicable, or null.
$MessageAttachment#width — Property in class MessageAttachment: The width (if image), or null.
$Shard#ws — Property in class Shard: The websocket connection of this shard.
$User#webhook — Property in class User: Determines wether the user is a webhook or not.
Webhook — Class in namespace CharlotteDunois\Yasmin\Models: Represents a webhook.
EventHelpers::waitForEvent() — Method in class EventHelpers: Waits for a specific type of event to get emitted. Additional filter may be applied to look for a specific event (invoked as `$filter(.
$Snowflake#workerID — Property in class Snowflake: The ID of the worker which generated this snowflake.
$Dispatch#wshandler — Property in class Dispatch
$Heartbeat#wshandler — Property in class Heartbeat
$HeartbeatAck#wshandler — Property in class HeartbeatAck
$Hello#wshandler — Property in class Hello
$InvalidSession#wshandler — Property in class InvalidSession
$Reconnect#wshandler — Property in class Reconnect
WSConnection — Class in namespace CharlotteDunois\Yasmin\WebSocket: Handles the WS connection.
$WSConnection#wsmanager — Property in class WSConnection
$WSConnection#ws — Property in class WSConnection
$WSConnection#wsHeartbeat — Property in class WSConnection: The WS heartbeat.
$WSConnection#wsCloseCodes — Property in class WSConnection: WS close codes, sorted by resumable session and ends everything.
$WSConnection#wsSessionID — Property in class WSConnection: The Discord Session ID.
WSHandler — Class in namespace CharlotteDunois\Yasmin\WebSocket: Handles WS messages.
$WSHandler#wsmanager — Property in class WSHandler
WSManager — Class in namespace CharlotteDunois\Yasmin\WebSocket: Manages the WS connections.
$WSManager#wshandler — Property in class WSManager
WebhookClient — Class in namespace CharlotteDunois\Yasmin: The webhook client.

Z

ZlibStream — Class in namespace CharlotteDunois\Yasmin\WebSocket\Compression: Handles WS compression.

_

Client::__construct() — Method in class Client: What do you expect this to do? It makes a new Client instance. Available client options are as following (all are optional):
Client::__isset() — Method in class Client
Client::__get() — Method in class Client
APIEndpoints::__construct() — Method in class APIEndpoints: DO NOT initialize this class yourself.
APIManager::__construct() — Method in class APIManager: DO NOT initialize this class yourself.
APIManager::__destruct() — Method in class APIManager: Default destructor.
APIManager::__isset() — Method in class APIManager
APIManager::__get() — Method in class APIManager
APIRequest::__construct() — Method in class APIRequest: Creates a new API Request.
AthenaRatelimitBucket::__construct() — Method in class AthenaRatelimitBucket: DO NOT initialize this class yourself.
AthenaRatelimitBucket::__destruct() — Method in class AthenaRatelimitBucket: Destroys the bucket.
DiscordAPIException::__construct() — Method in class DiscordAPIException: Constructor.
Channel::__construct() — Method in class Channel: Constructor.
Emoji::__construct() — Method in class Emoji: Constructor.
Guild::__construct() — Method in class Guild: Constructor.
Invite::__construct() — Method in class Invite: Constructor.
User::__construct() — Method in class User: Constructor.
Voice::__construct() — Method in class Voice: Constructor.
Webhook::__construct() — Method in class Webhook
RatelimitBucket::__construct() — Method in class RatelimitBucket: DO NOT initialize this class yourself.
RatelimitBucket::__destruct() — Method in class RatelimitBucket: Destroys the bucket.
ChannelInterface::_patch() — Method in class ChannelInterface: Internally patches the instance.
RatelimitBucketInterface::__construct() — Method in class RatelimitBucketInterface: Initializes the bucket.
RatelimitBucketInterface::__destruct() — Method in class RatelimitBucketInterface: Destroys the bucket.
TextChannelInterface::_createMessage() — Method in class TextChannelInterface
TextChannelInterface::_updateTyping() — Method in class TextChannelInterface
WSEventInterface::__construct() — Method in class WSEventInterface: Constructor.
WSHandlerInterface::__construct() — Method in class WSHandlerInterface: Constructor.
Activity::__construct() — Method in class Activity: The manual creation of such a class is discouraged. There may be an easy and safe way to create such a class in the future.
Activity::__get() — Method in class Activity
AuditLog::__construct() — Method in class AuditLog
AuditLog::__get() — Method in class AuditLog
AuditLogEntry::__construct() — Method in class AuditLogEntry
AuditLogEntry::__get() — Method in class AuditLogEntry
Base::__construct() — Method in class Base: Default constructor.
Base::__destruct() — Method in class Base: Default destructor.
Base::__isset() — Method in class Base
Base::__get() — Method in class Base
Base::__call() — Method in class Base
Base::_patch() — Method in class Base
Base::_shouldUpdate() — Method in class Base
Base::_markForDelete() — Method in class Base
CategoryChannel::__construct() — Method in class CategoryChannel
CategoryChannel::__get() — Method in class CategoryChannel
CategoryChannel::_patch() — Method in class CategoryChannel
ClientBase::__construct() — Method in class ClientBase
ClientBase::__get() — Method in class ClientBase
ClientBase::__debugInfo() — Method in class ClientBase
ClientStatus::__construct() — Method in class ClientStatus: Constructs a new instance.
ClientStatus::__get() — Method in class ClientStatus
ClientUser::__construct() — Method in class ClientUser
ClientUser::__get() — Method in class ClientUser
ClientUser::__debugInfo() — Method in class ClientUser
DMChannel::__construct() — Method in class DMChannel
DMChannel::__get() — Method in class DMChannel
DMChannel::_patch() — Method in class DMChannel
Emoji::__construct() — Method in class Emoji
Emoji::__get() — Method in class Emoji
Emoji::__toString() — Method in class Emoji: Automatically converts to a mention.
Emoji::_patch() — Method in class Emoji
EmojiStorage::__construct() — Method in class EmojiStorage
GroupDMChannel::__construct() — Method in class GroupDMChannel
GroupDMChannel::__get() — Method in class GroupDMChannel
GroupDMChannel::_patch() — Method in class GroupDMChannel
Guild::__construct() — Method in class Guild
Guild::__get() — Method in class Guild
Guild::_addMember() — Method in class Guild
Guild::_removeMember() — Method in class Guild
Guild::_patch() — Method in class Guild
GuildBan::__construct() — Method in class GuildBan
GuildBan::__get() — Method in class GuildBan
GuildForumChannel::__construct() — Method in class GuildForumChannel
GuildForumChannel::__get() — Method in class GuildForumChannel
GuildForumChannel::__toString() — Method in class GuildForumChannel: Automatically converts to a mention.
GuildForumChannel::_patch() — Method in class GuildForumChannel
GuildMember::__construct() — Method in class GuildMember
GuildMember::__get() — Method in class GuildMember
GuildMember::__clone() — Method in class GuildMember: The internal hook for cloning.
GuildMember::__toString() — Method in class GuildMember: Automatically converts to a mention.
GuildMember::_setVoiceState() — Method in class GuildMember
GuildMember::_patch() — Method in class GuildMember
GuildMemberStorage::__construct() — Method in class GuildMemberStorage
GuildStoreChannel::__construct() — Method in class GuildStoreChannel
GuildStoreChannel::__get() — Method in class GuildStoreChannel
GuildStoreChannel::__toString() — Method in class GuildStoreChannel: Automatically converts to a mention.
GuildStoreChannel::_patch() — Method in class GuildStoreChannel
Invite::__construct() — Method in class Invite
Invite::__get() — Method in class Invite
Message::__construct() — Method in class Message
Message::__get() — Method in class Message
Message::__toString() — Method in class Message: Automatically converts to the message content.
Message::_addReaction() — Method in class Message
Message::_patch() — Method in class Message
MessageActivity::__construct() — Method in class MessageActivity
MessageActivity::__get() — Method in class MessageActivity
MessageApplication::__construct() — Method in class MessageApplication
MessageApplication::__get() — Method in class MessageApplication
MessageAttachment::__construct() — Method in class MessageAttachment: Constructs a new instance.
MessageAttachment::__get() — Method in class MessageAttachment
MessageAttachment::_getMessageFilesArray() — Method in class MessageAttachment: Returns a proper message files array.
MessageEmbed::__construct() — Method in class MessageEmbed: Constructs a new instance.
MessageEmbed::__get() — Method in class MessageEmbed
MessageMentions::__construct() — Method in class MessageMentions
MessageMentions::__get() — Method in class MessageMentions
MessageReaction::__construct() — Method in class MessageReaction
MessageReaction::__get() — Method in class MessageReaction
MessageReaction::_incrementCount() — Method in class MessageReaction: Increments the count.
MessageReaction::_decrementCount() — Method in class MessageReaction: Decrements the count.
MessageStorage::__construct() — Method in class MessageStorage
MessageStorage::__destruct() — Method in class MessageStorage
OAuthApplication::__construct() — Method in class OAuthApplication
OAuthApplication::__get() — Method in class OAuthApplication
OAuthApplication::__toString() — Method in class OAuthApplication: Automatically converts to the application name.
PartialChannel::__construct() — Method in class PartialChannel
PartialChannel::__get() — Method in class PartialChannel
PartialChannel::__toString() — Method in class PartialChannel: Automatically converts to the channel name.
PartialGuild::__construct() — Method in class PartialGuild
PartialGuild::__get() — Method in class PartialGuild
PartialGuild::__toString() — Method in class PartialGuild: Automatically converts to the guild name.
PermissionOverwrite::__construct() — Method in class PermissionOverwrite
PermissionOverwrite::__get() — Method in class PermissionOverwrite
Permissions::__construct() — Method in class Permissions: Constructs a new instance.
Permissions::__get() — Method in class Permissions
Presence::__construct() — Method in class Presence: The manual creation of such an instance is discouraged. There may be an easy and safe way to create such an instance in the future.
Presence::__get() — Method in class Presence
Presence::_patch() — Method in class Presence
PresenceStorage::__construct() — Method in class PresenceStorage
RichPresenceAssets::__construct() — Method in class RichPresenceAssets: The manual creation of such an instance is discouraged. There may be an easy and safe way to create such an instance in the future.
RichPresenceAssets::__get() — Method in class RichPresenceAssets
Role::__construct() — Method in class Role
Role::__get() — Method in class Role
Role::__toString() — Method in class Role: Automatically converts to a mention.
Role::_patch() — Method in class Role
RoleStorage::__construct() — Method in class RoleStorage
Shard::__construct() — Method in class Shard
Shard::__get() — Method in class Shard
Shard::__toString() — Method in class Shard
Storage::__construct() — Method in class Storage
Storage::__isset() — Method in class Storage
Storage::__get() — Method in class Storage
TextChannel::__construct() — Method in class TextChannel
TextChannel::__get() — Method in class TextChannel
TextChannel::__toString() — Method in class TextChannel: Automatically converts to a mention.
TextChannel::_patch() — Method in class TextChannel
User::__construct() — Method in class User
User::__get() — Method in class User
User::__debugInfo() — Method in class User
User::__toString() — Method in class User: Automatically converts the User instance to a mention.
User::_patch() — Method in class User
UserConnection::__construct() — Method in class UserConnection
UserStorage::__construct() — Method in class UserStorage
VoiceChannel::__construct() — Method in class VoiceChannel
VoiceChannel::__get() — Method in class VoiceChannel
VoiceChannel::__toString() — Method in class VoiceChannel: Automatically converts to the name.
VoiceChannel::_patch() — Method in class VoiceChannel
VoiceRegion::__construct() — Method in class VoiceRegion
VoiceRegion::__get() — Method in class VoiceRegion
Webhook::__construct() — Method in class Webhook
Webhook::__get() — Method in class Webhook
Webhook::_patch() — Method in class Webhook
TextChannelTrait::_createMessage() — Method in class TextChannelTrait
TextChannelTrait::_updateTyping() — Method in class TextChannelTrait
Collector::__construct() — Method in class Collector: The handler gets invoked as `$handler(.
Snowflake::__construct() — Method in class Snowflake: Constructor.
Snowflake::__get() — Method in class Snowflake
Etf::__construct() — Method in class Etf: Constructor.
ChannelCreate::__construct() — Method in class ChannelCreate: Constructor.
ChannelDelete::__construct() — Method in class ChannelDelete: Constructor.
ChannelPinsUpdate::__construct() — Method in class ChannelPinsUpdate: Constructor.
ChannelUpdate::__construct() — Method in class ChannelUpdate: Constructor.
GuildBanAdd::__construct() — Method in class GuildBanAdd: Constructor.
GuildBanRemove::__construct() — Method in class GuildBanRemove: Constructor.
GuildCreate::__construct() — Method in class GuildCreate: Constructor.
GuildDelete::__construct() — Method in class GuildDelete: Constructor.
GuildEmojisUpdate::__construct() — Method in class GuildEmojisUpdate: Constructor.
GuildIntegrationsUpdate::__construct() — Method in class GuildIntegrationsUpdate: Constructor.
GuildMemberAdd::__construct() — Method in class GuildMemberAdd: Constructor.
GuildMemberRemove::__construct() — Method in class GuildMemberRemove: Constructor.
GuildMemberUpdate::__construct() — Method in class GuildMemberUpdate: Constructor.
GuildMembersChunk::__construct() — Method in class GuildMembersChunk: Constructor.
GuildRoleCreate::__construct() — Method in class GuildRoleCreate: Constructor.
GuildRoleDelete::__construct() — Method in class GuildRoleDelete: Constructor.
GuildRoleUpdate::__construct() — Method in class GuildRoleUpdate: Constructor.
GuildUpdate::__construct() — Method in class GuildUpdate: Constructor.
InviteCreate::__construct() — Method in class InviteCreate: Constructor.
InviteDelete::__construct() — Method in class InviteDelete: Constructor.
MessageCreate::__construct() — Method in class MessageCreate: Constructor.
MessageDelete::__construct() — Method in class MessageDelete: Constructor.
MessageDeleteBulk::__construct() — Method in class MessageDeleteBulk: Constructor.
MessageReactionAdd::__construct() — Method in class MessageReactionAdd: Constructor.
MessageReactionRemove::__construct() — Method in class MessageReactionRemove: Constructor.
MessageReactionRemoveAll::__construct() — Method in class MessageReactionRemoveAll: Constructor.
MessageUpdate::__construct() — Method in class MessageUpdate: Constructor.
PresenceUpdate::__construct() — Method in class PresenceUpdate: Constructor.
Ready::__construct() — Method in class Ready: Constructor.
Resumed::__construct() — Method in class Resumed: Constructor.
TypingStart::__construct() — Method in class TypingStart: Constructor.
UserUpdate::__construct() — Method in class UserUpdate: Constructor.
VoiceServerUpdate::__construct() — Method in class VoiceServerUpdate: Constructor.
VoiceStateUpdate::__construct() — Method in class VoiceStateUpdate: Constructor.
Dispatch::__construct() — Method in class Dispatch: Constructor.
Heartbeat::__construct() — Method in class Heartbeat: Constructor.
HeartbeatAck::__construct() — Method in class HeartbeatAck: Constructor.
Hello::__construct() — Method in class Hello: Constructor.
InvalidSession::__construct() — Method in class InvalidSession: Constructor.
Reconnect::__construct() — Method in class Reconnect: Constructor.
WSConnection::__construct() — Method in class WSConnection: DO NOT initialize this class yourself.
WSConnection::__isset() — Method in class WSConnection
WSConnection::__get() — Method in class WSConnection
WSConnection::_pong() — Method in class WSConnection: Handles heartbeat ack.
WSConnection::_send() — Method in class WSConnection: Direct ws send method. DO NOT USE.
WSHandler::__construct() — Method in class WSHandler: DO NOT initialize this class yourself.
WSHandler::__get() — Method in class WSHandler
WSManager::__construct() — Method in class WSManager: DO NOT initialize this class yourself.
WSManager::__isset() — Method in class WSManager
WSManager::__get() — Method in class WSManager
WebhookClient::__construct() — Method in class WebhookClient: Constructor.