value
the value this optional wraps.
Marks the annotated declaration as deprecated since version.
These declarations must also be annotated with Deprecated.
Marks the annotated declaration as deprecated since version.
These declarations must also be annotated with Deprecated.
Marks a Kord-related API as experimental.
Kord experimental has no backward compatibility guarantees, including both binary and source compatibility. Its API and semantics can and will be changed in next releases.
Features marked with this annotation will have its use evaluated and changed over time, and might not make it into the stable api.
Marks a Kord-related API as experimental.
Kord experimental has no backward compatibility guarantees, including both binary and source compatibility. Its API and semantics can and will be changed in next releases.
Features marked with this annotation will have its use evaluated and changed over time, and might not make it into the stable api.
Marks an API for internal use only.
Marks an API for internal use only.
Marks a Kord-related API as a feature preview.
A Kord preview has no backward compatibility guarantees, including both binary and source compatibility. Its API and semantics can and will be changed in next releases.
Features marked with this annotation will have its api evaluated and changed over time.
Marks a Kord-related API as a feature preview.
A Kord preview has no backward compatibility guarantees, including both binary and source compatibility. Its API and semantics can and will be changed in next releases.
Features marked with this annotation will have its api evaluated and changed over time.
Marks a Kord-related API as potentially unsafe.
Kord marks targets as unsafe if it exposes functionality in a way that is more error-prone than alternatives and can lead to inconsistent state and fail silent or fail slow code.
The trade-off is usually increased performance by reducing cache hits and requests to the discord api.
Functionality that is annotated with KordUnsafe should suggest a safer alternative approach in its documentation.
Marks a Kord-related API as potentially unsafe.
Kord marks targets as unsafe if it exposes functionality in a way that is more error-prone than alternatives and can lead to inconsistent state and fail silent or fail slow code.
The trade-off is usually increased performance by reducing cache hits and requests to the discord api.
Functionality that is annotated with KordUnsafe should suggest a safer alternative approach in its documentation.
Marks a Kord-voice related API as experimental.
Kord voice is experimental and has no backward compatibility guarantees, including both binary and source compatibility. Its API and semantics can and will be changed in next releases.
Features marked with this annotation will have its use evaluated and changed over time, and might not make it into the stable api.
Marks a Kord-voice related API as experimental.
Kord voice is experimental and has no backward compatibility guarantees, including both binary and source compatibility. Its API and semantics can and will be changed in next releases.
Features marked with this annotation will have its use evaluated and changed over time, and might not make it into the stable api.
Represents a Boolean field that was not present in the serialized entity.
Represents a Boolean field that was not present in the serialized entity.
Destructures this optional to its value.
Destructures this optional to its value.
Represents a field that was assigned a non-null value in the serialized entity. Equality and hashcode is implemented through its value.
the value this optional wraps.
Represents a field that was assigned a non-null value in the serialized entity. Equality and hashcode is implemented through its value.
the value this optional wraps.
Represents a value that encapsulate the optional and value state of a Boolean in the Discord API. Specifically:
Missing - a Boolean field that was not present in the serialized entity.
Value - a Boolean field that was assigned a non-null value in the serialized entity.
Note that there is no nullable variant present. Use Boolean? or
OptionalBoolean?for this case instead.
These classes are fully (de)serializable with kotlinx.serialization.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of OptionalBoolean.Missing:
@Serializable
class DiscordUser(
val id: Boolean,
val username: String,
val bot: OptionalBoolean = OptionalBoolean.Missing
)Represents a value that encapsulate the optional and value state of a Boolean in the Discord API. Specifically:
Missing - a Boolean field that was not present in the serialized entity.
Value - a Boolean field that was assigned a non-null value in the serialized entity.
Note that there is no nullable variant present. Use Boolean? or
OptionalBoolean?for this case instead.
These classes are fully (de)serializable with kotlinx.serialization.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of OptionalBoolean.Missing:
@Serializable
class DiscordUser(
val id: Boolean,
val username: String,
val bot: OptionalBoolean = OptionalBoolean.Missing
)Represents an Int field that was not present in the serialized entity.
Represents an Int field that was not present in the serialized entity.
Destructures this optional to its value.
Destructures this optional to its value.
Represents a field that was assigned a non-null value in the serialized entity. Equality and hashcode is implemented through its value.
the value this optional wraps.
Represents a field that was assigned a non-null value in the serialized entity. Equality and hashcode is implemented through its value.
the value this optional wraps.
Represents a value that encapsulate the optional and value state of an Int in the Discord API. Specifically:
Missing - an Int field that was not present in the serialized entity.
Value - an Int field that was assigned a non-null value in the serialized entity.
Note that there is no nullable variant present. Use Int? or
OptionalInt?for this case instead.
The base class is (de)serializable with kotlinx.serialization.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of OptionalInt.Missing:
@Serializable
class DiscordUser(
val id: Long,
val username: String,
val bot: OptionalInt = OptionalInt.Missing
)Represents a value that encapsulate the optional and value state of an Int in the Discord API. Specifically:
Missing - an Int field that was not present in the serialized entity.
Value - an Int field that was assigned a non-null value in the serialized entity.
Note that there is no nullable variant present. Use Int? or
OptionalInt?for this case instead.
The base class is (de)serializable with kotlinx.serialization.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of OptionalInt.Missing:
@Serializable
class DiscordUser(
val id: Long,
val username: String,
val bot: OptionalInt = OptionalInt.Missing
)Represents a Long field that was not present in the serialized entity.
Represents a Long field that was not present in the serialized entity.
Destructures this optional to its value.
Destructures this optional to its value.
Represents a field that was assigned a non-null value in the serialized entity. Equality and hashcode is implemented through its value.
the value this optional wraps.
Represents a field that was assigned a non-null value in the serialized entity. Equality and hashcode is implemented through its value.
the value this optional wraps.
Represents a value that encapsulate the optional and value state of a Long in the Discord API. Specifically:
Missing - a Long field that was not present in the serialized entity.
Value - a Long field that was assigned a non-null value in the serialized entity.
Note that there is no nullable variant present. Use Long? or
OptionalLong?for this case instead.
The base class is (de)serializable with kotlinx.serialization.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of OptionalLong.Missing:
@Serializable
class DiscordUser(
val id: Long,
val username: String,
val bot: OptionalLong = OptionalLong.Missing
)Represents a value that encapsulate the optional and value state of a Long in the Discord API. Specifically:
Missing - a Long field that was not present in the serialized entity.
Value - a Long field that was assigned a non-null value in the serialized entity.
Note that there is no nullable variant present. Use Long? or
OptionalLong?for this case instead.
The base class is (de)serializable with kotlinx.serialization.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of OptionalLong.Missing:
@Serializable
class DiscordUser(
val id: Long,
val username: String,
val bot: OptionalLong = OptionalLong.Missing
)Represents a Snowflake field that was not present in the serialized entity.
Represents a Snowflake field that was not present in the serialized entity.
the raw value this optional wraps. See Snowflake.value and Snowflake.validValues for more details.
the raw value this optional wraps. See Snowflake.value and Snowflake.validValues for more details.
Destructures this optional to its value.
Destructures this optional to its value.
Represents a Snowflake field that was assigned a non-null value in the serialized entity. Equality and hashcode is implemented through its value.
the raw value this optional wraps. See Snowflake.value and Snowflake.validValues for more details.
Represents a Snowflake field that was assigned a non-null value in the serialized entity. Equality and hashcode is implemented through its value.
the raw value this optional wraps. See Snowflake.value and Snowflake.validValues for more details.
Represents a value that encapsulate a Snowflake's optional and value state in the Discord API.
Specifically:
Missing - a Snowflake field that was not present in the serialized entity.
Value - a Snowflake field that was assigned a non-null value in the serialized entity.
Note that there is no nullable variant present. Use
Snowflake?orOptionalSnowflake?for this case instead.
The base class is (de)serializable with kotlinx.serialization.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of OptionalSnowflake.Missing:
@Serializable
class DiscordUser(
val id: Long,
val username: String,
val bot: OptionalSnowflake = OptionalSnowflake.Missing
)Represents a value that encapsulate a Snowflake's optional and value state in the Discord API.
Specifically:
Missing - a Snowflake field that was not present in the serialized entity.
Value - a Snowflake field that was assigned a non-null value in the serialized entity.
Note that there is no nullable variant present. Use
Snowflake?orOptionalSnowflake?for this case instead.
The base class is (de)serializable with kotlinx.serialization.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of OptionalSnowflake.Missing:
@Serializable
class DiscordUser(
val id: Long,
val username: String,
val bot: OptionalSnowflake = OptionalSnowflake.Missing
)Destructures this optional to its value.
Destructures this optional to its value.
Represents a value that encapsulates all three possible states of a value in the Discord API. Specifically:
Missing - a field that was not present in the serialized entity
Null - a field that was assigned null in the serialized entity
Value - a field that was assigned a non-null value in the serialized entity.
The base class is (de)serializable with kotlinx.serialization and should be used as follows:
Optional<T> - a field that is only optional but not nullable.
Optional<T?> - A field that is both optional and nullable.
A field that is only nullable should be represented as T? instead.
Trying to deserialize null as Optional<T> will result in a SerializationException being thrown.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of Optional.Missing:
@Serializable
class DiscordUser(
val id: Long,
val username: String,
val bot: Optional<Boolean?> = Optional.Missing()
)Represents a value that encapsulates all three possible states of a value in the Discord API. Specifically:
Missing - a field that was not present in the serialized entity
Null - a field that was assigned null in the serialized entity
Value - a field that was assigned a non-null value in the serialized entity.
The base class is (de)serializable with kotlinx.serialization and should be used as follows:
Optional<T> - a field that is only optional but not nullable.
Optional<T?> - A field that is both optional and nullable.
A field that is only nullable should be represented as T? instead.
Trying to deserialize null as Optional<T> will result in a SerializationException being thrown.
Note that kotlinx.serialization does not call serializers for values that are not present in the serialized format. Optional fields should have a default value of Optional.Missing:
@Serializable
class DiscordUser(
val id: Long,
val username: String,
val bot: Optional<Boolean?> = Optional.Missing()
)returns null if this is null, calls OptionalBoolean.asNullable otherwise.
returns null if this is null, calls OptionalInt.asNullable otherwise.
returns null if this is null, calls OptionalLong.asNullable otherwise.
returns null if this is null, calls OptionalBoolean.asNullable otherwise.
returns null if this is null, calls OptionalInt.asNullable otherwise.
returns null if this is null, calls OptionalLong.asNullable otherwise.
returns the value of the optional or throws a IllegalStateException if the optional doesn't contain a value or is null.
returns the value of the optional or throws a IllegalStateException if the optional doesn't contain a value or is null.
returns default if this is null, calls OptionalBoolean.asNullable otherwise.
returns default if this is null, calls OptionalInt.asNullable otherwise.
returns default if this is null, calls OptionalLong.asNullable otherwise.
returns default if this is null, calls OptionalBoolean.asNullable otherwise.
returns default if this is null, calls OptionalInt.asNullable otherwise.
returns default if this is null, calls OptionalLong.asNullable otherwise.
returns null if this is null or OptionalBoolean.Missing, calls OptionalBoolean.Value.value otherwise.
returns null if this is null or OptionalInt.Missing, calls OptionalInt.Value.value otherwise.
returns null if this is null, calls OptionalLong.asNullable otherwise.
returns null if this is null or OptionalSnowflake.Missing, calls OptionalSnowflake.Value.value otherwise.
returns null if this is null or OptionalBoolean.Missing, calls OptionalBoolean.Value.value otherwise.
returns null if this is null or OptionalInt.Missing, calls OptionalInt.Value.value otherwise.
returns null if this is null, calls OptionalLong.asNullable otherwise.
returns null if this is null or OptionalSnowflake.Missing, calls OptionalSnowflake.Value.value otherwise.
All known Permissions (as contained in Permission.entries) combined into a single Permissions instance.
All known Permissions (as contained in Permission.entries) combined into a single Permissions instance.
A List of all known ActivityFlags.
A List of all known ActivityFlags.
Returns an instance of ActivityFlag with ActivityFlag.shift equal to the specified shift.
if shift is not in 0..30.
Returns an instance of ActivityFlag with ActivityFlag.shift equal to the specified shift.
if shift is not in 0..30.
An unknown ActivityFlag.
This is used as a fallback for ActivityFlags that haven't been added to Kord yet.
An unknown ActivityFlag.
This is used as a fallback for ActivityFlags that haven't been added to Kord yet.
Returns an instance of ActivityFlags that has all bits set that are set in this and flag.
Returns an instance of ActivityFlags that has all bits set that are set in this and flags.
Returns an instance of ActivityFlags that has all bits set that are set in this and flag.
Returns an instance of ActivityFlags that has all bits set that are set in this and flags.
The position of the bit that is set in this ActivityFlag. This is always in 0..30.
The position of the bit that is set in this ActivityFlag. This is always in 0..30.
Returns an instance of ActivityFlags built with ActivityFlags.Builder.
Returns an instance of ActivityFlags that has all bits set that are set in any element of flags.
Returns an instance of ActivityFlags built with ActivityFlags.Builder.
Returns an instance of ActivityFlags that has all bits set that are set in any element of flags.
Don't construct an instance of 'ActivityFlags' from a raw value. Use the factory functions described in the documentation instead.
import dev.kord.common.entity.ActivityFlags
ActivityFlags.Builder(value).build()Don't construct an instance of 'ActivityFlags' from a raw value. Use the factory functions described in the documentation instead.
import dev.kord.common.entity.ActivityFlags
ActivityFlags.Builder(value).build()Returns an instance of ActivityFlags that has all bits set that are currently set in this Builder.
Returns an instance of ActivityFlags that has all bits set that are currently set in this Builder.
Unsets all bits in the Builder that are set in this ActivityFlag.
Unsets all bits in the Builder that are set in this ActivityFlags.
Unsets all bits in the Builder that are set in this ActivityFlag.
Unsets all bits in the Builder that are set in this ActivityFlags.
Sets all bits in the Builder that are set in this ActivityFlag.
Sets all bits in the Builder that are set in this ActivityFlags.
Sets all bits in the Builder that are set in this ActivityFlag.
Sets all bits in the Builder that are set in this ActivityFlags.
Checks if this instance of ActivityFlags has all bits set that are set in flag.
Checks if this instance of ActivityFlags has all bits set that are set in flags.
Checks if this instance of ActivityFlags has all bits set that are set in flag.
Checks if this instance of ActivityFlags has all bits set that are set in flags.
Returns a copy of this instance of ActivityFlags modified with builder.
Returns a copy of this instance of ActivityFlags modified with builder.
A collection of multiple ActivityFlags.
You can create an instance of ActivityFlags using the following methods:
// from individual ActivityFlags
val activityFlags1 = ActivityFlags(ActivityFlag.Instance, ActivityFlag.Join)
// from an Iterable
val iterable: Iterable<ActivityFlag> = TODO()
val activityFlags2 = ActivityFlags(iterable)
// using a builder
val activityFlags3 = ActivityFlags {
+activityFlags2
+ActivityFlag.Instance
-ActivityFlag.Join
}You can create a modified copy of an existing instance of ActivityFlags using the copy method:
activityFlags.copy {
+ActivityFlag.Instance
}All ActivityFlags objects can use +/- operators:
val activityFlags1 = activityFlags + ActivityFlag.Instance
val activityFlags2 = activityFlags - ActivityFlag.Join
val activityFlags3 = activityFlags1 + activityFlags2You can use the contains operator to check whether an instance of ActivityFlags contains specific ActivityFlags:
val hasActivityFlag = ActivityFlag.Instance in activityFlags
val hasActivityFlags = ActivityFlags(ActivityFlag.Instance, ActivityFlag.Join) in activityFlagsWhenever ActivityFlags haven't been added to Kord yet, they will be deserialized as instances of ActivityFlag.Unknown.
You can also use ActivityFlag.fromShift to check for unknown ActivityFlags.
val hasUnknownActivityFlag = ActivityFlag.fromShift(23) in activityFlagsA collection of multiple ActivityFlags.
You can create an instance of ActivityFlags using the following methods:
// from individual ActivityFlags
val activityFlags1 = ActivityFlags(ActivityFlag.Instance, ActivityFlag.Join)
// from an Iterable
val iterable: Iterable<ActivityFlag> = TODO()
val activityFlags2 = ActivityFlags(iterable)
// using a builder
val activityFlags3 = ActivityFlags {
+activityFlags2
+ActivityFlag.Instance
-ActivityFlag.Join
}You can create a modified copy of an existing instance of ActivityFlags using the copy method:
activityFlags.copy {
+ActivityFlag.Instance
}All ActivityFlags objects can use +/- operators:
val activityFlags1 = activityFlags + ActivityFlag.Instance
val activityFlags2 = activityFlags - ActivityFlag.Join
val activityFlags3 = activityFlags1 + activityFlags2You can use the contains operator to check whether an instance of ActivityFlags contains specific ActivityFlags:
val hasActivityFlag = ActivityFlag.Instance in activityFlags
val hasActivityFlags = ActivityFlags(ActivityFlag.Instance, ActivityFlag.Join) in activityFlagsWhenever ActivityFlags haven't been added to Kord yet, they will be deserialized as instances of ActivityFlag.Unknown.
You can also use ActivityFlag.fromShift to check for unknown ActivityFlags.
val hasUnknownActivityFlag = ActivityFlag.fromShift(23) in activityFlagsReturns an instance of ActivityFlags that has all bits set that are set in this except the bits that are set in flag.
Returns an instance of ActivityFlags that has all bits set that are set in this except the bits that are set in flags.
Returns an instance of ActivityFlags that has all bits set that are set in this except the bits that are set in flag.
Returns an instance of ActivityFlags that has all bits set that are set in this except the bits that are set in flags.
Returns an instance of ActivityFlags that has all bits set that are set in this and flag.
Returns an instance of ActivityFlags that has all bits set that are set in this and flags.
Returns an instance of ActivityFlags that has all bits set that are set in this and flag.
Returns an instance of ActivityFlags that has all bits set that are set in this and flags.
A Set of all ActivityFlags contained in this instance of ActivityFlags.
A Set of all ActivityFlags contained in this instance of ActivityFlags.
A List of all known ActivityTypes.
A List of all known ActivityTypes.
An unknown ActivityType.
This is used as a fallback for ActivityTypes that haven't been added to Kord yet.
An unknown ActivityType.
This is used as a fallback for ActivityTypes that haven't been added to Kord yet.
See ActivityTypes in the Discord Developer Documentation.
See ActivityTypes in the Discord Developer Documentation.
A List of all known AllowedMentionTypes.
A List of all known AllowedMentionTypes.
Controls @everyone and @here mentions.
Controls @everyone and @here mentions.
Controls role mentions.
Controls role mentions.
An unknown AllowedMentionType.
This is used as a fallback for AllowedMentionTypes that haven't been added to Kord yet.
An unknown AllowedMentionType.
This is used as a fallback for AllowedMentionTypes that haven't been added to Kord yet.
Controls user mentions
Controls user mentions
See AllowedMentionTypes in the Discord Developer Documentation.
See AllowedMentionTypes in the Discord Developer Documentation.
Includes all channel types + categories.
Includes all channel types + categories.
A List of all known ApplicationCommandOptionTypes.
A List of all known ApplicationCommandOptionTypes.
Any integer between -2^53 and 2^53.
Any integer between -2^53 and 2^53.
Includes users and roles.
Includes users and roles.
Any double between -2^53 and 2^53.
Any double between -2^53 and 2^53.
An unknown ApplicationCommandOptionType.
This is used as a fallback for ApplicationCommandOptionTypes that haven't been added to Kord yet.
An unknown ApplicationCommandOptionType.
This is used as a fallback for ApplicationCommandOptionTypes that haven't been added to Kord yet.
A List of all known ApplicationCommandPermissionTypes.
A List of all known ApplicationCommandPermissionTypes.
An unknown ApplicationCommandPermissionType.
This is used as a fallback for ApplicationCommandPermissionTypes that haven't been added to Kord yet.
An unknown ApplicationCommandPermissionType.
This is used as a fallback for ApplicationCommandPermissionTypes that haven't been added to Kord yet.
See ApplicationCommandPermissionTypes in the Discord Developer Documentation.
See ApplicationCommandPermissionTypes in the Discord Developer Documentation.
A text-based command that shows up when a user types /.
A text-based command that shows up when a user types /.
A List of all known ApplicationCommandTypes.
A List of all known ApplicationCommandTypes.
A UI-based command that shows up when you right-click or tap on a message.
A UI-based command that shows up when you right-click or tap on a message.
An unknown ApplicationCommandType.
This is used as a fallback for ApplicationCommandTypes that haven't been added to Kord yet.
An unknown ApplicationCommandType.
This is used as a fallback for ApplicationCommandTypes that haven't been added to Kord yet.
A UI-based command that shows up when you right-click or tap on a user.
A UI-based command that shows up when you right-click or tap on a user.
See ApplicationCommandTypes in the Discord Developer Documentation.
See ApplicationCommandTypes in the Discord Developer Documentation.
Indicates if an app uses the Auto Moderation API.
Indicates if an app uses the Auto Moderation API.
Indicates if an app has registered global application commands.
Indicates if an app has registered global application commands.
A List of all known ApplicationFlags.
A List of all known ApplicationFlags.
Returns an instance of ApplicationFlag with ApplicationFlag.shift equal to the specified shift.
if shift is not in 0..30.
Returns an instance of ApplicationFlag with ApplicationFlag.shift equal to the specified shift.
if shift is not in 0..30.
Indicates if an app is embedded within the Discord client (currently unavailable publicly).
Indicates if an app is embedded within the Discord client (currently unavailable publicly).
Intent required for bots in under 100 servers to receive member-related events like GuildMemberAdd, found on the Bot page in your app's settings.
See the list of member-related events under GUILD_MEMBERS.
Intent required for bots in under 100 servers to receive member-related events like GuildMemberAdd, found on the Bot page in your app's settings.
See the list of member-related events under GUILD_MEMBERS.
Intent required for bots in 100 or more servers to receive member-related events like GuildMemberAdd.
See the list of member-related events under GUILD_MEMBERS.
Intent required for bots in 100 or more servers to receive member-related events like GuildMemberAdd.
See the list of member-related events under GUILD_MEMBERS.
Intent required for bots in under 100 servers to receive message content, found on the Bot page in your app's settings.
Intent required for bots in under 100 servers to receive message content, found on the Bot page in your app's settings.
Intent required for bots in 100 or more servers to receive message content.
Intent required for bots in 100 or more servers to receive message content.
Intent required for bots in under 100 servers to receive PresenceUpdate events, found on the Bot page in your app's settings.
Intent required for bots in under 100 servers to receive PresenceUpdate events, found on the Bot page in your app's settings.
Intent required for bots in 100 or more servers to receive PresenceUpdate events.
Intent required for bots in 100 or more servers to receive PresenceUpdate events.
An unknown ApplicationFlag.
This is used as a fallback for ApplicationFlags that haven't been added to Kord yet.
An unknown ApplicationFlag.
This is used as a fallback for ApplicationFlags that haven't been added to Kord yet.
Indicates unusual growth of an app that prevents verification.
Indicates unusual growth of an app that prevents verification.
See ApplicationFlags in the Discord Developer Documentation.
See ApplicationFlags in the Discord Developer Documentation.
Returns an instance of ApplicationFlags that has all bits set that are set in this and flag.
Returns an instance of ApplicationFlags that has all bits set that are set in this and flags.
Returns an instance of ApplicationFlags that has all bits set that are set in this and flag.
Returns an instance of ApplicationFlags that has all bits set that are set in this and flags.
The position of the bit that is set in this ApplicationFlag. This is always in 0..30.
The position of the bit that is set in this ApplicationFlag. This is always in 0..30.
Returns an instance of ApplicationFlags built with ApplicationFlags.Builder.
Returns an instance of ApplicationFlags that has all bits set that are set in any element of flags.
Returns an instance of ApplicationFlags built with ApplicationFlags.Builder.
Returns an instance of ApplicationFlags that has all bits set that are set in any element of flags.
Returns an instance of ApplicationFlags that has all bits set that are currently set in this Builder.
Returns an instance of ApplicationFlags that has all bits set that are currently set in this Builder.
Unsets all bits in the Builder that are set in this ApplicationFlag.
Unsets all bits in the Builder that are set in this ApplicationFlags.
Unsets all bits in the Builder that are set in this ApplicationFlag.
Unsets all bits in the Builder that are set in this ApplicationFlags.
Sets all bits in the Builder that are set in this ApplicationFlag.
Sets all bits in the Builder that are set in this ApplicationFlags.
Sets all bits in the Builder that are set in this ApplicationFlag.
Sets all bits in the Builder that are set in this ApplicationFlags.
Checks if this instance of ApplicationFlags has all bits set that are set in flag.
Checks if this instance of ApplicationFlags has all bits set that are set in flags.
Checks if this instance of ApplicationFlags has all bits set that are set in flag.
Checks if this instance of ApplicationFlags has all bits set that are set in flags.
Returns a copy of this instance of ApplicationFlags modified with builder.
Returns a copy of this instance of ApplicationFlags modified with builder.
A collection of multiple ApplicationFlags.
You can create an instance of ApplicationFlags using the following methods:
// from individual ApplicationFlags
val applicationFlags1 = ApplicationFlags(ApplicationFlag.ApplicationAutoModerationRuleCreateBadge, ApplicationFlag.GatewayPresence)
// from an Iterable
val iterable: Iterable<ApplicationFlag> = TODO()
val applicationFlags2 = ApplicationFlags(iterable)
// using a builder
val applicationFlags3 = ApplicationFlags {
+applicationFlags2
+ApplicationFlag.ApplicationAutoModerationRuleCreateBadge
-ApplicationFlag.GatewayPresence
}You can create a modified copy of an existing instance of ApplicationFlags using the copy method:
applicationFlags.copy {
+ApplicationFlag.ApplicationAutoModerationRuleCreateBadge
}All ApplicationFlags objects can use +/- operators:
val applicationFlags1 = applicationFlags + ApplicationFlag.ApplicationAutoModerationRuleCreateBadge
val applicationFlags2 = applicationFlags - ApplicationFlag.GatewayPresence
val applicationFlags3 = applicationFlags1 + applicationFlags2You can use the contains operator to check whether an instance of ApplicationFlags contains specific ApplicationFlags:
val hasApplicationFlag = ApplicationFlag.ApplicationAutoModerationRuleCreateBadge in applicationFlags
val hasApplicationFlags = ApplicationFlags(ApplicationFlag.ApplicationAutoModerationRuleCreateBadge, ApplicationFlag.GatewayPresence) in applicationFlagsWhenever ApplicationFlags haven't been added to Kord yet, they will be deserialized as instances of ApplicationFlag.Unknown.
You can also use ApplicationFlag.fromShift to check for unknown ApplicationFlags.
val hasUnknownApplicationFlag = ApplicationFlag.fromShift(23) in applicationFlagsA collection of multiple ApplicationFlags.
You can create an instance of ApplicationFlags using the following methods:
// from individual ApplicationFlags
val applicationFlags1 = ApplicationFlags(ApplicationFlag.ApplicationAutoModerationRuleCreateBadge, ApplicationFlag.GatewayPresence)
// from an Iterable
val iterable: Iterable<ApplicationFlag> = TODO()
val applicationFlags2 = ApplicationFlags(iterable)
// using a builder
val applicationFlags3 = ApplicationFlags {
+applicationFlags2
+ApplicationFlag.ApplicationAutoModerationRuleCreateBadge
-ApplicationFlag.GatewayPresence
}You can create a modified copy of an existing instance of ApplicationFlags using the copy method:
applicationFlags.copy {
+ApplicationFlag.ApplicationAutoModerationRuleCreateBadge
}All ApplicationFlags objects can use +/- operators:
val applicationFlags1 = applicationFlags + ApplicationFlag.ApplicationAutoModerationRuleCreateBadge
val applicationFlags2 = applicationFlags - ApplicationFlag.GatewayPresence
val applicationFlags3 = applicationFlags1 + applicationFlags2You can use the contains operator to check whether an instance of ApplicationFlags contains specific ApplicationFlags:
val hasApplicationFlag = ApplicationFlag.ApplicationAutoModerationRuleCreateBadge in applicationFlags
val hasApplicationFlags = ApplicationFlags(ApplicationFlag.ApplicationAutoModerationRuleCreateBadge, ApplicationFlag.GatewayPresence) in applicationFlagsWhenever ApplicationFlags haven't been added to Kord yet, they will be deserialized as instances of ApplicationFlag.Unknown.
You can also use ApplicationFlag.fromShift to check for unknown ApplicationFlags.
val hasUnknownApplicationFlag = ApplicationFlag.fromShift(23) in applicationFlagsReturns an instance of ApplicationFlags that has all bits set that are set in this except the bits that are set in flag.
Returns an instance of ApplicationFlags that has all bits set that are set in this except the bits that are set in flags.
Returns an instance of ApplicationFlags that has all bits set that are set in this except the bits that are set in flag.
Returns an instance of ApplicationFlags that has all bits set that are set in this except the bits that are set in flags.
Returns an instance of ApplicationFlags that has all bits set that are set in this and flag.
Returns an instance of ApplicationFlags that has all bits set that are set in this and flags.
Returns an instance of ApplicationFlags that has all bits set that are set in this and flag.
Returns an instance of ApplicationFlags that has all bits set that are set in this and flags.
A Set of all ApplicationFlags contained in this instance of ApplicationFlags.
A Set of all ApplicationFlags contained in this instance of ApplicationFlags.
The metadata value (integer) is equal to the guild's configured value (integer; 1).
The metadata value (integer) is equal to the guild's configured value (integer; 1).
The metadata value (integer) is not equal to the guild's configured value (integer; 1).
The metadata value (integer) is not equal to the guild's configured value (integer; 1).
A List of all known ApplicationRoleConnectionMetadataTypes.
A List of all known ApplicationRoleConnectionMetadataTypes.
The metadata value (ISO8601 string) is greater than or equal to the guild's configured value (integer; days before current date).
The metadata value (ISO8601 string) is greater than or equal to the guild's configured value (integer; days before current date).
The metadata value (ISO8601 string) is less than or equal to the guild's configured value (integer; days before current date).
The metadata value (ISO8601 string) is less than or equal to the guild's configured value (integer; days before current date).
The metadata value (integer) is equal to the guild's configured value (integer).
The metadata value (integer) is equal to the guild's configured value (integer).
The metadata value (integer) is greater than or equal to the guild's configured value (integer).
The metadata value (integer) is greater than or equal to the guild's configured value (integer).
The metadata value (integer) is less than or equal to the guild's configured value (integer).
The metadata value (integer) is less than or equal to the guild's configured value (integer).
The metadata value (integer) is not equal to the guild's configured value (integer).
The metadata value (integer) is not equal to the guild's configured value (integer).
An unknown ApplicationRoleConnectionMetadataType.
This is used as a fallback for ApplicationRoleConnectionMetadataTypes that haven't been added to Kord yet.
An unknown ApplicationRoleConnectionMetadataType.
This is used as a fallback for ApplicationRoleConnectionMetadataTypes that haven't been added to Kord yet.
Each ApplicationRoleConnectionMetadataType offers a comparison operation that allows guilds to configure role requirements based on metadata values stored by the bot. Bots specify a 'metadata value' for each user and guilds specify the required 'guild's configured value' within the guild role settings.
See ApplicationRoleConnectionMetadataTypes in the Discord Developer Documentation.
Each ApplicationRoleConnectionMetadataType offers a comparison operation that allows guilds to configure role requirements based on metadata values stored by the bot. Bots specify a 'metadata value' for each user and guilds specify the required 'guild's configured value' within the guild role settings.
See ApplicationRoleConnectionMetadataTypes in the Discord Developer Documentation.
A List of all known ArchiveDurations.
A List of all known ArchiveDurations.
An unknown ArchiveDuration.
This is used as a fallback for ArchiveDurations that haven't been added to Kord yet.
An unknown ArchiveDuration.
This is used as a fallback for ArchiveDurations that haven't been added to Kord yet.
The actual supertype is AuditLogChangeKey
The actual supertype is AuditLogChangeKey
Permissions were updated for a command.
Permissions were updated for a command.
Message was blocked by Auto Moderation.
Message was blocked by Auto Moderation.
Message was flagged by Auto Moderation.
Message was flagged by Auto Moderation.
Auto Moderation rule was created.
Auto Moderation rule was created.
Auto Moderation rule was deleted.
Auto Moderation rule was deleted.
Auto Moderation rule was updated.
Auto Moderation rule was updated.
Member was timed out by Auto Moderation.
Member was timed out by Auto Moderation.
Bot user was added to server.
Bot user was added to server.
Channel was created.
Channel was created.
Channel was deleted.
Channel was deleted.
Permission overwrite was added to a channel.
Permission overwrite was added to a channel.
Permission overwrite was deleted from a channel.
Permission overwrite was deleted from a channel.
Permission overwrite was updated for a channel.
Permission overwrite was updated for a channel.
Channel settings were updated.
Channel settings were updated.
A List of all known AuditLogEvents.
A List of all known AuditLogEvents.
Emoji was created.
Emoji was created.
Emoji was deleted.
Emoji was deleted.
Emoji name was updated.
Emoji name was updated.
Event was created.
Event was created.
Event was cancelled.
Event was cancelled.
Event was updated.
Event was updated.
Server settings were updated.
Server settings were updated.
App was added to server.
App was added to server.
App was removed from server.
App was removed from server.
App was updated (as an example, its scopes were updated).
App was updated (as an example, its scopes were updated).
Server invite was created.
Server invite was created.
Server invite was deleted.
Server invite was deleted.
Server invite was updated.
Server invite was updated.
Member was banned from server.
Member was banned from server.
Server ban was lifted for a member.
Server ban was lifted for a member.
Member was disconnected from a voice channel.
Member was disconnected from a voice channel.
Member was removed from server.
Member was removed from server.
Member was moved to a different voice channel.
Member was moved to a different voice channel.
Members were pruned from server.
Members were pruned from server.
Member was added or removed from a role.
Member was added or removed from a role.
Member was updated in server.
Member was updated in server.
Multiple messages were deleted.
Multiple messages were deleted.
Single message was deleted.
Single message was deleted.
Message was pinned to a channel.
Message was pinned to a channel.
Message was unpinned from a channel.
Message was unpinned from a channel.
Role was created.
Role was created.
Role was deleted.
Role was deleted.
Role was edited.
Role was edited.
Stage instance was created (stage channel becomes live).
Stage instance was created (stage channel becomes live).
Stage instance was deleted (stage channel no longer live).
Stage instance was deleted (stage channel no longer live).
Stage instance details were updated.
Stage instance details were updated.
Sticker was created.
Sticker was created.
Sticker was deleted.
Sticker was deleted.
Sticker details were updated.
Sticker details were updated.
Thread was created in a channel.
Thread was created in a channel.
Thread was deleted.
Thread was deleted.
Thread was updated.
Thread was updated.
An unknown AuditLogEvent.
This is used as a fallback for AuditLogEvents that haven't been added to Kord yet.
An unknown AuditLogEvent.
This is used as a fallback for AuditLogEvents that haven't been added to Kord yet.
Webhook was created.
Webhook was created.
Webhook was deleted.
Webhook was deleted.
Webhook properties or channel were updated.
Webhook properties or channel were updated.
Blocks a member's message and prevents it from being posted.
A custom explanation can be specified and shown to members whenever their message is blocked.
Blocks a member's message and prevents it from being posted.
A custom explanation can be specified and shown to members whenever their message is blocked.
A List of all known AutoModerationActionTypes.
A List of all known AutoModerationActionTypes.
Logs user content to a specified channel.
Logs user content to a specified channel.
Timeout user for a specified duration.
A Timeout action can only be set up for Keyword and MentionSpam rules. The ModerateMembers permission is required to use the Timeout action type.
Timeout user for a specified duration.
A Timeout action can only be set up for Keyword and MentionSpam rules. The ModerateMembers permission is required to use the Timeout action type.
An unknown AutoModerationActionType.
This is used as a fallback for AutoModerationActionTypes that haven't been added to Kord yet.
An unknown AutoModerationActionType.
This is used as a fallback for AutoModerationActionTypes that haven't been added to Kord yet.
The type of action.
See AutoModerationActionTypes in the Discord Developer Documentation.
The type of action.
See AutoModerationActionTypes in the Discord Developer Documentation.
A List of all known AutoModerationRuleEventTypes.
A List of all known AutoModerationRuleEventTypes.
When a member sends or edits a message in the guild.
When a member sends or edits a message in the guild.
An unknown AutoModerationRuleEventType.
This is used as a fallback for AutoModerationRuleEventTypes that haven't been added to Kord yet.
An unknown AutoModerationRuleEventType.
This is used as a fallback for AutoModerationRuleEventTypes that haven't been added to Kord yet.
Indicates in what event context a rule should be checked.
See AutoModerationRuleEventTypes in the Discord Developer Documentation.