p

ackcord

package ackcord

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ackcord
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type BotAuthentication = ackcord.requests.BotAuthentication.type
  2. type Cache = Events
  3. case class CacheSettings(processor: CacheProcessor = MemoryCacheSnapshot.defaultCacheProcessor, parallelism: Int = 4, cacheBufferSize: PubSubBufferSize = PubSubBufferSize(), sendGatewayEventsBufferSize: PubSubBufferSize = PubSubBufferSize(), receiveGatewayEventsBufferSize: PubSubBufferSize = PubSubBufferSize(), ignoredEvents: Seq[Class[_ <: GatewayEvent[_]]] = Nil, cacheTypeRegistry: (Logger) => CacheTypeRegistry = CacheTypeRegistry.default, partitionCacheByGuild: Boolean = false) extends Product with Serializable

    processor

    A function that runs on the cache right before a cache snapshot is produced.

    parallelism

    How many cache updates are constructed in parallel

    cacheBufferSize

    Size of the buffer for the cache

    sendGatewayEventsBufferSize

    Size of the buffer for sending gateway events

    receiveGatewayEventsBufferSize

    Size of the buffer for receiving gateway events

    ignoredEvents

    Events the cache will ignore. APIMessages aren't sent for these either.

    cacheTypeRegistry

    Gives you control over how entities in the cache are updated, and what values are retained in the cache.

    partitionCacheByGuild

    Instead of sharing a single cache for the entire application, this partitions the cache by guild. Each guild will in effect receive it's own cache. Cache events not specific to one guild will be sent to all caches. Unlike then default cache, this one is faster, as cache updates can be done in parallel, but might use more memory, and you need to handle cross guild cache actions yourself.

  4. trait ChannelEventListenerMessage[A] extends EventListenerMessage[A]
  5. case class ClientSettings(token: String, largeThreshold: Int = 50, shardNum: Int = 0, shardTotal: Int = 1, idleSince: Option[Instant] = None, activity: Option[RawActivity] = None, status: PresenceStatus = PresenceStatus.Online, afk: Boolean = false, guildSubscriptions: Boolean = true, compress: Compress = Compress.ZLibStreamCompress, intents: GatewayIntents = GatewayIntents.AllNonPrivileged, system: ActorSystem[Nothing] = ActorSystem(Behaviors.ignore, "AckCord"), requestSettings: RequestSettings = RequestSettings(), cacheSettings: CacheSettings = CacheSettings()) extends Product with Serializable

    Settings used when connecting to Discord.

    Settings used when connecting to Discord.

    token

    The token for the bot.

    largeThreshold

    The large threshold.

    shardNum

    The shard index of this shard.

    shardTotal

    The amount of shards.

    idleSince

    If the bot has been idle, set the time since.

    activity

    Send an activity when connecting.

    status

    The status to use when connecting.

    afk

    If the bot should be afk when connecting.

    guildSubscriptions

    If Discord should sent events about user to your guilds.

    compress

    What sort of compression the gateway should use.

    intents

    Fine grained control over which events Discord should sent to your bot.

    system

    The actor system to use.

    requestSettings

    The request settings to use.

    cacheSettings

    Settings the cache will use.

  6. trait DiscordClient extends AnyRef

    Trait used to interface with Discord stuff from high level.

  7. class DiscordClientActor extends AbstractBehavior[Command]
  8. class DiscordClientCore extends DiscordClient
  9. trait EventListener[A, Mat] extends AnyRef
  10. trait EventListenerBuilder[+M[_], A <: APIMessage] extends ActionBuilder[EventListenerMessage, M, Nothing, A]
  11. trait EventListenerMessage[A] extends AnyRef
  12. case class EventRegistration[Mat](materialized: Mat, onDone: Future[Done], killSwitch: UniqueKillSwitch) extends Product with Serializable
  13. abstract class EventsController extends AnyRef
  14. type FutureVectorRequest[A] = Future[Vector[A]]
  15. type GatewayLogin = Login.type
  16. type GatewayLogout = Logout.type
  17. type GatewaySettings = ackcord.gateway.GatewaySettings
  18. trait GuildEventListenerMessage[A] extends EventListenerMessage[A]
  19. trait GuildUserEventListenerMessage[A] extends GuildEventListenerMessage[A] with UserEventListenerMessage[A]
  20. type JsonNull = ackcord.util.JsonNull.type
  21. type JsonOption[A] = ackcord.util.JsonOption[A]
  22. type JsonSome[A] = ackcord.util.JsonSome[A]
  23. type JsonUndefined = ackcord.util.JsonUndefined.type
  24. type OptionTRequest[A] = OptionT[Future, A]
  25. case class RequestSettings(millisecondPrecision: Boolean = true, relativeTime: Boolean = false, parallelism: Int = 4, bufferSize: Int = 32, maxRetryCount: Int = 3, overflowStrategy: OverflowStrategy = OverflowStrategy.backpressure, maxAllowedWait: FiniteDuration = 2.minutes) extends Product with Serializable

    parallelism

    Parallelism to use for requests.

    bufferSize

    The buffer size to use for waiting requests.

    maxRetryCount

    The maximum amount of times a request will be retried. Only affects requests that uses retries.

    overflowStrategy

    The overflow strategy to use when the buffer is full.

    maxAllowedWait

    The max allowed wait time before giving up on a request.

  26. type Requests = ackcord.requests.Requests
  27. type RequestsHelper = ackcord.requests.RequestsHelper
  28. type SourceRequest[A] = Source[A, NotUsed]
  29. type Streamable[F[_]] = ackcord.util.Streamable[F]
  30. trait TextChannelEventListenerMessage[A] extends ChannelEventListenerMessage[A]
  31. trait TextGuildChannelEventListenerMessage[A] extends TextChannelEventListenerMessage[A] with GuildEventListenerMessage[A]
  32. trait UserEventListenerMessage[A] extends EventListenerMessage[A]
  33. trait VGuildChannelEventListenerMessage[A] extends ChannelEventListenerMessage[A] with GuildEventListenerMessage[A]
  34. class WrappedEventListenerMessage[A] extends EventListenerMessage[A]

Value Members

  1. val BotAuthentication: ackcord.requests.BotAuthentication.type
  2. val Cache: Events.type
  3. val GatewayLogin: Login.type
  4. val GatewayLogout: Logout.type
  5. val GatewaySettings: ackcord.gateway.GatewaySettings.type
  6. val JsonNull: ackcord.util.JsonNull.type
  7. val JsonOption: ackcord.util.JsonOption.type
  8. val JsonSome: ackcord.util.JsonSome.type
  9. val JsonUndefined: ackcord.util.JsonUndefined.type
  10. val Requests: ackcord.requests.Requests.type
  11. val Streamable: ackcord.util.Streamable.type
  12. implicit def flowFunctorInstance[In, Mat]: Functor[[β$0$]Flow[In, β$0$, Mat]]
  13. implicit def sinkContravariantInstance[Mat]: Contravariant[[α$1$]Sink[α$1$, Mat]]
  14. implicit val sourceMonadInstance: MonadError[SourceRequest, Throwable] with Alternative[SourceRequest]
  15. implicit def sourceSyntax[A, M](source: Source[A, M]): SourceFlatmap[A, M]
  16. object ChannelEventListenerMessage
  17. object DiscordClientActor
  18. object EventListenerBuilder
  19. object EventListenerMessage
  20. object EventRegistration extends Serializable
  21. object GuildEventListenerMessage
  22. object GuildUserEventListenerMessage
  23. object MusicManager
  24. object ShardShutdownManager
  25. object TextChannelEventListenerMessage
  26. object TextGuildChannelEventListenerMessage
  27. object VGuildChannelEventListenerMessage

Inherited from AnyRef

Inherited from Any

Ungrouped