特定の時刻になったらボイスチャットから切断する

Question

#前提・実現したいこと
特定の時刻になったらそのサーバーのボイスチャットに接続しているメンバーを全員切断したい。

#発生している問題
特定の時刻になってもボイスチャットから切断されない。

#該当のソースコード
```js
client.on('ready', () => {

    var cron = require('node-cron');

    cron.schedule('00 17 * * *', () => {

        const guildID = 'ギルドID'

        const guild = client.guilds.fetch(guildID).catch(console.error);

        const vchannel = guild.channels.cache.filter(channel => channel.type === 'voice');

        const channel = guild.channels.cache.find(ch => ch.name === 'general');

        vchannel.members.forEach(member => {
            if (member) member.voice.kick().catch(console.error);
            console.log(member.id)

            setTimeout(() => {
                channel.send(`2時になったのでボイスチャットからキックしました(*'▽')`)
            }, 500)
        });
    });
});
```

#自分で調べたことや試したこと
ギルドIDを適当な数値を入れたらエラーが出たのでcronの指定時刻に動作することは確認できています。

#バージョン
discord.js: 12.5.2
node-cron: 3.0.0

Accepted Answer

## `require()`はできるだけファイル冒頭でする

細かいことですが、そのファイルがどんな外部モジュールに依存しているかをファイル冒頭にまとめておくと見やすいので、`require()`はできるだけファイルの冒頭に書きましょう。

`var`も`const`にしています。

```js
const cron = require('node-cron')

/* ... なんやかんやあって ... */

client.on('ready', () => {
    /* ... いろいろする ... */
})
```

## `client.guilds.fetch(guildID)`ではなく`client.guilds.cache.get(guildID)`

- [GuildManager.fetch() - discord.js Documentation](https://discord.js.org/#/docs/main/stable/class/GuildManager?scrollTo=fetch)
- [Frequently Asked Questions - discordjs-bot-guide](https://github.com/AnIdiotsGuide/discordjs-bot-guide/blob/master/frequently-asked-questions.md#channels-and-guilds)

`client.guilds.fetch()`は引数にサーバID（`Snowflake`）ではなくサーバオブジェクト（`GuildResolvable`）を渡さなくてはならないので、代わりに`client.guilds.cache.get(guildID)`を使います。

```js
cron.schedule('00 17 * * *', async () => {
        const guildID = 'ギルドID'

        const guild = client.guilds.cache.get(guildID);
        /* ...guildを使ってなにかする... */
```

## `guild.channels.cache.filter()`は`Collection`を返す

- [Collection.filter() - discord.js Documentation](https://discord.js.org/#/docs/collection/main/class/Collection?scrollTo=filter)

`Array.prototype.filter()`と同じような関数で、返値は`Channel`ではなく`Collection`です。

そのため、各チャンネルの`members`プロパティを取得するには`Collection.each()`しましょう。

```js
const vchannels = guild.channels.cache.filter(channel => channel.type === 'voice')

vchannels.each(vchannel =>
  vchannel.members.each(/* ... */)
)
```

## ユーザを`VoiceChannel`から退出させる方法

いくつか方法があり、その中でもバージョンによって動くものと動かないものがあるようです。

- [ボイスチャットからユーザーを蹴る - Discord.js Japan User Group](https://scrapbox.io/discordjs-japan/ボイスチャットからユーザーを蹴る)
- [VoiceState.disconnect() - discord.js Documentation](https://discord.js.org/#/docs/main/stable/class/VoiceState?scrollTo=disconnect)
- [javascript - How do I disconnect a user from a voice channel in discord.js? - Stack Overflow](https://stackoverflow.com/questions/57650739/how-do-i-disconnect-a-user-from-a-voice-channel-in-discord-js)
- [javascript - Discord.Js disconnect members voice channel - Stack Overflow](https://stackoverflow.com/questions/64008957/discord-js-disconnect-members-voice-channel)

`member.voice.setChannel(null)`や`member.setVoiceChannel(null)`はメンバーのチャンネル情報を`null`に設定することにより、ボイスチャンネルから退出させるというものです。

一方、`member.voice.disconnect()`や`member.voice.kick()`は文字通りメンバーをボイスチャンネルから退出させるために用意された関数です。
バージョンによって`disconnect()`が使える・使えない分かれるようですが、どのバージョンから使えるのかは残念ながらわかりません。`kick()`は公式ドキュメントから見つけることすらできませんでしたが、ユーザ発の情報では割とありましたので、昔からある方法なのかもしれません（この辺は伝聞になってしまいますが申し訳ない）。

【追記】
hinanonさんによると「await member.voice.kick().catch(console.error)にしたら動きました」とのことです。
以下のコードもその情報に合わせて修正しました。

`member.voice.disconnect('理由')`や`member.voice.kick()`は`Promise`を返す **非同期関数** なので、`await`で処理が終わるまで以降のコードの実行を中断します。
`await`を使うにはそのコードが含まれる関数を`async`にしなければいけないので、そこも修正します。

また、細かいことですが、`if`文周りでバグが入りそうなコードになっている（おそらく`member == null`のときでも`console.log(member.id)`が実行される）ので`{...}`で範囲を明確にしました。
`if`や`while`などは例え1行だとしても`if (...) {...}`にしておくと意図しない動作を防げます。

`vchannel.members`も`Collection`なので、`forEach()`ではなく`each()`を使っています。

```js
vchannel.members.each(async member => {
  if (member) {
    // disconnect()を使う方法
    await member.voice.disconnect(`2時になったのでボイスチャットからキックしました(*'▽')`).catch(console.error)
    
    // kick()を使う方法
    await member.voice.kick().catch(console.error)
    
    console.log(member.id)
  }
})
```

## `channel.send()`は`Promise`を返す

- [TextChannel.send() - discord.js Documentation](https://discord.js.org/#/docs/main/stable/class/TextChannel?scrollTo=send)

`Promise`を返す関数は基本的に`await`して`.catch()`でエラー処理するようにしましょう。

なお、`await member.voice.disconnect()`すると`disconnect()`の処理が終わるまでそれ以降のコードの実行を中断するので、その後にメッセージを送る場合も`setTimeout()`で`disconnect()`の処理が終わるまで待つ必要はありません。

```js
await member.voice.disconnect(`2時になったのでボイスチャットからキックしました(*'▽')`).catch(console.error)

/* 処理待ちは必要ない */ 
await channel.send(`2時になったのでボイスチャットからキックしました(*'▽')`).catch(console.error)
```

---

こんな感じでしょうか。
一応、`guild`, `vchannels`, `channel`が`null`や`undefined`, `[]`だった場合のエラー処理をしていませんのでご注意ください。
ご参考まで。

require()はできるだけファイル冒頭でする

client.guilds.fetch(guildID)ではなくclient.guilds.cache.get(guildID)

guild.channels.cache.filter()はCollectionを返す

ユーザをVoiceChannelから退出させる方法

channel.send()はPromiseを返す

関連した質問

`require()`はできるだけファイル冒頭でする

`client.guilds.fetch(guildID)`ではなく`client.guilds.cache.get(guildID)`

`guild.channels.cache.filter()`は`Collection`を返す

ユーザを`VoiceChannel`から退出させる方法

`channel.send()`は`Promise`を返す