Kord-Extensions/kord-extensions

Add timeout utility extensions methods

Ayfri opened this issue · 2 comments

Ayfri commented

Summary

Add a method to easily timeout a member for a duration and a method to disable timeout of a member.

Current Behaviour

Editing the member timeoutUntil or communicationDisabledUntil property, if we want to deactivate until now + a duration, we have to include a calculation into our code.

Preferred Behaviour

Use methods for this.

Suggestions

/**
 * Disable communication for a member until now + duration.
 * Returns false if the bot cannot set the timeout for the member, otherwise true.
**/
suspend fun MemberBehavior.timeout(duration: Duration): Boolean
// and maybe also
suspend fun MemberBehavior.timeout(seconds: int): Boolean

/**
 * Remove disabled communication for a member.
 * Returns false if the bot cannot enable communication for member, otherwise true.
**/
suspend fun MemberBehavior.stopTimeout()

Hello, and thanks for opening an issue! As this is the first time you've created an issue on this repository, we'd just like to offer you a warm welcome to the project, and the following pointers:

  • Most importantly, all issues must adhere to our Code of Conduct. Please give it a quick read if you haven't already.

  • While our team is passionate about the projects we've created here, we're all volunteers. Please don't be offended if it takes time for us to get to your issue - we'll be here as soonas we can be!

  • Please provide as much information as possible when asking a question, reporting a problem, or submitting a feature request. This will help us to address your issue quickly and efficiently. If you forgot to add some information, no worries - feel free to edit the issue and add anything you missed!

    Thanks for contacting us! If you have any further questions, please feel free to join us on Discord in the #dev-kotdis channel (or #kordex-discussion for Kord Extensions projects), or to contact a staff member directly.

Done!