data

package data

Source: package.scala

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

data
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Package Members

package raw

Type Members

case class ActionRow extends Component with Product with Serializable
sealed trait ActionRowContent extends Component
sealed trait Activity extends AnyRef
The text in a presence
case class ActivityAsset(largeImage: Option[String], largeText: Option[String], smallImage: Option[String], smallText: Option[String]) extends Product with Serializable
largeImage
Id for the large asset. Usually a snowflake.
largeText
Text displayed when hovering over the large image.
smallImage
Id for the small asset. Usually a snowflake.
smallText
Text displayed when hovering over the small image.
case class ActivityEmoji(name: String, id: Option[EmojiId], animated: Option[Boolean]) extends Product with Serializable
The emoji of a custom status.
type ActivityFlags = data.ActivityFlags.ActivityFlags
implicit final class ActivityFlagsSyntax extends AnyVal
case class ActivityParty(id: Option[String], currentSize: Option[Int], maxSize: Option[Int]) extends Product with Serializable
id
The id of the party
currentSize
The current size of the party.
maxSize
The max size of the party.
case class ActivitySecrets(join: Option[String], spectate: Option[String], match: Option[String]) extends Product with Serializable
join
Secret for joining a party.
spectate
Secret for spectating a game.
case class ActivityTimestamps(start: Option[Instant], end: Option[Instant]) extends Product with Serializable
start
When the activity started.
end
When the activity will end.
sealed abstract class ActivityType extends IntEnumEntry
case class AllowedMention(parse: Seq[AllowedMentionTypes] = Seq.empty, roles: Seq[RoleId] = Seq.empty, users: Seq[UserId] = Seq.empty, repliedUser: Boolean = false) extends Product with Serializable
parse
Which mention types should be allowed.
roles
The roles to allow mention.
users
The users to allow mention.
repliedUser
For replires, if the author of the message you are replying to should be mentioned.
sealed abstract class AllowedMentionTypes extends StringEnumEntry
case class Application(id: ApplicationId, name: String, icon: Option[String], description: String, rpcOrigins: Option[Seq[String]], botPublic: Boolean, botRequireCodeGrant: Boolean, termsOfServiceUrl: Option[String], privacyPolicyUrl: Option[String], owner: Option[PartialUser], summary: String, verifyKey: String, team: Option[Team], guildId: Option[GuildId], primarySkuId: Option[RawSnowflake], slug: Option[String], coverImage: Option[String], flags: Option[ApplicationFlags]) extends Product with Serializable
id
Id of the application.
name
Name of the application.
icon
Icon hash for the application.
description
Description of the application.
rpcOrigins
A sequence of RPC origin urls, if RPC is enabled.
botPublic
If other users can add this bot to guilds.
botRequireCodeGrant
If the bot requires the full OAuth2 code grant flow to join a guild.
termsOfServiceUrl
URL for the application's ToS
privacyPolicyUrl
URL for the application's privacy policy
owner
The owner of the application
summary
If this application is a game sold on Discord, then this is a short summary
verifyKey
Hex encoded hey for verification in interactions and the GameSDK's GetTicket
team
The team the application belongs to, if it belongs to one
guildId
If this application is a game sold on Discord, the guild id it has been linked to
primarySkuId
If this application is a game sold on Discord, this is the id of the "Game SKU" that is created if it exists
slug
If this application is a game sold on Discord, an URL slug that links to the store page
coverImage
This application's default rich presence invite cover image hash
flags
This application's public flags
case class ApplicationCommand(id: CommandId, type: ApplicationCommandType, applicationId: ApplicationId, guildId: Option[String], name: String, description: String, options: Option[Seq[ApplicationCommandOption]], defaultPermission: Option[Boolean], version: RawSnowflake) extends Product with Serializable
case class ApplicationCommandInteractionData(id: CommandId, name: String, type: ApplicationCommandType, resolved: Option[ApplicationCommandInteractionDataResolved], options: Option[Seq[ApplicationCommandInteractionDataOption[_]]], targetId: Option[RawSnowflake]) extends ApplicationInteractionData with Product with Serializable
case class ApplicationCommandInteractionDataOption[A](name: String, tpe: Aux[A], value: Option[A], focused: Option[Boolean]) extends Product with Serializable
case class ApplicationCommandInteractionDataResolved(users: Map[UserId, User], members: Map[UserId, InteractionRawGuildMember], roles: Map[RoleId, RawRole], channels: Map[TextGuildChannelId, InteractionChannel], messages: Map[MessageId, InteractionPartialMessage]) extends Product with Serializable
case class ApplicationCommandOption(type: ApplicationCommandOptionType, name: String, description: String, required: Option[Boolean], choices: Option[Seq[ApplicationCommandOptionChoice]], autocomplete: Option[Boolean], options: Option[Seq[ApplicationCommandOption]], channelTypes: Option[Seq[ChannelType]], minValue: Option[Either[Int, Double]], maxValue: Option[Either[Int, Double]]) extends Product with Serializable
sealed trait ApplicationCommandOptionChoice extends AnyRef
case class ApplicationCommandOptionChoiceInteger(name: String, value: Long) extends ApplicationCommandOptionChoice with Product with Serializable
case class ApplicationCommandOptionChoiceNumber(name: String, value: Double) extends ApplicationCommandOptionChoice with Product with Serializable
case class ApplicationCommandOptionChoiceString(name: String, value: String) extends ApplicationCommandOptionChoice with Product with Serializable
sealed trait ApplicationCommandOptionType extends IntEnumEntry
sealed abstract class ApplicationCommandPermissionType extends IntEnumEntry
case class ApplicationCommandPermissions(id: UserOrRoleId, type: ApplicationCommandPermissionType, permission: Boolean) extends Product with Serializable
sealed abstract class ApplicationCommandType extends IntEnumEntry
case class ApplicationComponentInteractionData(componentType: ComponentType, customId: String, values: Option[Seq[String]]) extends ApplicationInteractionData with Product with Serializable
type ApplicationFlags = data.ApplicationFlags.ApplicationFlags
implicit final class ApplicationFlagsSyntax extends AnyVal
type ApplicationId = data.SnowflakeType.SnowflakeType[Application]
sealed trait ApplicationInteractionData extends AnyRef
case class ApplicationUnknownInteractionData(data: Json) extends ApplicationInteractionData with Product with Serializable
case class Attachment(id: SnowflakeType[Attachment], filename: String, description: Option[String], contentType: Option[String], size: Int, url: String, proxyUrl: String, height: Option[Int], width: Option[Int], ephemeral: Option[Boolean]) extends Product with Serializable
An attachment for a message
An attachment for a message
id
The id of the attachment
filename
The filename of the attachment
description
Description of the attachment
contentType
The attachment's media type
size
The file size in bytes
url
The url of the attachment
proxyUrl
The proxyUrl of the attachment
height
The height of the attachment if it's an image
width
The width of the attachment if it's an image
case class AuditLog(auditLogEntries: Seq[AuditLogEntry], guildScheduledEvents: Seq[GuildScheduledEvent], integrations: Seq[PartialIntegration], threads: Seq[RawChannel], users: Seq[User], webhooks: Seq[Webhook]) extends Product with Serializable
Root audit log object.
Root audit log object. Received from ackcord.requests.GetGuildAuditLog
auditLogEntries
The entries of the log
guildScheduledEvents
The guild scheduled events found in the log
integrations
The integrations found in the log
threads
The threads found in the log
users
The users found in the log
webhooks
The webhooks found in the log
sealed trait AuditLogChange[A] extends AnyRef
Some sort of change
Some sort of change
A
The data type that changed
case class AuditLogEntry(targetId: Option[RawSnowflake], changes: Option[Seq[AuditLogChange[_]]], userId: Option[UserId], id: RawSnowflake, actionType: AuditLogEvent, options: Option[OptionalAuditLogInfo], reason: Option[String]) extends Product with Serializable
An individual audit log event
An individual audit log event
targetId
The id of the affected object
changes
The changes made to the object
userId
The user responsible for the changes
id
The id of this entry
actionType
Type of change that happened
options
Optional extra data for some changes, see comments on OptionalAuditLogInfo for more info
reason
The reason for the change
sealed abstract class AuditLogEvent extends IntEnumEntry
A type of change that an entry can represent
sealed trait Author[A] extends AnyRef
A author of a message.
A author of a message. While a message is normally sent by a User, it can also be sent by a WebhookAuthor.
case class Ban(reason: Option[String], userId: UserId) extends Product with Serializable
Represents a banned user.
Represents a banned user.
reason
Why the user was banned.
userId
The user that was baned.
sealed trait Button extends ActionRowContent
sealed abstract class ButtonStyle extends IntEnumEntry
sealed trait Channel extends AnyRef
Base channel type
type ChannelId = data.SnowflakeType.SnowflakeType[Channel]
implicit final class ChannelIdSyntax extends AnyVal
case class ChannelMention(id: TextChannelId, guildId: GuildId, type: ChannelType, name: String) extends Product with Serializable
Basic info of a channel in a cross posted message.
Basic info of a channel in a cross posted message.
id
The id of the channel
guildId
The guild the channel is in
name
The name of the channel
sealed abstract class ChannelType extends IntEnumEntry
Different type of channels
case class ClientStatus(desktop: Option[PresenceStatus], mobile: Option[PresenceStatus], web: Option[PresenceStatus]) extends Product with Serializable
The status of a user per platform.
The status of a user per platform. Not present if the user is offline, or invisible.
type CommandId = data.SnowflakeType.SnowflakeType[ApplicationCommand]
sealed trait Component extends AnyRef
sealed abstract class ComponentType extends IntEnumEntry
case class Connection(id: String, name: String, type: String, revoked: Option[Boolean], integrations: Option[Seq[Integration]], verified: Boolean, friendSync: Boolean, showActivity: Boolean, visibility: ConnectionVisibility) extends Product with Serializable
A connection that a user has attached.
A connection that a user has attached.
id
The id of the connection.
name
The name of the connection.
revoked
If the connection has been revoked.
integrations
Integrations of the connection.
verified
If the connection is verified.
friendSync
If friend sync is enabled for the connection.
showActivity
If things related this this connection will be included in presence updates.
visibility
The visibility of the connection
sealed abstract class ConnectionVisibility extends IntEnumEntry
case class CreatedInvite(channelId: GuildChannelId, code: String, createdAt: OffsetDateTime, guildId: Option[GuildId], inviter: Option[User], maxAge: Int, maxUses: Int, targetUser: Option[User], targetType: Option[InviteTargetType], targetApplication: Option[PartialApplication], temporary: Boolean, uses: Int) extends Product with Serializable
A newly created invite.
A newly created invite.
channelId
The channel the invite is for.
code
An invite code.
createdAt
When this invite was created
guildId
The guild the invite is for.
inviter
The user that created the invite.
maxAge
The duration in seconds when the invite will expire
maxUses
How many times this invite can be used.
targetUser
The user who's stream should be displayed for this invite.
targetType
The type of target for this voice channel invite.
targetApplication
The embedded application to open for this voice channel embedded application invite.
temporary
If this invite is temporary
uses
How many times the invite has been used.
case class DMChannel(id: SnowflakeType[DMChannel], lastMessageId: Option[MessageId], userId: UserId) extends Channel with TextChannel with GetUser with Product with Serializable
A DM text channel
case class DiscordIntegration(id: IntegrationId, name: String, enabled: Boolean, account: IntegrationAccount, application: IntegrationApplication) extends Integration with Product with Serializable
A discord bot/OAuth2 integration.
A discord bot/OAuth2 integration.
id
The id of the integration
name
The integration name
enabled
If the integration is enabled
account
Account information
application
The bot/OAuth2 application
trait DiscordProtocol extends AnyRef
case class EmbedField(name: String, value: String, inline: Option[Boolean] = None) extends Product with Serializable
A field for an embed
A field for an embed
name
The name or title of the field.
value
The value or text of the field
inline
If the field is rendered inline.
sealed abstract class EmbedType extends StringEnumEntry
case class Emoji(id: EmojiId, name: String, roles: Seq[RoleId], userId: Option[UserId], requireColons: Option[Boolean], managed: Option[Boolean], animated: Option[Boolean], available: Option[Boolean]) extends Product with Serializable
An emoji in a guild.
An emoji in a guild.
id
The id of the emoji.
name
The emoji name.
roles
The roles that can use this emoji.
userId
The id of the user that created this emoji.
requireColons
If the emoji requires colons.
managed
If the emoji is managed.
animated
If the emoji is animated.
available
If the emoji can be used.
type EmojiId = data.SnowflakeType.SnowflakeType[Emoji]
implicit final class EmojiIdSyntax extends AnyVal
case class ExternalIntegration(id: IntegrationId, name: String, type: IntegrationType, enabled: Boolean, syncing: Boolean, roleId: RoleId, enableEmoticons: Option[Boolean], expireBehavior: IntegrationExpireBehavior, expireGracePeriod: Int, user: Option[User], account: IntegrationAccount, syncedAt: OffsetDateTime, subscriberCount: Int, revoked: Boolean, application: Option[IntegrationApplication]) extends Integration with Product with Serializable
A server integration
A server integration
id
The id of the integration
name
The integration name
enabled
If the integration is enabled
syncing
If the integration is synced
roleId
Role that this integration uses for subscribers, or guild id for Discord integrations
expireBehavior
The behavior of expiring subscribers.
expireGracePeriod
The grace period before expiring subscribers.
user
The user for this integration
account
Account information
syncedAt
When the integration last synced'
subscriberCount
How many subscribers this integration has. 0 for Discord
revoked
If this integration has been revoked
sealed abstract class FilterLevel extends IntEnumEntry
The different explicit content filter levels to use for a guild.
sealed abstract class FormatType extends IntEnumEntry
case class GatewayGuild(id: GuildId, name: String, icon: Option[String], iconHash: Option[String], splash: Option[String], discoverySplash: Option[String], ownerId: UserId, afkChannelId: Option[NormalVoiceGuildChannelId], afkTimeout: Int, widgetEnabled: Option[Boolean], widgetChannelId: Option[GuildChannelId], verificationLevel: VerificationLevel, defaultMessageNotifications: NotificationLevel, explicitContentFilter: FilterLevel, roles: SnowflakeMap[Role, Role], emojis: SnowflakeMap[Emoji, Emoji], features: Seq[GuildFeature], mfaLevel: MFALevel, applicationId: Option[ApplicationId], systemChannelId: Option[TextGuildChannelId], systemChannelFlags: SystemChannelFlags, rulesChannelId: Option[TextGuildChannelId], joinedAt: OffsetDateTime, large: Boolean, memberCount: Int, voiceStates: SnowflakeMap[User, VoiceState], members: SnowflakeMap[User, GuildMember], channels: SnowflakeMap[GuildChannel, GuildChannel], threads: SnowflakeMap[ThreadGuildChannel, ThreadGuildChannel], presences: SnowflakeMap[User, Presence], maxPresences: Option[Int], maxMembers: Option[Int], vanityUrlCode: Option[String], description: Option[String], banner: Option[String], premiumTier: PremiumTier, premiumSubscriptionCount: Option[Int], preferredLocale: Option[String], publicUpdatesChannelId: Option[TextGuildChannelId], maxVideoChannelUsers: Option[Int], nsfwLevel: NSFWLevel, stageInstances: SnowflakeMap[StageInstance, StageInstance], stickers: SnowflakeMap[Sticker, Sticker], guildScheduledEvents: SnowflakeMap[GuildScheduledEvent, GuildScheduledEvent], premiumProgressBarEnabled: Boolean) extends Guild with Product with Serializable
A guild or server in Discord received over the Gateway.
A guild or server in Discord received over the Gateway.
joinedAt
When the client joined the guild.
large
If this guild is above the large threshold.
memberCount
The amount of members in the guild.
voiceStates
The voice states of the guild.
members
The guild members in the guild.
channels
The channels in the guild.
presences
The presences in the guild.
publicUpdatesChannelId
The channel where admin and mods can see public updates are sent to public guilds.
maxVideoChannelUsers
The max amount of users in a video call.
trait GetGuild extends AnyRef
trait GetGuildOpt extends AnyRef
trait GetUser extends AnyRef
trait GetVoiceChannelOpt extends AnyRef
case class GroupDMChannel(id: SnowflakeType[GroupDMChannel], name: String, users: Seq[UserId], lastMessageId: Option[MessageId], ownerId: UserId, applicationId: Option[ApplicationId], icon: Option[String]) extends Channel with TextChannel with Product with Serializable
A group DM text channel
A group DM text channel
users
The users in this group DM
ownerId
The creator of this channel
applicationId
The applicationId of the application that created this channel, if the channel wasn't created by a user
icon
The icon hash for this group dm
sealed trait Guild extends UnknownStatusGuild
case class GuildApplicationCommandPermissions(id: CommandId, applicationId: ApplicationId, guildId: GuildId, permissions: Seq[ApplicationCommandPermissions]) extends Product with Serializable
case class GuildCategory(id: SnowflakeType[GuildCategory], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], nsfw: Boolean) extends GuildChannel with Product with Serializable
A category in a guild
sealed trait GuildChannel extends Channel with GetGuild
A channel within a guild
type GuildChannelId = data.SnowflakeType.SnowflakeType[GuildChannel]
implicit final class GuildChannelIdSyntax extends AnyVal
sealed abstract class GuildFeature extends StringEnumEntry
case class GuildGatewayMessage(id: MessageId, channelId: TextGuildChannelId, guildId: GuildId, authorId: RawSnowflake, isAuthorUser: Boolean, authorUsername: String, member: Option[GuildMember], content: String, timestamp: OffsetDateTime, editedTimestamp: Option[OffsetDateTime], tts: Boolean, mentionEveryone: Boolean, mentions: Seq[UserId], mentionRoles: Seq[RoleId], mentionChannels: Seq[ChannelMention], attachments: Seq[Attachment], embeds: Seq[ReceivedEmbed], reactions: Seq[Reaction], nonce: Option[String], pinned: Boolean, messageType: MessageType, activity: Option[MessageActivity], application: Option[PartialApplication], applicationId: Option[ApplicationId], messageReference: Option[MessageReference], flags: Option[MessageFlags], stickers: Option[Seq[Sticker]], stickerItems: Option[Seq[StickerItem]], referencedMessage: Option[Message], interaction: Option[MessageInteraction], components: Seq[ActionRow], threadId: Option[ThreadGuildChannelId]) extends Message with Product with Serializable
A message sent with additional guild info.
A message sent with additional guild info. Note that a message can still be sent to a guild, but be missing the guild info. For example if it's gotten from a REST request.
guildId
The guild this message was sent to.
isAuthorUser
If the author of this message was a user.
member
The guild member user that sent this message.
mentionRoles
All the roles this message mentions.
type GuildId = data.SnowflakeType.SnowflakeType[Guild]
implicit final class GuildIdSyntax extends AnyVal
case class GuildMember(userId: UserId, guildId: GuildId, nick: Option[String], avatar: Option[String], roleIds: Seq[RoleId], joinedAt: Option[OffsetDateTime], premiumSince: Option[OffsetDateTime], deaf: Boolean, mute: Boolean, pending: Option[Boolean], communicationDisabledUntil: Option[OffsetDateTime]) extends GetUser with GetGuild with Product with Serializable
Represents a user in a guild.
Represents a user in a guild.
userId
The user of this member.
guildId
The guild this member belongs to.
nick
The nickname of this user in this guild.
roleIds
The roles of this user.
joinedAt
When this user joined the guild.
premiumSince
When this user boosted the server.
deaf
If this user is deaf.
mute
IF this user is mute.
pending
True if the member hasn't gotten past the guild screening yet
case class GuildPreview(id: GuildId, name: String, icon: Option[String], splash: Option[String], discoverySplash: Option[String], emojis: Seq[RawEmoji], features: Seq[GuildFeature], approximateMemberCount: Int, approximatePresenceCount: Int, description: Option[String]) extends Product with Serializable
A preview of a public guild
A preview of a public guild
id
The id of the guild.
name
The name of the guild.
icon
The icon hash.
splash
The splash hash.
discoverySplash
The discovery splash hash.
emojis
The emojis of the guild.
features
The enabled guild features.
approximateMemberCount
An approximate count of the members in the guild.
approximatePresenceCount
An approximate count of the presences in the guild.
description
A description for the guild
case class GuildScheduledEvent(id: SnowflakeType[GuildScheduledEvent], guildId: GuildId, channelId: Option[VoiceGuildChannelId], creatorId: Option[UserId], name: String, description: Option[String], scheduledStartTime: OffsetDateTime, scheduledEndTime: Option[OffsetDateTime], privacyLevel: GuildScheduledEventPrivacyLevel, status: GuildScheduledEventStatus, entityType: GuildScheduledEventEntityType, entityId: Option[SnowflakeType[StageInstance]], entityMetadata: Option[GuildScheduledEventEntityMetadata], creator: Option[User], userCount: Option[Int]) extends Product with Serializable
A scheduled event within a guild.
A scheduled event within a guild.
id
The id of the event
guildId
The id of the guild the event takes place in.
channelId
The id of the channel the event takes place in, if it takes place in a channel.
creatorId
The creator id of the event.
name
Name of the event.
description
Description of the event.
scheduledStartTime
Time the event will start.
scheduledEndTime
Time the event will end.
privacyLevel
Privacy level of the event.
status
Status of the event.
entityType
The type of the event.
entityId
Id of an entity associated with the event.
entityMetadata
Additional metadata.
creator
The creator of the event.
userCount
Number of users subscribed to the event.
case class GuildScheduledEventEntityMetadata(location: Option[String]) extends Product with Serializable
sealed abstract class GuildScheduledEventEntityType extends IntEnumEntry
sealed abstract class GuildScheduledEventPrivacyLevel extends IntEnumEntry
sealed abstract class GuildScheduledEventStatus extends IntEnumEntry
case class GuildScheduledEventUser(guildScheduledEventId: SnowflakeType[GuildScheduledEvent], user: User, member: RawGuildMember) extends Product with Serializable
case class GuildStoreChannel(id: SnowflakeType[GuildStoreChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]]) extends GuildChannel with Product with Serializable
A store channel in a guild
case class GuildTemplate(code: String, name: String, description: Option[String], usageCount: Int, creatorId: UserId, creator: User, createdAt: OffsetDateTime, updatedAt: OffsetDateTime, sourceGuildId: GuildId, serializedSourceGuild: RawGuild, isDirty: Option[Boolean]) extends Product with Serializable
code
The code of the template
name
Name of the template
description
Description of the template
usageCount
How many times the template has been used
creatorId
Id of the user who created the template
creator
Creator of the template
createdAt
When the template was created
updatedAt
When the template was updated
sourceGuildId
What was the source of the template
serializedSourceGuild
A snapshot of the guild this template was created from
isDirty
If the template has unsaved changes
case class GuildWidget(id: GuildId, name: String, instantInvite: String, channels: Seq[GuildWidgetChannel], members: Seq[GuildWidgetMember], presenceCount: Int) extends Product with Serializable
The object returned when getting the widget for a guild
case class GuildWidgetChannel(id: GuildChannelId, name: String, position: Int) extends Product with Serializable
case class GuildWidgetMember(id: UserId, username: String, discriminator: String, avatar: Option[String], status: PresenceStatus, avatarUrl: String) extends Product with Serializable
case class GuildWidgetSettings(enabled: Boolean, channelId: Option[GuildChannelId]) extends Product with Serializable
final class ImageData extends AnyVal
sealed trait ImageFormat extends AnyRef
sealed trait Integration extends AnyRef
case class IntegrationAccount(id: String, name: String) extends Product with Serializable
id
The id of the account
name
The name of the account
case class IntegrationApplication(id: ApplicationId, name: String, icon: Option[String], description: String, summary: String, bot: Option[User]) extends Product with Serializable
id
The id of the application
name
The name of the application
icon
The icon hash of the application
description
The description of the application
summary
The summary of the application
bot
The bot user of the application
sealed abstract class IntegrationExpireBehavior extends IntEnumEntry
type IntegrationId = data.SnowflakeType.SnowflakeType[Integration]
sealed abstract class IntegrationType extends StringEnumEntry
sealed trait InteractionCallbackData extends AnyRef
case class InteractionCallbackDataAutocomplete(choices: Seq[ApplicationCommandOptionChoice]) extends InteractionCallbackData with Product with Serializable
case class InteractionCallbackDataMessage(tts: Option[Boolean] = None, content: Option[String] = None, embeds: Seq[OutgoingEmbed] = Nil, allowedMentions: Option[AllowedMention] = None, flags: MessageFlags = MessageFlags.None, components: Option[Seq[ActionRow]] = None, attachments: Option[Seq[PartialAttachment]] = None) extends InteractionCallbackData with Product with Serializable
case class InteractionChannel(id: TextGuildChannelId, name: String, type: ChannelType, permissions: Permission, threadMetadata: Option[RawThreadMetadata], parentId: Option[TextGuildChannelId]) extends Product with Serializable
case class InteractionGuildMember(user: User, avatar: Option[String], nick: Option[String], roles: Seq[RoleId], joinedAt: Option[OffsetDateTime], premiumSince: Option[OffsetDateTime], pending: Option[Boolean], communicationDisabledUntil: Option[OffsetDateTime]) extends Product with Serializable
type InteractionId = data.SnowflakeType.SnowflakeType[RawInteraction]
case class InteractionPartialMessage(id: MessageId, channelId: TextChannelId, author: User, content: String, timestamp: OffsetDateTime, editedTimestamp: Option[OffsetDateTime], tts: Boolean, mentionEveryone: Boolean, mentions: Seq[User], mentionRoles: Seq[RoleId], attachments: Seq[Attachment], embeds: Seq[ReceivedEmbed], pinned: Boolean, type: MessageType, flags: MessageFlags, components: Option[Seq[ActionRow]]) extends Product with Serializable
case class InteractionRawGuildMember(nick: Option[String], avatar: Option[String], roles: Seq[RoleId], joinedAt: Option[OffsetDateTime], premiumSince: Option[OffsetDateTime], pending: Option[Boolean], communicationDisabledUntil: Option[OffsetDateTime]) extends Product with Serializable
sealed abstract class InteractionResponseType extends IntEnumEntry
sealed abstract class InteractionType extends IntEnumEntry
case class Invite(code: String, guild: Option[InviteGuild], channel: InviteChannel, inviter: Option[User], targetUser: Option[User], targetType: Option[InviteTargetType], targetApplication: Option[PartialApplication], approximatePresenceCount: Option[Int], approximateMemberCount: Option[Int], expiresAt: Option[OffsetDateTime], stageInstance: Option[InviteStageInstance], guildScheduledInvite: Option[GuildScheduledEvent]) extends Product with Serializable
A simple invite.
A simple invite.
code
An invite code.
guild
The guild the invite is for.
channel
The channel the invite is for.
targetUser
The user who's stream should be displayed for this invite.
targetType
The type of target for this voice channel invite.
targetApplication
The embedded application to open for this voice channel embedded application invite.
approximatePresenceCount
Approximate amount of people online.
approximateMemberCount
Approximate amount of total members.
stageInstance
Stage instance if there is a public stage instance in the stage channel this invite leads to.
case class InviteChannel(id: GuildChannelId, name: String, type: ChannelType) extends Product with Serializable
A partial channel with the information used by an invite
A partial channel with the information used by an invite
id
The channel id
name
The channel name
case class InviteGuild(id: GuildId, name: String, splash: Option[String], banner: Option[String], description: Option[String], icon: Option[String], features: Seq[GuildFeature], verificationLevel: VerificationLevel, vanityUrlCode: Option[String], welcomeScreen: Option[WelcomeScreen]) extends Product with Serializable
A partial guild with the information used by an invite
A partial guild with the information used by an invite
id
The guild id
name
The guild name
splash
The guild splash hash
banner
The banner of the guild
description
The description for the guild
icon
The guild icon hash
features
The guild features for the guild
verificationLevel
The verification level of the guild
vanityUrlCode
The vanity URL code for the guild
case class InviteStageInstance(members: Seq[InviteStageInstanceMember], participantCount: Int, speakerCount: Int, topic: String) extends Product with Serializable
case class InviteStageInstanceMember(roles: Seq[RoleId], nick: Option[String], avatar: Option[String], premiumSince: Option[OffsetDateTime], joinedAt: OffsetDateTime, pending: Option[Boolean], user: User) extends Product with Serializable
sealed abstract class InviteTargetType extends IntEnumEntry
case class InviteWithMetadata(code: String, guild: Option[InviteGuild], channel: InviteChannel, inviter: Option[User], targetUser: Option[User], targetType: Option[InviteTargetType], targetApplication: Option[PartialApplication], approximatePresenceCount: Option[Int], approximateMemberCount: Option[Int], expiresAt: Option[OffsetDateTime], stageInstance: Option[InviteStageInstance], uses: Int, maxUses: Int, maxAge: Int, temporary: Boolean, createdAt: OffsetDateTime) extends Product with Serializable
An invite with extra information.
An invite with extra information.
code
An invite code.
guild
The guild the invite is for.
channel
The channel the invite is for.
targetUser
The user who's stream should be displayed for this invite.
targetType
The type of target for this voice channel invite.
targetApplication
The embedded application to open for this voice channel embedded application invite.
approximatePresenceCount
Approximate amount of people online.
approximateMemberCount
Approximate amount of total members.
stageInstance
Stage instance if there is a public stage instance in the stage channel this invite leads to.
uses
How many times the invite has been used.
maxUses
How many times this invite can be used.
maxAge
The duration in seconds when the invite will expire
temporary
If this invite is temporary
createdAt
When this invite was created
case class LinkButton(label: Option[String] = None, emoji: Option[PartialEmoji] = None, urlLink: String, disabled: Option[Boolean] = None) extends Button with Product with Serializable
sealed abstract class MFALevel extends IntEnumEntry
sealed trait Message extends AnyRef
case class MessageActivity(activityType: MessageActivityType, partyId: Option[String]) extends Product with Serializable
activityType
Activity type.
partyId
Party id from rich presence.
sealed abstract class MessageActivityType extends IntEnumEntry
type MessageFlags = data.MessageFlags.MessageFlags
implicit final class MessageFlagsSyntax extends AnyVal
type MessageId = data.SnowflakeType.SnowflakeType[Message]
implicit final class MessageIdSyntax extends AnyVal
case class MessageInteraction(id: String, type: InteractionType, name: String, user: User) extends Product with Serializable
This is sent on the message object when the message is a response to an Interaction.
This is sent on the message object when the message is a response to an Interaction.
id
id of the interaction
type
the type of interaction
name
the name of the ApplicationCommand
user
the user who invoked the interaction
case class MessageReference(messageId: Option[MessageId], channelId: TextChannelId, guildId: Option[GuildId]) extends Product with Serializable
A reference to another message.
sealed abstract class MessageType extends IntEnumEntry
An enum of all the different message types.
sealed abstract class NSFWLevel extends IntEnumEntry
case class NewsTextGuildChannel(id: SnowflakeType[NewsTextGuildChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], topic: Option[String], lastMessageId: Option[MessageId], nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]], lastPinTimestamp: Option[OffsetDateTime], defaultAutoArchiveDuration: Option[Int]) extends TextGuildChannel with Product with Serializable
A news channel in a guild.
A news channel in a guild. For the most part you can treat this like any other text channel.
case class NormalTextGuildChannel(id: SnowflakeType[NormalTextGuildChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], topic: Option[String], lastMessageId: Option[MessageId], rateLimitPerUser: Option[Int], nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]], lastPinTimestamp: Option[OffsetDateTime], defaultAutoArchiveDuration: Option[Int]) extends TextGuildChannel with Product with Serializable
A normal text channel in a guild
case class NormalVoiceGuildChannel(id: SnowflakeType[NormalVoiceGuildChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], bitrate: Int, userLimit: Int, nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]], rtcRegion: Option[String], videoQualityMode: VideoQualityMode) extends VoiceGuildChannel with Product with Serializable
A voice channel in a guild
A voice channel in a guild
userLimit
The max amount of users that can join this channel.
videoQualityMode
The quality of video in the channel.
type NormalVoiceGuildChannelId = data.SnowflakeType.SnowflakeType[NormalVoiceGuildChannel]
implicit final class NormalVoiceGuildChannelIdSyntax extends AnyVal
sealed abstract class NotificationLevel extends IntEnumEntry
The different notification levels that can be used for a guild
case class OptionalAuditLogInfo(channelId: Option[TextChannelId], count: Option[String], deleteMemberDays: Option[String], id: Option[UserOrRoleId], membersRemoved: Option[String], messageId: Option[MessageId], roleName: Option[String], type: Option[PermissionOverwriteType]) extends Product with Serializable
Extra data for an entry
Extra data for an entry
channelId
The channelId of the deleted message. Present for MemberMove, MessagePin, MessageUnpin, MessageDelete, StageInstanceCreate, StageInstanceUpdate and StageInstanceDelete.
count
The amount of deleted messages. Present for MessageDelete, MessageBulkDelete, MemberDisconnect and MemberMove.
deleteMemberDays
The amount of days before a user was considered inactive and kicked. Present for MemberPrune.
id
The id of the overwritten object. Present for overwrite events.
membersRemoved
The amount of members removed. Present for MemberPrune.
messageId
The message that was targeted. Present for MessagePin and MessageUnpin.
roleName
The name of the role. Present for overwrite events if type == Role.
case class OutgoingEmbed(title: Option[String] = None, description: Option[String] = None, url: Option[String] = None, timestamp: Option[OffsetDateTime] = None, color: Option[Int] = None, footer: Option[OutgoingEmbedFooter] = None, image: Option[OutgoingEmbedImage] = None, video: Option[OutgoingEmbedVideo] = None, thumbnail: Option[OutgoingEmbedThumbnail] = None, author: Option[OutgoingEmbedAuthor] = None, fields: Seq[EmbedField] = Seq.empty) extends Product with Serializable
An outgoing embed.
An outgoing embed.
title
The title of the embed.
description
The embed description or main text.
url
The url of the embed.
timestamp
The timestamp of the embed.
color
The color of the embed
footer
The footer part of the embed.
image
The image part of the embed.
thumbnail
The thumbnail part of the embed.
author
The author part of the embed.
fields
The fields of the embed.
case class OutgoingEmbedAuthor(name: String, url: Option[String] = None, iconUrl: Option[String] = None) extends Product with Serializable
The author part of an outgoing embed
The author part of an outgoing embed
name
The name of the author
url
The url to link when clicking on the author
iconUrl
The icon to show besides the author.
case class OutgoingEmbedFooter(text: String, iconUrl: Option[String] = None) extends Product with Serializable
The footer part of an outgoing embed.
The footer part of an outgoing embed.
text
The text of the footer
iconUrl
The icon url of the footer.
case class OutgoingEmbedImage(url: String) extends Product with Serializable
The image part of an outgoing embed.
The image part of an outgoing embed.
url
The url to the image.
case class OutgoingEmbedThumbnail(url: String) extends Product with Serializable
The thumbnail part of an outgoing embed.
The thumbnail part of an outgoing embed.
url
The url to the thumbnail.
case class OutgoingEmbedVideo(url: String) extends Product with Serializable
The video part of an outgoing embed.
The video part of an outgoing embed.
url
The url to the video.
case class PartialApplication(id: ApplicationId, name: String, icon: Option[String], description: Option[String], rpcOrigins: Option[Seq[String]], botPublic: Option[Boolean], botRequireCodeGrant: Option[Boolean], termsOfServiceUrl: Option[String], privacyPolicyUrl: Option[String], owner: Option[PartialUser], summary: Option[String], verifyKey: Option[String], team: Option[Team], guildId: Option[GuildId], primarySkuId: Option[RawSnowflake], slug: Option[String], coverImage: Option[String], flags: Option[ApplicationFlags]) extends Product with Serializable
case class PartialAttachment(id: SnowflakeType[Attachment], filename: Option[String], description: Option[String], contentType: Option[String], size: Option[Int], url: Option[String], proxyUrl: Option[String], height: Option[Int], width: Option[Int], ephemeral: Option[Boolean]) extends Product with Serializable
An partial attachment for an outgoing message
An partial attachment for an outgoing message
id
The id of the attachment
filename
The filename of the attachment
description
Description of the attachment
contentType
The attachment's media type
size
The file size in bytes
url
The url of the attachment
proxyUrl
The proxyUrl of the attachment
height
The height of the attachment if it's an image
width
The width of the attachment if it's an image
case class PartialEmoji(id: Option[EmojiId] = None, name: Option[String] = None, animated: Option[Boolean] = None) extends Product with Serializable
A partial emoji found in reactions
A partial emoji found in reactions
id
The id of the emoji. If it's absent, it's not a guild emoji.
name
The name of the emoji.
case class PartialIntegration(id: IntegrationId, name: String, type: String, account: IntegrationAccount) extends Product with Serializable
type Permission = data.Permission.Permission
A permission to do some action.
A permission to do some action. In AckCord this is represented as a value class around int.
case class PermissionOverwrite(id: UserOrRoleId, type: PermissionOverwriteType, allow: Permission, deny: Permission) extends Product with Serializable
Represents a permission overwrite in a channel for a user or a guild.
Represents a permission overwrite in a channel for a user or a guild.
id
The id that this overwrite applies to. Can be both a user or a role. Check `type` to see what is valid for this overwrite.
allow
The permissions granted by this overwrite.
deny
The permissions denied by this overwrite.
sealed abstract class PermissionOverwriteType extends IntEnumEntry
Permission overwrites can apply to both users and role.
Permission overwrites can apply to both users and role. This tells you what's being overwritten for a specific overwrite.
implicit final class PermissionSyntax extends AnyVal
sealed abstract class PremiumTier extends IntEnumEntry
sealed abstract class PremiumType extends IntEnumEntry
case class Presence(userId: UserId, status: PresenceStatus, activities: Seq[Activity], clientStatus: ClientStatus) extends GetUser with Product with Serializable
The presence for a user
The presence for a user
userId
The user id
status
The status of the user
clientStatus
The status of the user over several platforms
case class PresenceCustom(name: String, createdAt: Instant, state: Option[String], emoji: Option[ActivityEmoji]) extends Activity with Product with Serializable
case class PresenceGame(name: String, createdAt: Instant, timestamps: Option[ActivityTimestamps], applicationId: Option[ApplicationId], details: Option[String], state: Option[String], party: Option[ActivityParty], assets: Option[ActivityAsset], secrets: Option[ActivitySecrets], instance: Option[Boolean], flags: Option[ActivityFlags], buttons: Option[Seq[String]]) extends Activity with Product with Serializable
The presence of someone playing a game
The presence of someone playing a game
applicationId
Application id of the game.
state
The user's party status.
party
Info about the user's party.
case class PresenceOther(tpe: ActivityType, name: String, createdAt: Instant, timestamps: Option[ActivityTimestamps], applicationId: Option[ApplicationId], details: Option[String], assets: Option[ActivityAsset], secrets: Option[ActivitySecrets], instance: Option[Boolean], flags: Option[ActivityFlags], buttons: Option[Seq[String]]) extends Activity with Product with Serializable
The presence of someone listening to music
sealed abstract class PresenceStatus extends StringEnumEntry
The different statuses a user can have
case class PresenceStreaming(name: String, uri: Option[String], createdAt: Instant, timestamps: Option[ActivityTimestamps], applicationId: Option[ApplicationId], details: Option[String], state: Option[String], party: Option[ActivityParty], assets: Option[ActivityAsset]) extends Activity with Product with Serializable
The presence of someone streaming
The presence of someone streaming
uri
The uri of the stream
applicationId
Application id of the game.
state
The user's party status.
party
Info about the user's party.
case class RawButton(label: Option[String] = None, customId: Option[String] = None, style: ButtonStyle = ButtonStyle.Secondary, emoji: Option[PartialEmoji] = None, url: Option[String] = None, disabled: Option[Boolean] = None) extends Button with Product with Serializable
case class RawInteraction(id: InteractionId, applicationId: RawSnowflake, tpe: InteractionType, data: Option[ApplicationInteractionData], guildId: Option[GuildId], channelId: Option[TextChannelId], member: Option[RawGuildMember], memberPermission: Option[Permission], user: Option[User], token: String, version: Int, message: Option[RawMessage]) extends Product with Serializable
case class RawInteractionResponse(type: InteractionResponseType, data: Option[InteractionCallbackData]) extends Product with Serializable
type RawSnowflake = data.SnowflakeType.SnowflakeType[Any]
case class Reaction(count: Int, me: Boolean, emoji: PartialEmoji) extends Product with Serializable
A reaction to a message
A reaction to a message
count
The amount of people that have reacted with this emoji.
me
If the client has reacted with this emoji.
emoji
The emoji of the reaction.
case class ReceivedEmbed(title: Option[String], type: Option[EmbedType], description: Option[String], url: Option[String], timestamp: Option[OffsetDateTime], color: Option[Int], footer: Option[ReceivedEmbedFooter], image: Option[ReceivedEmbedImage], thumbnail: Option[ReceivedEmbedThumbnail], video: Option[ReceivedEmbedVideo], provider: Option[ReceivedEmbedProvider], author: Option[ReceivedEmbedAuthor], fields: Option[Seq[EmbedField]]) extends Product with Serializable
A received embed.
A received embed.
title
The title of the embed.
description
The embed description or main text.
url
The url of the embed.
timestamp
The timestamp of the embed.
color
The color of the embed
footer
The footer part of the embed.
image
The image part of the embed.
thumbnail
The thumbnail part of the embed.
video
The video part of the embed.
provider
The provider part of the embed.
author
The author part of the embed.
fields
The fields of the embed.
case class ReceivedEmbedAuthor(name: String, url: Option[String], iconUrl: Option[String], proxyIconUrl: Option[String]) extends Product with Serializable
The author part of a received embed.
The author part of a received embed.
name
The author name
url
An url for the author text.
iconUrl
An icon url for the author.
proxyIconUrl
A proxy url for the icon.
case class ReceivedEmbedFooter(text: String, iconUrl: Option[String], proxyIconUrl: Option[String]) extends Product with Serializable
The footer part of a received embed.
The footer part of a received embed.
text
The footer text.
iconUrl
An icon url for the footer.
proxyIconUrl
A proxy url for the footer.
case class ReceivedEmbedImage(url: String, proxyUrl: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable
The image part of a received embed.
The image part of a received embed.
url
The url of the image.
proxyUrl
The proxy url of the image.
height
The height of the image.
width
The width of the image.
case class ReceivedEmbedProvider(name: Option[String], url: Option[String]) extends Product with Serializable
The provider part of a received embed.
The provider part of a received embed.
name
The name of the provider.
url
The url of a provider.
case class ReceivedEmbedThumbnail(url: String, proxyUrl: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable
The thumbnail part of a received embed.
The thumbnail part of a received embed.
url
The url to the thumbnail.
proxyUrl
The proxy url of the thumbnail.
height
The height of the thumbnail.
width
The width of the thumbnail.
case class ReceivedEmbedVideo(url: Option[String], proxyUrl: Option[String], height: Option[Int], width: Option[Int]) extends Product with Serializable
The video part of a received embed.
The video part of a received embed.
url
The url of the video.
proxyUrl
The proxy url of the video.
height
The height of the video.
width
The width of the video.
case class RequestsGuild(id: GuildId, name: String, icon: Option[String], iconHash: Option[String], splash: Option[String], discoverySplash: Option[String], isOwner: Option[Boolean], ownerId: UserId, permissions: Option[Permission], afkChannelId: Option[NormalVoiceGuildChannelId], afkTimeout: Int, widgetEnabled: Option[Boolean], widgetChannelId: Option[GuildChannelId], verificationLevel: VerificationLevel, defaultMessageNotifications: NotificationLevel, explicitContentFilter: FilterLevel, roles: SnowflakeMap[Role, Role], emojis: SnowflakeMap[Emoji, Emoji], features: Seq[GuildFeature], mfaLevel: MFALevel, applicationId: Option[ApplicationId], systemChannelId: Option[TextGuildChannelId], systemChannelFlags: SystemChannelFlags, rulesChannelId: Option[TextGuildChannelId], maxPresences: Option[Int], maxMembers: Option[Int], vanityUrlCode: Option[String], description: Option[String], banner: Option[String], premiumTier: PremiumTier, premiumSubscriptionCount: Option[Int], preferredLocale: Option[String], publicUpdatesChannelId: Option[TextGuildChannelId], maxVideoChannelUsers: Option[Int], approximateMemberCount: Option[Int], approximatePresenceCount: Option[Int], nsfwLevel: NSFWLevel, stickers: SnowflakeMap[Sticker, Sticker], premiumProgressBarEnabled: Boolean) extends Guild with Product with Serializable
A guild or server in Discord.
A guild or server in Discord. This object is usually gotten from a request.
isOwner
If the current user is the owner of the guild.
permissions
The permissions of the current user without overwrites.
approximateMemberCount
Roughly how many members there is in the guild. Present when gotten from the ackcord.requests.GetGuild endpoint with withCounts = true
approximatePresenceCount
Roughly how many presences there is in the guild. Present when gotten from the ackcord.requests.GetGuild endpoint with withCounts = true
case class Role(id: RoleId, guildId: GuildId, name: String, icon: Option[String], unicodeEmoji: Option[String], color: Int, hoist: Boolean, position: Int, permissions: Permission, managed: Boolean, mentionable: Boolean, tags: Option[RoleTags]) extends GetGuild with UserOrRole with Product with Serializable
A role in a guild.
A role in a guild.
id
The id of this role.
guildId
The guildId this role belongs to.
name
The name of this role.
icon
Optional icon of this role.
unicodeEmoji
Optional emoji of this role.
color
The color of this role.
hoist
If this role is listed in the sidebar.
position
The position of this role.
permissions
The permissions this role grant.
managed
If this is a bot role.
mentionable
If you can mention this role.
type RoleId = data.SnowflakeType.SnowflakeType[Role]
implicit final class RoleIdSyntax extends AnyVal
case class RoleTags(botId: Option[UserId], integrationId: Option[IntegrationId], premiumSubscriber: Boolean) extends Product with Serializable
botId
If this role is for a bot, the bot the role belongs to.
integrationId
If this role is for an integration, the integration the role belongs to.
premiumSubscriber
If this role is the premium subscriber role.
case class SelectMenu(options: Seq[SelectOption], placeholder: Option[String] = None, customId: String = UUID.randomUUID().toString, minValues: Int = 1, maxValues: Int = 1, disabled: Boolean = false) extends ActionRowContent with Product with Serializable
case class SelectOption(label: String, value: String, description: Option[String] = None, emoji: Option[PartialEmoji] = None, default: Boolean = false) extends Product with Serializable
type SnowflakeType[+A] = data.SnowflakeType.SnowflakeType[A]
implicit final class SnowflakeTypeSyntax[A] extends AnyVal with Ordered[SnowflakeType[A]]
case class SparseMessage(id: MessageId, channelId: TextChannelId, authorId: RawSnowflake, isAuthorUser: Boolean, authorUsername: String, content: String, timestamp: OffsetDateTime, editedTimestamp: Option[OffsetDateTime], tts: Boolean, mentionEveryone: Boolean, mentions: Seq[UserId], mentionChannels: Seq[ChannelMention], attachments: Seq[Attachment], embeds: Seq[ReceivedEmbed], reactions: Seq[Reaction], nonce: Option[String], pinned: Boolean, messageType: MessageType, activity: Option[MessageActivity], application: Option[PartialApplication], applicationId: Option[ApplicationId], messageReference: Option[MessageReference], flags: Option[MessageFlags], stickers: Option[Seq[Sticker]], stickerItems: Option[Seq[StickerItem]], referencedMessage: Option[Message], interaction: Option[MessageInteraction], components: Seq[ActionRow], threadId: Option[ThreadGuildChannelId]) extends Message with Product with Serializable
A message missing the guild info.
A message missing the guild info. This can be because it was sent to a DM channel, or because it was retrieved later through a REST call. Note that a message can still be sent to a guild, but be missing the guild info. For example if it's gotten from a REST request.
case class StageGuildChannel(id: SnowflakeType[StageGuildChannel], guildId: GuildId, name: String, position: Int, permissionOverwrites: SnowflakeMap[UserOrRole, PermissionOverwrite], bitrate: Int, nsfw: Boolean, parentId: Option[SnowflakeType[GuildCategory]], rtcRegion: Option[String]) extends VoiceGuildChannel with Product with Serializable
A stage voice channel in a guild
type StageGuildChannelId = data.SnowflakeType.SnowflakeType[StageGuildChannel]
implicit final class StageGuildChannelIdSyntax extends AnyVal
case class StageInstance(id: SnowflakeType[StageInstance], guildId: GuildId, channelId: StageGuildChannelId, topic: String, privacyLevel: StageInstancePrivacyLevel, discoverableDisabled: Boolean) extends Product with Serializable
Holds info about a live stage.
Holds info about a live stage.
id
Id of the stage.
guildId
Id of the belonging guild.
channelId
Id of the stage channel tied to this stage.
topic
Topic of the stage instance.
privacyLevel
Who the stage instance is visible to.
discoverableDisabled
If stage discovery is disabled or not.
sealed abstract class StageInstancePrivacyLevel extends IntEnumEntry
case class Sticker(id: StickerId, packId: Option[SnowflakeType[StickerPack]], name: String, description: Option[String], tags: Option[String], tpe: StickerType, formatType: FormatType, available: Option[Boolean], guildId: Option[GuildId], userId: Option[UserId], sortValue: Option[Int]) extends Product with Serializable
The structure of a sticker sent in a message.
The structure of a sticker sent in a message.
id
Id of the sticker.
packId
Id of the pack the sticker is from.
name
Name of the sticker.
description
Description of the sticker.
tags
A comma-separated list of tags for the sticker.
formatType
Type of sticker format.
available
If this guild sticker can currently be used.
guildId
Id of the guild that owns this sticker.
userId
The id of the user that uploaded the sticker.
sortValue
A standard sticker's sort value in it's pack.
type StickerId = data.SnowflakeType.SnowflakeType[Sticker]
case class StickerItem(id: StickerId, name: String, formatType: FormatType) extends Product with Serializable
The structure of a sticker item (the smallest amount of data required to render a sticker)
The structure of a sticker item (the smallest amount of data required to render a sticker)
id
Id of the sticker.
name
Name of the sticker.
formatType
Type of sticker format.
case class StickerPack(id: SnowflakeType[StickerPack], stickers: Seq[RawSticker], name: String, skuId: RawSnowflake, coverStickerId: Option[RawSnowflake], description: String, bannerAssetId: RawSnowflake) extends Product with Serializable
A pack of standard stickers
A pack of standard stickers
id
The id of the sticker pack.
stickers
The stickers in the pack.
name
The name of the pack.
skuId
The id of the pack's SKU.
coverStickerId
The id of a sticker in the pack which is shown as the pack's icon.
description
A description of the pack.
bannerAssetId
Id of the pack's banner image.
sealed abstract class StickerType extends IntEnumEntry
type SystemChannelFlags = data.SystemChannelFlags.SystemChannelFlags
implicit final class SystemChannelFlagsSyntax extends AnyVal
case class Team(icon: Option[String], id: SnowflakeType[Team], members: Seq[TeamMember], name: String, ownerUserId: UserId) extends Product with Serializable
A discord team.
A discord team.
icon
Icon identifier for the team.
id
Id of the team.
members
Members of the team.
ownerUserId
The id of the current owner of the team
case class TeamMember(membershipState: TeamMembershipState, permissions: Seq[String], teamId: SnowflakeType[Team], user: PartialUser) extends Product with Serializable
A member of a team.
A member of a team.
membershipState
The membership state of the member
permissions
The permissions of team member
teamId
The id of the team this member belongs to
user
A partial user containing the avatar, discriminator, id and username of the user
sealed abstract class TeamMembershipState extends IntEnumEntry
case class TextButton(label: Option[String] = None, identifier: String = UUID.randomUUID().toString, style: TextButtonStyle = ButtonStyle.Secondary, emoji: Option[PartialEmoji] = None, disabled: Option[Boolean] = None) extends Button with Product with Serializable
sealed trait TextButtonStyle extends ButtonStyle
sealed trait TextChannel extends Channel
A text channel that has text messages
type TextChannelId = data.SnowflakeType.SnowflakeType[TextChannel]
implicit final class TextChannelIdSyntax extends AnyVal
sealed trait TextGuildChannel extends GuildChannel with TextChannel
A texual channel in a guild
type TextGuildChannelId = data.SnowflakeType.SnowflakeType[TextGuildChannel]
implicit final class TextGuildChannelIdSyntax extends AnyVal
case class ThreadGuildChannel(id: SnowflakeType[ThreadGuildChannel], guildId: GuildId, name: String, lastMessageId: Option[MessageId], ownerId: UserId, rateLimitPerUser: Option[Int], parentChannelId: TextGuildChannelId, channelType: ThreadChannelType, messageCount: Int, memberCount: Int, archived: Boolean, archiveTimestamp: OffsetDateTime, autoArchiveDuration: Int, locked: Boolean, invitable: Option[Boolean], member: Option[ThreadMember]) extends TextGuildChannel with Product with Serializable
type ThreadGuildChannelId = data.SnowflakeType.SnowflakeType[ThreadGuildChannel]
implicit final class ThreadGuildChannelIdSyntax extends AnyVal
case class ThreadMember(id: ThreadGuildChannelId, userId: UserId, joinTimestamp: OffsetDateTime, flags: Int) extends Product with Serializable
sealed abstract class TimestampStyle extends AnyRef
case class UnavailableGuild(id: GuildId, unavailable: Option[Boolean]) extends UnknownStatusGuild with Product with Serializable
A guild which is not available.
A guild which is not available.
id
The id of the guild.
unavailable
If the guild is unavailable because of an outage.
sealed trait UnknownStatusGuild extends AnyRef
A guild which that status of is unknown.
case class UnsupportedChannel(id: ChannelId, channelType: ChannelType) extends Channel with Product with Serializable
A channel that is of a type that AckCord knows about, but doesn't implement.
A channel that is of a type that AckCord knows about, but doesn't implement. Normally because it's not yet part of the public API.
case class User(id: UserId, username: String, discriminator: String, avatar: Option[String], bot: Option[Boolean], system: Option[Boolean], mfaEnabled: Option[Boolean], banner: Option[String], accentColor: Option[Int], locale: Option[String], verified: Option[Boolean], email: Option[String], flags: Option[UserFlags], premiumType: Option[PremiumType], publicFlags: Option[UserFlags]) extends Author[User] with UserOrRole with Product with Serializable
A Discord user.
A Discord user.
id
The id of the user.
username
The name of the user.
discriminator
The discriminator for the user. Those four last digits when clicking in a users name.
avatar
The users avatar hash.
bot
If this user belongs to a OAuth2 application.
system
If the user is part of Discord's urgent messaging system.
mfaEnabled
If this user has two factor authentication enabled.
banner
The user's banner image hash.
accentColor
The user's banner color as an RGB int.
locale
The user's chosen language.
verified
If this user email is verified. Requires the email OAuth scope.
email
The users email. Requires the email OAuth scope.
flags
The flags on a user's account.
premiumType
The type of nitro the account has.
publicFlags
The public flags on a user's account.
type UserFlags = data.UserFlags.UserFlags
implicit final class UserFlagsSyntax extends AnyVal
type UserId = data.SnowflakeType.SnowflakeType[User]
implicit final class UserIdSyntax extends AnyVal
trait UserOrRole extends AnyRef
type UserOrRoleId = data.SnowflakeType.SnowflakeType[UserOrRole]
sealed abstract class VerificationLevel extends IntEnumEntry
The different verification levels that can be used for a guild.
sealed abstract class VideoQualityMode extends IntEnumEntry
sealed trait VoiceGuildChannel extends GuildChannel
type VoiceGuildChannelId = data.SnowflakeType.SnowflakeType[VoiceGuildChannel]
implicit final class VoiceGuildChannelIdSyntax extends AnyVal
case class VoiceRegion(id: String, name: String, sampleHostname: String, samplePort: Int, optimal: Boolean, deprecated: Boolean, custom: Boolean) extends Product with Serializable
A voice region
A voice region
id
The id of the region
name
The name of the voice region
sampleHostname
An example host name
samplePort
An example host port
optimal
If this is the server closest to the client
deprecated
If this is a deprecated region
custom
If this is a custom region
case class VoiceState(guildId: Option[GuildId], channelId: Option[VoiceGuildChannelId], userId: UserId, member: Option[RawGuildMember], sessionId: String, deaf: Boolean, mute: Boolean, selfDeaf: Boolean, selfMute: Boolean, selfStream: Option[Boolean], selfVideo: Boolean, suppress: Boolean, requestToSpeakTimestamp: Option[OffsetDateTime]) extends GetGuildOpt with GetVoiceChannelOpt with GetUser with Product with Serializable
Represents a user voice connection status
Represents a user voice connection status
guildId
The guild this state belongs to
channelId
The channel the user is in, or None if the user isn't in a channel.
userId
The user of this state.
member
The guild member of this voice state. Can be missing.
sessionId
The sessionId
deaf
If the user is deafened by the guild
mute
If the user is muted by the guild
selfDeaf
If the user is deafened locally
selfMute
If the user is muted locally
selfStream
If the user is streaming
selfVideo
If the user's camera is on
suppress
If the client has muted the user
case class Webhook(id: SnowflakeType[Webhook], type: WebhookType, guildId: Option[GuildId], channelId: TextGuildChannelId, user: Option[User], name: Option[String], avatar: Option[String], token: Option[String], applicationId: Option[ApplicationId], sourceGuild: Option[WebhookSourceGuild], sourceChannel: Option[WebhookSourceChannel], url: Option[String]) extends GetGuildOpt with Product with Serializable
A webhook
A webhook
id
The webhook id
guildId
The guild it belongs to
channelId
The channel it belongs to
user
The user that created the webhook. Not present when getting a webhook with a token.
name
The name of the webhook
avatar
The default avatar hash of the webhook.
token
The token of the webhook.
applicationId
The bot or OAuth2 application that created the webhook
sourceGuild
The guild of the channel this webhook is following (For channel follower webhooks)
sourceChannel
The channel this webhook is following (For channel follower webhooks)
url
Url used for executing the webhook (Returned by the webhooks OAuth2 flow)
case class WebhookAuthor(id: SnowflakeType[Webhook], username: String, discriminator: String, avatar: Option[String]) extends Author[Webhook] with Product with Serializable
An webhook author
An webhook author
id
The webhook id
username
The name of the webhook
avatar
The webhook's avatar hash
case class WebhookSourceChannel(id: GuildId, name: String) extends Product with Serializable
case class WebhookSourceGuild(id: GuildId, name: String, icon: Option[String]) extends Product with Serializable
sealed abstract class WebhookType extends IntEnumEntry
case class WelcomeScreen(description: Option[String], welcomeChannels: Seq[WelcomeScreenChannel]) extends Product with Serializable
description
A description of the server
welcomeChannels
Channels shown on the welcome screen
case class WelcomeScreenChannel(channelId: GuildChannelId, description: String, emojiId: Option[EmojiId], emojiName: Option[String]) extends Product with Serializable
channelId
The id the channel is referencing.
description
The description for the channel
emojiId
The emoji id if it is a custom one
emojiName
The emoji name if it is not a custom one
sealed abstract class WidgetImageStyle extends StringEnumEntry
A style the widget image might be shown as.
A style the widget image might be shown as. See examples here. https://discord.com/developers/docs/resources/guild#get-guild-widget-image

Value Members

object ActionRow extends Serializable
object ActivityFlags
object ActivityType extends IntEnum[ActivityType] with IntCirceEnumWithUnknown[ActivityType]
object AllowedMention extends Serializable
object AllowedMentionTypes extends StringEnum[AllowedMentionTypes] with StringCirceEnumWithUnknown[AllowedMentionTypes]
object ApplicationCommandInteractionDataResolved extends Serializable
object ApplicationCommandOptionType extends IntEnum[ApplicationCommandOptionType] with IntCirceEnumWithUnknown[ApplicationCommandOptionType]
object ApplicationCommandPermissionType extends IntEnum[ApplicationCommandPermissionType] with IntCirceEnumWithUnknown[ApplicationCommandPermissionType]
object ApplicationCommandType extends IntCirceEnumWithUnknown[ApplicationCommandType]
object ApplicationFlags
object ApplicationId extends SnowflakeCompanion[Application]
object AuditLogChange
object AuditLogEvent extends IntEnum[AuditLogEvent] with IntCirceEnumWithUnknown[AuditLogEvent]
object Button
object ButtonStyle extends IntEnum[ButtonStyle] with IntCirceEnumWithUnknown[ButtonStyle]
object ChannelId extends SnowflakeCompanion[Channel]
object ChannelType extends IntEnum[ChannelType] with IntCirceEnumWithUnknown[ChannelType]
object CommandId extends SnowflakeCompanion[ApplicationCommand]
object ComponentType extends IntEnum[ComponentType] with IntCirceEnumWithUnknown[ComponentType]
object ConnectionVisibility extends IntEnum[ConnectionVisibility] with IntCirceEnumWithUnknown[ConnectionVisibility]
object DiscordProtocol extends DiscordProtocol
object EmbedType extends StringEnum[EmbedType] with StringCirceEnumWithUnknown[EmbedType]
object EmojiId extends SnowflakeCompanion[EmojiId]
object FilterLevel extends IntEnum[FilterLevel] with IntCirceEnumWithUnknown[FilterLevel]
object FormatType extends IntEnum[FormatType] with IntCirceEnumWithUnknown[FormatType]
object GuildChannelId extends SnowflakeCompanion[GuildChannel]
object GuildFeature extends StringEnum[GuildFeature] with StringCirceEnumWithUnknown[GuildFeature]
object GuildId extends SnowflakeCompanion[Guild]
object GuildScheduledEventEntityType extends IntCirceEnumWithUnknown[GuildScheduledEventEntityType]
object GuildScheduledEventPrivacyLevel extends IntCirceEnumWithUnknown[GuildScheduledEventPrivacyLevel]
object GuildScheduledEventStatus extends IntCirceEnumWithUnknown[GuildScheduledEventStatus]
object ImageData
object ImageFormat
object IntegrationExpireBehavior extends IntEnum[IntegrationExpireBehavior] with IntCirceEnumWithUnknown[IntegrationExpireBehavior]
object IntegrationId extends SnowflakeCompanion[Integration]
object IntegrationType extends StringEnum[IntegrationType] with StringCirceEnumWithUnknown[IntegrationType]
object InteractionId extends SnowflakeCompanion[RawInteraction]
object InteractionResponseType extends IntCirceEnumWithUnknown[InteractionResponseType]
object InteractionType extends IntCirceEnumWithUnknown[InteractionType]
object InviteTargetType extends IntEnum[InviteTargetType] with IntCirceEnumWithUnknown[InviteTargetType]
object MFALevel extends IntEnum[MFALevel] with IntCirceEnumWithUnknown[MFALevel]
object MessageActivityType extends IntEnum[MessageActivityType] with IntCirceEnumWithUnknown[MessageActivityType]
object MessageFlags
object MessageId extends SnowflakeCompanion[Message]
object MessageType extends IntEnum[MessageType] with IntCirceEnumWithUnknown[MessageType]
object NSFWLevel extends IntEnum[NSFWLevel] with IntCirceEnumWithUnknown[NSFWLevel]
object NormalVoiceGuildChannelId extends SnowflakeCompanion[NormalVoiceGuildChannel]
object NotificationLevel extends IntEnum[NotificationLevel] with IntCirceEnumWithUnknown[NotificationLevel]
object Permission
object PermissionOverwriteType extends IntEnum[PermissionOverwriteType] with IntCirceEnumWithUnknown[PermissionOverwriteType]
object PremiumTier extends IntEnum[PremiumTier] with IntCirceEnumWithUnknown[PremiumTier]
object PremiumType extends IntEnum[PremiumType] with IntCirceEnumWithUnknown[PremiumType]
object PresenceStatus extends StringEnum[PresenceStatus] with StringCirceEnumWithUnknown[PresenceStatus]
object RawSnowflake extends SnowflakeCompanion[Any]
object RoleId extends SnowflakeCompanion[Role]
object SelectOption extends Serializable
object SnowflakeType
object StageGuildChannelId extends SnowflakeCompanion[StageGuildChannel]
object StageInstancePrivacyLevel extends IntEnum[StageInstancePrivacyLevel] with IntCirceEnumWithUnknown[StageInstancePrivacyLevel]
object StickerId extends SnowflakeCompanion[Sticker]
object StickerType extends IntEnum[StickerType] with IntCirceEnumWithUnknown[StickerType]
object SystemChannelFlags
object TeamMembershipState extends IntEnum[TeamMembershipState] with IntCirceEnumWithUnknown[TeamMembershipState]
object TextChannelId extends SnowflakeCompanion[TextChannel]
object TextGuildChannelId extends SnowflakeCompanion[TextGuildChannel]
object ThreadGuildChannelId extends SnowflakeCompanion[ThreadGuildChannel]
object TimestampStyle
object UserFlags
object UserId extends SnowflakeCompanion[User]
object UserOrRoleId extends SnowflakeCompanion[UserOrRole]
object VerificationLevel extends IntEnum[VerificationLevel] with IntCirceEnumWithUnknown[VerificationLevel]
object VideoQualityMode extends IntEnum[VideoQualityMode] with IntCirceEnumWithUnknown[VideoQualityMode]
object VoiceGuildChannelId extends SnowflakeCompanion[VoiceGuildChannel]
object WebhookType extends IntEnum[WebhookType] with IntCirceEnumWithUnknown[WebhookType]
object WidgetImageStyle extends StringEnum[WidgetImageStyle]

Packages

data

package data

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

data

package data

Package Members

Type Members

Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

data