Class Integration

Represents a guild integration.

Hierarchy

Constructors

constructor

Properties

_cachedGuild? _cachedRole? account application client enableEmoticons enabled expireBehavior? expireGracePeriod? guildID id name revoked roleID scopes? subscriberCount? syncedAt? syncing type user?

Accessors

createdAt guild role

Methods

toJSON toString update generateID getCreatedAt getDiscordEpoch

Constructors

constructor

Properties

Private Optional _cachedGuild

_cachedGuild?: any

Private Optional _cachedRole

_cachedRole?: any

account

account: IntegrationAccount

The account information associated with this integration.

application

application: null | PartialApplication

The application associated with this integration.

client

client: Client<ClientEvents>

enableEmoticons

enableEmoticons: boolean

If emoticons should be synced for this integration.

enabled

enabled: boolean

If this integration is enabled.

Optional expireBehavior

expireBehavior?: IntegrationExpireBehaviors

The behavior of expiring subscribers.

Optional expireGracePeriod

expireGracePeriod?: number

The grace period (in days) before expiring subscribers.

guildID

guildID: null | string

The ID of the guild this integration belongs to, if applicable.

id

id: string

name

name: string

The name of the integration.

revoked

revoked: boolean

If this integration has been revoked.

roleID

roleID: null | string

The id of the role this integration uses for subscribers, if any.

Optional scopes

scopes?: string[]

The scopes the application associated with this integration has been authorized for.

Optional subscriberCount

subscriberCount?: number

The number of subscribers this integration has.

Optional syncedAt

syncedAt?: Date

The last date at which this integration was synced at.

syncing

syncing: boolean

If this integration is syncing.

type

type: "twitch" | "youtube" | "discord" | "guild_subscription"

The type of integration.

Optional user

user?: User

The user associated with this integration, if applicable.

Accessors

createdAt

  • get createdAt(): Date

  • Returns Date

guild

  • get guild(): null | Guild

  • The guild this integration belongs to, if applicable. This will throw an error if the guild is not cached.

    Returns null | Guild

role

  • get role(): undefined | null | Role

  • The role this integration uses for subscribers, if any.

    Returns undefined | null | Role

Methods

toJSON

toString

  • Returns string

Protected update

  • Parameters

    Returns void

Static generateID

  • Parameters

    • Optional timestamp: number | Date

    Returns string

Static getCreatedAt

  • Parameters

    • id: string

    Returns Date

Static getDiscordEpoch

  • Parameters

    • id: string

    Returns number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc