Class: Integration

Integration

Represents a guild integration.

Constructor

new Integration()

Source:

Members

account :IntegrationAccount

The account integration information
Type:
Source:

(nullable) application :IntegrationApplication

The application for this integration
Type:
Source:

enabled :boolean

Whether this integration is enabled
Type:
  • boolean
Source:

expireBehavior :number

The behavior of expiring subscribers
Type:
  • number
Source:

expireGracePeriod :number

The grace period before expiring subscribers
Type:
  • number
Source:

guild :Guild

The guild this integration belongs to
Type:
Source:

id :Snowflake

The integration id
Type:
Source:

name :string

The integration name
Type:
  • string
Source:

role :Role

The role that this integration uses for subscribers
Type:
Source:

syncedAt :number

The last time this integration was last synced
Type:
  • number
Source:

syncing :boolean

Whether this integration is syncing
Type:
  • boolean
Source:

type :string

The integration type (twitch, youtube, etc)
Type:
  • string
Source:

(nullable) user :User

The user for this integration
Type:
Source:

Methods

delete(reasonopt) → {Promise.<Integration>}

Deletes this integration.
Parameters:
Name Type Attributes Description
reason string <optional>
Reason for deleting this integration
Source:
Returns:
Type
Promise.<Integration>

edit(data, reason) → {Promise.<Integration>}

Edits this integration.
Parameters:
Name Type Description
data IntegrationEditData The data to edit this integration with
reason string Reason for editing this integration
Source:
Returns:
Type
Promise.<Integration>

sync() → {Promise.<Integration>}

Sync this integration
Source:
Returns:
Type
Promise.<Integration>