t

ackcord

CacheSnapshotWithMaps

trait CacheSnapshotWithMaps extends CacheSnapshot

A cache snapshot where the getters can use the maps to get their data.

Source
CacheSnapshotWithMaps.scala
Linear Supertypes
CacheSnapshot, AnyRef, Any
Known Subclasses
MemoryCacheSnapshot, CacheSnapshotBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CacheSnapshotWithMaps
  2. CacheSnapshot
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type MapType[K, V] <: Map[SnowflakeType[K], V]

    The map type to use.

    The map type to use. Mutable for builder, immutable otherwise.

    Definition Classes
    CacheSnapshot

Abstract Value Members

  1. abstract def banMap: MapType[Guild, MapType[User, Ban]]

    The bans received this session.

    The bans received this session. NOTE: This is not all the bans that exists, only the ones received during this session. If you want all the bans, use ackcord.requests.GetGuildBans.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot
  2. abstract def botUser: @@[User, BotUser]

    Our bot user.

    Our bot user. Tagged to allow special syntax.

    Definition Classes
    CacheSnapshot
  3. abstract def dmChannelMap: MapType[DMChannel, DMChannel]

    The current dm channels.

    The current dm channels.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot
  4. abstract def getChannelLastTyped(channelId: TextChannelId): MapType[User, Instant]

    Get a map of when users last typed in a channel.

    Get a map of when users last typed in a channel.

    Definition Classes
    CacheSnapshot
  5. abstract def getChannelMessages(channelId: TextChannelId): MapType[Message, Message]

    Gets all the messages for a specific channel.

    Gets all the messages for a specific channel.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot
  6. abstract def getGuildBans(id: GuildId): MapType[User, Ban]

    Gets all the bans for a specific guild.

    Gets all the bans for a specific guild.

    Definition Classes
    CacheSnapshot
  7. abstract def groupDmChannelMap: MapType[GroupDMChannel, GroupDMChannel]

    The current group dm channels.

    The current group dm channels.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot
  8. abstract def guildMap: MapType[Guild, GatewayGuild]

    The currently joined guilds.

    The currently joined guilds.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot
  9. abstract def lastTypedMap: MapType[TextChannel, MapType[User, Instant]]

    The point each user typed for each channel.

    The point each user typed for each channel.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot
  10. abstract def messageMap: MapType[TextChannel, MapType[Message, Message]]

    All messages, organized by channelId, and then messageId.

    All messages, organized by channelId, and then messageId.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot
  11. abstract def unavailableGuildMap: MapType[Guild, UnavailableGuild]

    The guilds currently not available.

    The guilds currently not available.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot
  12. abstract def userMap: MapType[User, User]

    All the users currently tracked.

    All the users currently tracked.

    This method returns a map that might be empty depending on the implementation. Make sure you know if this will be the case before you use this method.

    Definition Classes
    CacheSnapshot

Concrete Value Members

  1. def getBan(guildId: GuildId, userId: UserId): Option[Ban]

    Gets the ban for a specific user.

    Gets the ban for a specific user.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  2. def getChannel(id: ChannelId): Option[Channel]

    Get a channel by id, ignoring if it's a dm or guild channel.

    Get a channel by id, ignoring if it's a dm or guild channel.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  3. def getDmChannel(id: SnowflakeType[DMChannel]): Option[DMChannel]

    Get a dm channel by id.

    Get a dm channel by id.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  4. def getEmoji(id: EmojiId): Option[Emoji]

    Get an emoji by id without knowing the guild it belongs to.

    Get an emoji by id without knowing the guild it belongs to.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  5. def getGroupDmChannel(id: SnowflakeType[GroupDMChannel]): Option[GroupDMChannel]

    Get a group dm channel by id.

    Get a group dm channel by id.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  6. def getGuild(id: GuildId): Option[GatewayGuild]

    Get a guild by id.

    Get a guild by id.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  7. def getGuildChannel(id: GuildChannelId): Option[GuildChannel]

    Get a guild channel by id without knowing the guild it belongs to.

    Get a guild channel by id without knowing the guild it belongs to.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  8. def getGuildChannel(guildId: GuildId, id: GuildChannelId): Option[GuildChannel]

    Get a guild channel.

    Get a guild channel.

    guildId

    The guild id

    id

    The channel id

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  9. def getGuildWithUnavailable(id: GuildId): Option[UnknownStatusGuild]

    Get guild by id, also including unavailable guilds.

    Get guild by id, also including unavailable guilds.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  10. def getLastTyped(channelId: TextChannelId, userId: UserId): Option[Instant]

    Get the instant a user last typed in a channel.

    Get the instant a user last typed in a channel.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  11. def getMessage(messageId: MessageId): Option[Message]

    Get a message by id without knowing the channel it belongs to.

    Get a message by id without knowing the channel it belongs to.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  12. def getMessage(channelId: TextChannelId, messageId: MessageId): Option[Message]

    Get a message, specifying both the channel, and message id.

    Get a message, specifying both the channel, and message id.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  13. def getPresence(guildId: GuildId, userId: UserId): Option[Presence]

    Get the presence of a user for a specific guild

    Get the presence of a user for a specific guild

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  14. def getRole(guildId: GuildId, roleId: RoleId): Option[Role]

    Get a role by a guildId and a roleID.

    Get a role by a guildId and a roleID.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  15. def getRole(id: RoleId): Option[Role]

    Get a role by id without knowing the guild it belongs to.

    Get a role by id without knowing the guild it belongs to.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  16. def getTextChannel(id: TextChannelId): Option[TextChannel]

    Get a text channel by id, ignoring if it's a dm or guild channel.

    Get a text channel by id, ignoring if it's a dm or guild channel.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  17. def getThread(id: ThreadGuildChannelId): Option[ThreadGuildChannel]

    Get a thread channel by id without knowing the guild it belongs to.

    Get a thread channel by id without knowing the guild it belongs to.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  18. def getThread(guildId: GuildId, id: ThreadGuildChannelId): Option[ThreadGuildChannel]

    Get a thread channel.

    Get a thread channel.

    guildId

    The guild id

    id

    The thread id

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  19. def getUser(id: UserId): Option[User]

    Get a user by id.

    Get a user by id.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot
  20. def getUserDmChannel(id: UserId): Option[DMChannel]

    Get the dm channel for a specific user.

    Get the dm channel for a specific user.

    Definition Classes
    CacheSnapshotWithMaps → CacheSnapshot