mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-10 16:43:31 +01:00
feat(Integration): add missing props and fix docs/types (#6623)
Co-authored-by: Noel <buechler.noel@outlook.com>
This commit is contained in:
@@ -559,7 +559,7 @@ class Guild extends AnonymousGuild {
|
||||
/**
|
||||
* Fetches a collection of integrations to this guild.
|
||||
* Resolves with a collection mapping integrations by their ids.
|
||||
* @returns {Promise<Collection<string, Integration>>}
|
||||
* @returns {Promise<Collection<Snowflake|string, Integration>>}
|
||||
* @example
|
||||
* // Fetch integrations
|
||||
* guild.fetchIntegrations()
|
||||
|
||||
@@ -174,7 +174,7 @@ class GuildAuditLogs {
|
||||
|
||||
/**
|
||||
* Cached integrations
|
||||
* @type {Collection<Snowflake, Integration>}
|
||||
* @type {Collection<Snowflake|string, Integration>}
|
||||
* @private
|
||||
*/
|
||||
this.integrations = new Collection();
|
||||
|
||||
@@ -6,7 +6,7 @@ const IntegrationApplication = require('./IntegrationApplication');
|
||||
/**
|
||||
* The information account for an integration
|
||||
* @typedef {Object} IntegrationAccount
|
||||
* @property {string} id The id of the account
|
||||
* @property {Snowflake|string} id The id of the account
|
||||
* @property {string} name The name of the account
|
||||
*/
|
||||
|
||||
@@ -25,7 +25,7 @@ class Integration extends Base {
|
||||
|
||||
/**
|
||||
* The integration id
|
||||
* @type {Snowflake}
|
||||
* @type {Snowflake|string}
|
||||
*/
|
||||
this.id = data.id;
|
||||
|
||||
@@ -36,7 +36,7 @@ class Integration extends Base {
|
||||
this.name = data.name;
|
||||
|
||||
/**
|
||||
* The integration type (twitch, youtube, etc)
|
||||
* The integration type (twitch, youtube or discord)
|
||||
* @type {string}
|
||||
*/
|
||||
this.type = data.type;
|
||||
@@ -49,16 +49,26 @@ class Integration extends Base {
|
||||
|
||||
/**
|
||||
* Whether this integration is syncing
|
||||
* @type {boolean}
|
||||
* @type {?boolean}
|
||||
*/
|
||||
this.syncing = data.syncing;
|
||||
|
||||
/**
|
||||
* The role that this integration uses for subscribers
|
||||
* @type {Role}
|
||||
* @type {?Role}
|
||||
*/
|
||||
this.role = this.guild.roles.cache.get(data.role_id);
|
||||
|
||||
if ('enable_emoticons' in data) {
|
||||
/**
|
||||
* Whether emoticons should be synced for this integration (twitch only currently)
|
||||
* @type {?boolean}
|
||||
*/
|
||||
this.enableEmoticons = data.enable_emoticons;
|
||||
} else {
|
||||
this.enableEmoticons ??= null;
|
||||
}
|
||||
|
||||
if (data.user) {
|
||||
/**
|
||||
* The user for this integration
|
||||
@@ -77,9 +87,30 @@ class Integration extends Base {
|
||||
|
||||
/**
|
||||
* The last time this integration was last synced
|
||||
* @type {number}
|
||||
* @type {?number}
|
||||
*/
|
||||
this.syncedAt = data.synced_at;
|
||||
|
||||
if ('subscriber_count' in data) {
|
||||
/**
|
||||
* How many subscribers this integration has
|
||||
* @type {?number}
|
||||
*/
|
||||
this.subscriberCount = data.subscriber_count;
|
||||
} else {
|
||||
this.subscriberCount ??= null;
|
||||
}
|
||||
|
||||
if ('revoked' in data) {
|
||||
/**
|
||||
* Whether this integration has been revoked
|
||||
* @type {?boolean}
|
||||
*/
|
||||
this.revoked = data.revoked;
|
||||
} else {
|
||||
this.revoked ??= null;
|
||||
}
|
||||
|
||||
this._patch(data);
|
||||
}
|
||||
|
||||
@@ -96,13 +127,13 @@ class Integration extends Base {
|
||||
_patch(data) {
|
||||
/**
|
||||
* The behavior of expiring subscribers
|
||||
* @type {number}
|
||||
* @type {?number}
|
||||
*/
|
||||
this.expireBehavior = data.expire_behavior;
|
||||
|
||||
/**
|
||||
* The grace period before expiring subscribers
|
||||
* @type {number}
|
||||
* @type {?number}
|
||||
*/
|
||||
this.expireGracePeriod = data.expire_grace_period;
|
||||
|
||||
|
||||
@@ -87,7 +87,7 @@ class Role extends Base {
|
||||
* The tags this role has
|
||||
* @type {?Object}
|
||||
* @property {Snowflake} [botId] The id of the bot this role belongs to
|
||||
* @property {Snowflake} [integrationId] The id of the integration this role belongs to
|
||||
* @property {Snowflake|string} [integrationId] The id of the integration this role belongs to
|
||||
* @property {true} [premiumSubscriberRole] Whether this is the guild's premium subscription role
|
||||
*/
|
||||
this.tags = data.tags ? {} : null;
|
||||
|
||||
Reference in New Issue
Block a user