CacheSnapshot

Type Members

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

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 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.
abstract def botUser: F[@@[User, BotUser]]

Our bot user.
Our bot user. Tagged to allow special syntax.
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.
abstract def getBan(guildId: GuildId, userId: UserId): OptionT[F, Ban]

Gets the ban for a specific user.
abstract def getChannel(id: ChannelId): OptionT[F, Channel]

Get a channel by id, ignoring if it's a dm or guild channel.
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.
abstract def getDmChannel(id: ChannelId): OptionT[F, DMChannel]

Get a dm channel by id.
abstract def getEmoji(id: EmojiId): OptionT[F, Emoji]

Get an emoji by id without knowing the guild it belongs to.
abstract def getGroupDmChannel(id: ChannelId): OptionT[F, GroupDMChannel]

Get a group dm channel by id.
abstract def getGuild(id: GuildId): OptionT[F, Guild]

Get a guild by id.
abstract def getGuildChannel(id: ChannelId): OptionT[F, GuildChannel]

Get a guild channel by id without knowing the guild it belongs to.
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
abstract def getGuildWithUnavailable(id: GuildId): OptionT[F, UnknownStatusGuild]

Get guild by id, also including unavailable guilds.
abstract def getLastTyped(channelId: ChannelId, userId: UserId): OptionT[F, Instant]

Get the instant a user last typed in a channel.
abstract def getMessage(messageId: MessageId): OptionT[F, Message]

Get a message by id without knowing the channel it belongs to.
abstract def getMessage(channelId: ChannelId, messageId: MessageId): OptionT[F, Message]

Get a message, specifying both the channel, and message id.
abstract def getPresence(guildId: GuildId, userId: UserId): OptionT[F, Presence]

Get the presence of a user for a specific guild
abstract def getRole(guildId: GuildId, roleId: RoleId): OptionT[F, Role]

Get a role by a guildId and a roleID.
abstract def getRole(id: RoleId): OptionT[F, Role]

Get a role by id without knowing the guild it belongs to.
abstract def getTChannel(id: ChannelId): OptionT[F, TChannel]

Get a text channel by id, ignoring if it's a dm or guild channel.
abstract def getUser(id: UserId): OptionT[F, User]

Get a user by id.
abstract def getUserDmChannel(id: UserId): OptionT[F, DMChannel]

Get the dm channel for a specific user.
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.
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.
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.
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.
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.
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

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def mapK[G[_]](f: ~>[F, G]): CacheSnapshot[G]
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object CacheSnapshot | package ackcord

trait CacheSnapshot[F[_]] extends AnyRef

Type Members

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

Abstract Value Members

abstract def banMap: F[MapType[Guild, MapType[User, Ban]]]

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

abstract def dmChannelMap: F[MapType[Channel, DMChannel]]

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

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

abstract def getChannelMessages(channelId: ChannelId): MapType[Message, Message]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

abstract def groupDmChannelMap: F[MapType[Channel, GroupDMChannel]]

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

abstract def lastTypedMap: F[MapType[Channel, MapType[User, Instant]]]

abstract def messageMap: F[MapType[Channel, MapType[Message, Message]]]

abstract def unavailableGuildMap: F[MapType[Guild, UnavailableGuild]]

abstract def userMap: F[MapType[User, User]]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def mapK[G[_]](f: ~>[F, G]): CacheSnapshot[G]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped