Edit a Thread
Last updated
Last updated
This action cannot be used for forum channels!
The Edit a Thread block enables you to edit any existing thread in your servers that the bot is in.
Each edited thread has a unique variable that you can use to reference the thread in your command and can be identified by just looking for {edited_thread_xyz}
.
To edit a thread, you need to specify where the thread is. There are three provided options to achieve this.
This selection will edit the thread in the channel where the command / event was executed in. To use specific channels and variables use Channel and Thread ID or Channel Option and Thread ID.
This is an optional field, and it is the name of the thread that you want to edit. You can use variables or options as well.
This is an optional selection, 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
An optional field that, you can input a reason why you are editing a thread. Variables can be used in this field as well. The reason will show in your server's audit log.
This is an optional field, 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. This field only accepts integers, and variables can be used.
This an optional toggle that only shows if the thread type is Private Thread. It allows you to toggle whether a non-moderator can invite other users to the thread.
An optional toggle that is used if you want to lock the thread, meaning that only moderators can send messages if the thread has been locked.
An optional field, this is used when you want to archive the thread, putting it into an archived state.
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 {edited_thread_abcd}
variable, but before the }
. The 4 characters "abcd" are shown in your create thread block at the top.
An example to get the name would be like this: {edited_thread_48f3.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 |
Enable Success / Error Handles to detect success and errors inside of the action block. This allows you to run different actions if something goes wrong with your action. Inside of the handle, there are 2 different paths which are used to detect the outcome of the action. The green path on the bottom left side of the block indicates success, while the red path on the bottom right side of the block indicates error. You may attach action blocks to each side of the handle to get the outcome of your action block.
The Success/Error Handles feature includes 3 different error variables you can use to get information on why the action block encountered an error. Check them out here.