trait CacheSnapshot[F[_]] extends AnyRef

A representation of the cache.

Source
CacheSnapshot.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CacheSnapshot
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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.

Abstract Value Members

  1. abstract def banMap: F[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 net.katsstuff.ackcord.http.rest.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.

  2. abstract def botUser: F[@@[User, BotUser]]

    Our bot user.

    Our bot user. Tagged to allow special syntax.

  3. abstract def dmChannelMap: F[MapType[Channel, 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.

  4. abstract def getBan(guildId: GuildId, userId: UserId): OptionT[F, Ban]

    Gets the ban for a specific user.

  5. abstract def getChannel(id: ChannelId): OptionT[F, Channel]

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

  6. abstract def getChannelMessages(channelId: ChannelId): 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.

  7. abstract def getDmChannel(id: ChannelId): OptionT[F, DMChannel]

    Get a dm channel by id.

  8. abstract def getEmoji(id: EmojiId): OptionT[F, Emoji]

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

  9. abstract def getGroupDmChannel(id: ChannelId): OptionT[F, GroupDMChannel]

    Get a group dm channel by id.

  10. abstract def getGuild(id: GuildId): OptionT[F, Guild]

    Get a guild by id.

  11. abstract def getGuildChannel(id: ChannelId): OptionT[F, GuildChannel]

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

  12. abstract def getGuildChannel(guildId: GuildId, id: ChannelId): OptionT[F, GuildChannel]

    Get a guild channel.

    Get a guild channel.

    guildId

    The guild id

    id

    The channel id

  13. abstract def getGuildWithUnavailable(id: GuildId): OptionT[F, UnknownStatusGuild]

    Get guild by id, also including unavailable guilds.

  14. abstract def getLastTyped(channelId: ChannelId, userId: UserId): OptionT[F, Instant]

    Get the instant a user last typed in a channel.

  15. abstract def getMessage(messageId: MessageId): OptionT[F, Message]

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

  16. abstract def getMessage(channelId: ChannelId, messageId: MessageId): OptionT[F, Message]

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

  17. abstract def getPresence(guildId: GuildId, userId: UserId): OptionT[F, Presence]

    Get the presence of a user for a specific guild

  18. abstract def getRole(guildId: GuildId, roleId: RoleId): OptionT[F, Role]

    Get a role by a guildId and a roleID.

  19. abstract def getRole(id: RoleId): OptionT[F, Role]

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

  20. abstract def getTChannel(id: ChannelId): OptionT[F, TChannel]

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

  21. abstract def getUser(id: UserId): OptionT[F, User]

    Get a user by id.

  22. abstract def getUserDmChannel(id: UserId): OptionT[F, DMChannel]

    Get the dm channel for a specific user.

  23. abstract def groupDmChannelMap: F[MapType[Channel, 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.

  24. abstract def guildMap: F[MapType[Guild, Guild]]

    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.

  25. abstract def lastTypedMap: F[MapType[Channel, 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.

  26. abstract def messageMap: F[MapType[Channel, 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.

  27. abstract def unavailableGuildMap: F[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.

  28. abstract def userMap: F[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.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped