kord-core/dev.kord.core.entity/Integration

Integration

class Integration(val data: IntegrationData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : KordEntity, Strategizable(source)

A Discord integration.

Constructors

Link copied to clipboard
constructor(data: IntegrationData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

Link copied to clipboard
Link copied to clipboard
val enablesEmoticons: Boolean

Whether this integration requires emoticons to be synced, only supports Twitch right now.

Link copied to clipboard
val expireBehavior: IntegrationExpireBehavior?

The behavior used to expire subscribers.

Link copied to clipboard
val expireGracePeriod: Duration?

The grace period before expiring subscribers.

Link copied to clipboard
val guild: GuildBehavior

The behavior of the guild this integration is tied to.

Link copied to clipboard
val guildId: Snowflake

The id of the guild this integration is tied to.

Link copied to clipboard
open override val id: Snowflake

The unique identifier of this entity.

Link copied to clipboard
val isEnabled: Boolean

Whether this integration is currently active.

Link copied to clipboard
val isSyncing: Boolean?

Whether this integrations is syncing.

Link copied to clipboard
open override val kord: Kord

The kord instance that created this object.

Link copied to clipboard
val name: String

The name of this integration.

Link copied to clipboard
val role: RoleBehavior

The behavior of the role used for 'subscribers' of the integration.

Link copied to clipboard
val roleId: Snowflake

The id of the role used for 'subscribers' of the integration.

Link copied to clipboard
open override val supplier: EntitySupplier

The supplier used to request entities.

Link copied to clipboard
val syncedAt: Instant?

When this integration was last synced.

Link copied to clipboard
val type: String

The type of integration. ("twitch", "youtube", "discord" or "guild_subscription")

Link copied to clipboard
val user: UserBehavior

The behavior of the user for this integration.

Link copied to clipboard
val userId: Snowflake

The id of the user for this integration.

Functions

Link copied to clipboard
open operator override fun compareTo(other: Entity): Int

Compares entities on id.

Link copied to clipboard
suspend fun delete(reason: String? = null)

Requests to delete the integration.

Link copied to clipboard
inline suspend fun Integration.edit(builder: IntegrationModifyBuilder.() -> Unit)

Requests to edit this integration.

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
suspend fun getGuild(): Guild

Requests to get the guild this integration is tied to.

Link copied to clipboard
suspend fun getGuildOrNull(): Guild?

Requests to get the guild this integration is tied to, returns null if the guild isn't present.

Link copied to clipboard
suspend fun getRole(): Role

Requests to get the role used for 'subscribers' of the integration.

Link copied to clipboard
suspend fun getRoleOrNull(): Role?

Requests to get the role used for 'subscribers' of the integration, returns null if the role isn't present.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
suspend fun sync()

Request to sync an integration.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun withStrategy(strategy: EntitySupplyStrategy<*>): Integration

Returns a copy of this class with a new supplier provided by the strategy.