-
Notifications
You must be signed in to change notification settings - Fork 3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add new bot command autopost docs (#5530)
add new bot command autopost docs to docs.openbb.co Co-authored-by: James Maslek <jmaslek11@gmail.com>
- Loading branch information
1 parent
dac1085
commit 16d29d6
Showing
6 changed files
with
97 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,38 @@ | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: add | ||
title: commands add | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# add | ||
# commands add | ||
|
||
This command allows the user to add an autopost webhook feed to a channel. It allows the user to receive notifications from OpenBB webhooks in the channel without having to manually post them. This can be used to keep track of flow, darkpool, market heatmap and more. | ||
This command allows the user to add an autopost command to a channel. It allows the user to receive notifications from OpenBB bot in the channel without having to manually query them. This can be used for all commands that appear in the list when you run "autopost commands add" | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/autopost add | ||
/autopost commands add cmd interval [start_time] [stop_time] | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
This command has no parameters | ||
|
||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| cmd | Pick the command you want to assign for autoposting | False | List of commands that allow auto posting | | ||
| interval | How oftern to post the autopost command | False | 5m, 15m, 30m, 1hr, 2hr, 4hr, 6hr | | ||
| start_time | Time to start the autopost command - ex. If I want to start at 8am I do 8 | True | 24hr time | | ||
| stop_time | Time to stop the autopost command - ex. If I want to stop at 6pm I do 18 | True | 24hr time | | ||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/autopost add | ||
/autopost commands add cmd:/cm interval:1 Hour | ||
``` | ||
|
||
``` | ||
/autopost commands add cmd: /cm interval: 1 Hour start_time: 9 stop_time: 10 | ||
``` | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: feeds | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# feeds | ||
|
||
This command allows the user to add, remove, or list autopost webhook feeds to a channel. It allows the user to receive notifications from OpenBB webhooks in the channel without having to manually post them. This can be used to keep track of flow, darkpool, and market heatmaps. | ||
|
||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/autopost feeds action | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| action | Add, Remove, or List your feeds for Discord autoposts | False | Add, Remove, List | | ||
|
||
|
||
## Examples | ||
|
||
``` | ||
/autopost feeds action:Add | ||
``` | ||
|
||
``` | ||
/autopost feeds action:List | ||
``` | ||
|
||
``` | ||
/autopost feeds action:Remove | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
20 changes: 12 additions & 8 deletions
20
.../bot/reference/discord/autopost/remove.md → .../bot/reference/discord/autopost/manage.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,36 @@ | ||
--- | ||
########### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ########### | ||
title: remove | ||
title: commands manage | ||
description: OpenBB Discord Command | ||
--- | ||
|
||
# remove | ||
# commands manage | ||
|
||
This command allows the user to remove an autopost webhook feed from the channel. When executed, it will remove the feed from the channel and prevent any further autoposts from being sent. | ||
|
||
### Usage | ||
|
||
```python wordwrap | ||
/autopost remove | ||
/autopost commands manage action | ||
``` | ||
|
||
--- | ||
|
||
## Parameters | ||
|
||
This command has no parameters | ||
|
||
|
||
| Name | Description | Optional | Choices | | ||
| ---- | ----------- | -------- | ------- | | ||
| action | Remove, or List your feeds for Discord autoposts | True | Remove, List | | ||
|
||
--- | ||
|
||
## Examples | ||
|
||
``` | ||
/autopost remove | ||
/autopost commands manage action:List | ||
``` | ||
--- | ||
|
||
``` | ||
/autopost commands manage action:Remove | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters