RestClientOptions class
Options for controlling the behavior of a NyxxRest client.
- Inheritance
-
- Object
- ClientOptions
- RestClientOptions
- Implementers
Constructors
-
RestClientOptions({List<
NyxxPlugin< plugins = const [], String loggerName = 'Nyxx', Duration? rateLimitWarningThreshold = const Duration(seconds: 10), CacheConfig<Nyxx> >User> userCacheConfig = const CacheConfig(), CacheConfig<Channel> channelCacheConfig = const CacheConfig(), CacheConfig<Message> messageCacheConfig = const CacheConfig(), CacheConfig<Webhook> webhookCacheConfig = const CacheConfig(), CacheConfig<Guild> guildCacheConfig = const CacheConfig(), CacheConfig<Member> memberCacheConfig = const CacheConfig(), CacheConfig<Role> roleCacheConfig = const CacheConfig(), CacheConfig<Emoji> emojiCacheConfig = const CacheConfig(), CacheConfig<StageInstance> stageInstanceCacheConfig = const CacheConfig(), CacheConfig<ScheduledEvent> scheduledEventCacheConfig = const CacheConfig(), CacheConfig<AutoModerationRule> autoModerationRuleConfig = const CacheConfig(), CacheConfig<Integration> integrationConfig = const CacheConfig(), CacheConfig<AuditLogEntry> auditLogEntryConfig = const CacheConfig(), CacheConfig<VoiceState> voiceStateConfig = const CacheConfig(), CacheConfig<GuildSticker> stickerCacheConfig = const CacheConfig(), CacheConfig<GlobalSticker> globalStickerCacheConfig = const CacheConfig(), CacheConfig<ApplicationCommand> applicationCommandConfig = const CacheConfig(), CacheConfig<CommandPermissions> commandPermissionsConfig = const CacheConfig(), CacheConfig<Entitlement> entitlementConfig = const CacheConfig()}) -
Create a new RestClientOptions.
const
Properties
-
applicationCommandConfig
→ CacheConfig<
ApplicationCommand> -
The CacheConfig to use for the
NyxxRest.commands
manager.final -
auditLogEntryConfig
→ CacheConfig<
AuditLogEntry> -
The CacheConfig to use for the Guild.auditLogs manager.
final
-
autoModerationRuleConfig
→ CacheConfig<
AutoModerationRule> -
The CacheConfig to use for the Guild.autoModerationRules manager.
final
-
channelCacheConfig
→ CacheConfig<
Channel> -
The CacheConfig to use for the cache of the
NyxxRest.channels
manager.final -
commandPermissionsConfig
→ CacheConfig<
CommandPermissions> -
The CacheConfig to use for the GuildApplicationCommandManager.permissionsCache cache.
final
-
emojiCacheConfig
→ CacheConfig<
Emoji> -
The CacheConfig to use for the Emojis in the Guild.emojis manager.
final
-
entitlementConfig
→ CacheConfig<
Entitlement> -
The CacheConfig to use for the Application.entitlements manager.
final
-
globalStickerCacheConfig
→ CacheConfig<
GlobalSticker> -
The CacheConfig to use for the GlobalStickers in the
NyxxRest.stickers
manager.final -
guildCacheConfig
→ CacheConfig<
Guild> -
The CacheConfig to use for the cache of the
NyxxRest.guilds
manager.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
integrationConfig
→ CacheConfig<
Integration> -
The CacheConfig to use for the Guild.integrations manager.
final
- logger → Logger
-
The logger to use for this client.
no setterinherited
- loggerName → String
-
The name of the logger to use for this client.
finalinherited
-
memberCacheConfig
→ CacheConfig<
Member> -
The CacheConfig to use for the Guild.members manager.
final
-
messageCacheConfig
→ CacheConfig<
Message> -
The CacheConfig to use for the cache of TextChannel.messages managers.
final
-
plugins
→ List<
NyxxPlugin< Nyxx> > -
The plugins to use for this client.
finalinherited
- rateLimitWarningThreshold → Duration?
-
The threshold after which a warning will be logged if a request is waiting for rate limits.
finalinherited
-
roleCacheConfig
→ CacheConfig<
Role> -
The CacheConfig to use for the Guild.roles manager.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scheduledEventCacheConfig
→ CacheConfig<
ScheduledEvent> -
The CacheConfig to use for the Guild.scheduledEvents manager.
final
-
stageInstanceCacheConfig
→ CacheConfig<
StageInstance> -
The CacheConfig to use for StageInstances in the
NyxxRest.channels
manager.final -
stickerCacheConfig
→ CacheConfig<
GuildSticker> -
The CacheConfig to use for the GuildStickers in the Guild.stickers manager.
final
-
userCacheConfig
→ CacheConfig<
User> -
The CacheConfig to use for the cache of the
NyxxRest.users
manager.final -
voiceStateConfig
→ CacheConfig<
VoiceState> -
The CacheConfig to use for the
NyxxRest.voice
manager.final -
webhookCacheConfig
→ CacheConfig<
Webhook> -
The CacheConfig to use for the cache of the
NyxxRest.webhooks
manager.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited