GatewayClientOptions class

Options for controlling the behavior of a NyxxGateway client.

Inheritance

• Object
• ClientOptions
• RestClientOptions
• GatewayClientOptions

Constructors

GatewayClientOptions({int minimumSessionStarts = 10, List<NyxxPlugin<Nyxx>> plugins = const [], String loggerName = 'Nyxx', CacheConfig<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<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<ApplicationCommand> applicationCommandConfig = const CacheConfig(), CacheConfig<CommandPermissions> commandPermissionsConfig = const CacheConfig(), CacheConfig<Entitlement> entitlementConfig = const CacheConfig()})

Create a new GatewayClientOptions.

const

Properties

applicationCommandConfig → CacheConfig<ApplicationCommand>

The CacheConfig to use for the NyxxRest.commands manager.

final, inherited

auditLogEntryConfig → CacheConfig<AuditLogEntry>

The CacheConfig to use for the Guild.auditLogs manager.

final, inherited

autoModerationRuleConfig → CacheConfig<AutoModerationRule>

The CacheConfig to use for the Guild.autoModerationRules manager.

final, inherited

channelCacheConfig → CacheConfig<Channel>

The CacheConfig to use for the cache of the NyxxRest.channels manager.

final, inherited

commandPermissionsConfig → CacheConfig<CommandPermissions>

The CacheConfig to use for the GuildApplicationCommandManager.permissionsCache cache.

final, inherited

emojiCacheConfig → CacheConfig<Emoji>

The CacheConfig to use for the Emojis in the Guild.emojis manager.

final, inherited

entitlementConfig → CacheConfig<Entitlement>

The CacheConfig to use for the Application.entitlements manager.

final, inherited

globalStickerCacheConfig → CacheConfig<GlobalSticker>

The CacheConfig to use for the GlobalStickers in the NyxxRest.stickers manager.

final, inherited

guildCacheConfig → CacheConfig<Guild>

The CacheConfig to use for the cache of the NyxxRest.guilds manager.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

integrationConfig → CacheConfig<Integration>

The CacheConfig to use for the Guild.integrations manager.

final, inherited

logger → Logger

The logger to use for this client.

no setter, inherited

loggerName → String

The name of the logger to use for this client.

final, inherited

memberCacheConfig → CacheConfig<Member>

The CacheConfig to use for the Guild.members manager.

final, inherited

messageCacheConfig → CacheConfig<Message>

The CacheConfig to use for the cache of TextChannel.messages managers.

final, inherited

minimumSessionStarts → int

The minimum number of session starts this client needs to connect.

final

plugins → List<NyxxPlugin<Nyxx>>

The plugins to use for this client.

final, inherited

roleCacheConfig → CacheConfig<Role>

The CacheConfig to use for the Guild.roles manager.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scheduledEventCacheConfig → CacheConfig<ScheduledEvent>

The CacheConfig to use for the Guild.scheduledEvents manager.

final, inherited

stageInstanceCacheConfig → CacheConfig<StageInstance>

The CacheConfig to use for StageInstances in the NyxxRest.channels manager.

final, inherited

stickerCacheConfig → CacheConfig<GuildSticker>

The CacheConfig to use for the GuildStickers in the Guild.stickers manager.

final, inherited

userCacheConfig → CacheConfig<User>

The CacheConfig to use for the cache of the NyxxRest.users manager.

final, inherited

voiceStateConfig → CacheConfig<VoiceState>

The CacheConfig to use for the NyxxRest.voice manager.

final, inherited

webhookCacheConfig → CacheConfig<Webhook>

The CacheConfig to use for the cache of the NyxxRest.webhooks manager.

final, inherited

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