class CacheSnapshotBuilder extends CacheSnapshotWithMaps

A mutable builder for creating a new snapshot

Source
CacheSnapshotBuilder.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CacheSnapshotBuilder
  2. CacheSnapshotWithMaps
  3. CacheSnapshot
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CacheSnapshotBuilder(seq: Long, botUser: @@[User, BotUser], dmChannelMap: SnowflakeMap[DMChannel, DMChannel], groupDmChannelMap: SnowflakeMap[GroupDMChannel, GroupDMChannel], unavailableGuildMap: SnowflakeMap[Guild, UnavailableGuild], guildMap: SnowflakeMap[Guild, GatewayGuild], messageMap: SnowflakeMap[TextChannel, SnowflakeMap[Message, Message]], lastTypedMap: SnowflakeMap[TextChannel, SnowflakeMap[User, Instant]], userMap: SnowflakeMap[User, User], banMap: SnowflakeMap[Guild, SnowflakeMap[User, Ban]], processor: CacheProcessor)

Type Members

  1. type MapType[K, V] = SnowflakeMap[K, V]

    The map type to use.

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

    Definition Classes
    CacheSnapshotBuilderCacheSnapshot

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. var banMap: SnowflakeMap[Guild, SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  6. var botUser: @@[User, BotUser]

    Our bot user.

    Our bot user. Tagged to allow special syntax.

    Definition Classes
    CacheSnapshotBuilderCacheSnapshot
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  8. def copy: CacheSnapshotBuilder
  9. var dmChannelMap: SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  12. def executeProcessor(): Unit
  13. def getBan(guildId: GuildId, userId: UserId): Option[Ban]

    Gets the ban for a specific user.

    Gets the ban for a specific user.

    Definition Classes
    CacheSnapshotWithMapsCacheSnapshot
  14. 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
    CacheSnapshotWithMapsCacheSnapshot
  15. def getChannelLastTyped(channelId: TextChannelId): SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  16. def getChannelMessages(channelId: TextChannelId): SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  18. def getDmChannel(id: SnowflakeType[DMChannel]): Option[DMChannel]

    Get a dm channel by id.

    Get a dm channel by id.

    Definition Classes
    CacheSnapshotWithMapsCacheSnapshot
  19. 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
    CacheSnapshotWithMapsCacheSnapshot
  20. def getGroupDmChannel(id: SnowflakeType[GroupDMChannel]): Option[GroupDMChannel]

    Get a group dm channel by id.

    Get a group dm channel by id.

    Definition Classes
    CacheSnapshotWithMapsCacheSnapshot
  21. def getGuild(id: GuildId): Option[GatewayGuild]

    Get a guild by id.

    Get a guild by id.

    Definition Classes
    CacheSnapshotWithMapsCacheSnapshot
  22. def getGuildBans(id: GuildId): SnowflakeMap[User, Ban]

    Gets all the bans for a specific guild.

    Gets all the bans for a specific guild.

    Definition Classes
    CacheSnapshotBuilderCacheSnapshot
  23. 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
    CacheSnapshotWithMapsCacheSnapshot
  24. 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
    CacheSnapshotWithMapsCacheSnapshot
  25. def getGuildWithUnavailable(id: GuildId): Option[UnknownStatusGuild]

    Get guild by id, also including unavailable guilds.

    Get guild by id, also including unavailable guilds.

    Definition Classes
    CacheSnapshotWithMapsCacheSnapshot
  26. 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
    CacheSnapshotWithMapsCacheSnapshot
  27. 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
    CacheSnapshotWithMapsCacheSnapshot
  28. 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
    CacheSnapshotWithMapsCacheSnapshot
  29. 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
    CacheSnapshotWithMapsCacheSnapshot
  30. 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
    CacheSnapshotWithMapsCacheSnapshot
  31. 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
    CacheSnapshotWithMapsCacheSnapshot
  32. 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
    CacheSnapshotWithMapsCacheSnapshot
  33. 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
    CacheSnapshotWithMapsCacheSnapshot
  34. 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
    CacheSnapshotWithMapsCacheSnapshot
  35. def getUser(id: UserId): Option[User]

    Get a user by id.

    Get a user by id.

    Definition Classes
    CacheSnapshotWithMapsCacheSnapshot
  36. def getUserDmChannel(id: UserId): Option[DMChannel]

    Get the dm channel for a specific user.

    Get the dm channel for a specific user.

    Definition Classes
    CacheSnapshotWithMapsCacheSnapshot
  37. var groupDmChannelMap: SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  38. var guildMap: SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  39. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. var lastTypedMap: SnowflakeMap[TextChannel, SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  42. var messageMap: SnowflakeMap[TextChannel, SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  46. var processor: CacheProcessor
  47. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  48. def toImmutable: MemoryCacheSnapshot
  49. def toString(): String
    Definition Classes
    AnyRef → Any
  50. var unavailableGuildMap: SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  51. var userMap: SnowflakeMap[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
    CacheSnapshotBuilderCacheSnapshot
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  54. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from CacheSnapshotWithMaps

Inherited from CacheSnapshot

Inherited from AnyRef

Inherited from Any

Ungrouped