Create a Thread
Create a thread in your server!
This action cannot be used for forum channels!
Ever wanted your bot to create a thread? Well, now you can! The Create a Thread block enables you to do this.
Each created thread has a unique variable that you can use to reference the thread in your command and can be identified by just looking for {option_created_thread_xxxx}
.
Channel
To create the thread, you need to specify what channel you are going to create the thread in. We provide you with three options to achieve this.
Channel the command/event was run in
If this option is used, the thread will be created in the channel that either the command or event was run in.
Channel ID
If this option is used, the thread will be created in the channel based on the ID that you provide. This can accept variables from the data storage module or unique variables.
You can also specify the starting message that the thread will be attached to.
Channel Option*
*This only works for commands, not events.
If this option is used, the thread will be created in the channel that you specified from a channel option.
You can also specify the starting message that the thread will be attached to.
Name
This is a required option, and it is the name of the thread that you want to create. You can use variables or options as well.
Type
This is an optional option, and it is the type of thread that you want to create. You can choose from 3 types of thread types.
Private Thread -> If you want your thread to be private.
Public Thread -> If you want your thread to be public.
Announcement Thread -> If you want to create a thread in an announcements channel.
Auto Archive
This is an optional option, and it is the time in which the thread will auto-archive itself. You can choose from 4 options:
One Hour
One Day
Three Days
One Week
Reason
An optional option. With this, you can input a reason why you are creating a thread.
Slow mode
An optional option.
Also known as rate limit per user, it allows you to set a slow mode in the thread for each user unless the user has been bypassed.
Moderators Invite*
*This option only shows if the thread type is Private Thread.
An optional option. It allows you to toggle whether a non-moderator can invite other users to the thread.
Variables
You can now access various variables from the created thread and use them throughout your custom command (as long as it is in the same interaction).
You can use these variables by just adding them to the end of the {option_created_thread_abcd}
variable, but before the }
.
An example to get the name would be like this: {option_created_thread_abcd.name}
.
Name | Description |
---|---|
.name | Returns the name of the thread |
.id | Returns the ID of the thread |
.parent | Returns the parent channel of the thread |
.parent_id | Returns the parent's ID of the thread |
.archived | Returns whether the thread is archived or not (as true or false) |
.locked | Returns whether the thread is locked or not (as true or false) |
.invitable | Returns whether a non-moderator can invite users to the thread or not (as true or false) |
.owner_id | Returns the thread owner's ID |
.url | Returns the url of the thread |
Last updated