Difference between revisions of "SpaceAPIBot"
Stuiterveer (talk | contribs) m |
m (project completed (it works)) |
||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Project | {{Project | ||
| − | |State= | + | |Featured=No |
| + | |State=Completed | ||
|Members=Stuiterveer | |Members=Stuiterveer | ||
|Description=Displays the open/close state for hackerspaces within Telegram. | |Description=Displays the open/close state for hackerspaces within Telegram. | ||
| + | |GitHub=SpaceAPIBot | ||
}} | }} | ||
= Synopsis = | = Synopsis = | ||
| Line 9: | Line 11: | ||
The reason behind the bot was to provide a "central" hub (comparable to [http://spaceapi.net/directory.json the SpaceAPI directory], but you can also add spaces that are not in this directory, as long as they comply with the [http://spaceapi.net/validator API requirements]) for displaying multiple hackerspaces and displaying their state without having to navigate to one or multiple web pages. | The reason behind the bot was to provide a "central" hub (comparable to [http://spaceapi.net/directory.json the SpaceAPI directory], but you can also add spaces that are not in this directory, as long as they comply with the [http://spaceapi.net/validator API requirements]) for displaying multiple hackerspaces and displaying their state without having to navigate to one or multiple web pages. | ||
| − | = commands | + | = Commands = |
| − | * '''/start''' - display all commands. | + | * '''/help''' - display all commands. |
| + | * '''/start''' - display all commands. It's the same effect as using /help, this is done because a new chat with a bot is handled by sending a /start command. | ||
* '''/spaces''' - display all the spaces that are currently on the list. | * '''/spaces''' - display all the spaces that are currently on the list. | ||
* '''/default <space>''' - set a default hackerspace for displaying the state when using "''/state''". Will return an error when the space is not on the list. | * '''/default <space>''' - set a default hackerspace for displaying the state when using "''/state''". Will return an error when the space is not on the list. | ||
| Line 17: | Line 20: | ||
* '''/add <url>''' - add a space to the list using the provided URL. The URL must return a JSON object that complies with the [http://spaceapi.net/validator SpaceAPI requirements]. Will return an error when the URL doesn't provide a correct JSON object. | * '''/add <url>''' - add a space to the list using the provided URL. The URL must return a JSON object that complies with the [http://spaceapi.net/validator SpaceAPI requirements]. Will return an error when the URL doesn't provide a correct JSON object. | ||
* '''/info''' - displays some additional information about the bot. | * '''/info''' - displays some additional information about the bot. | ||
| + | * '''/purge''' - removes all preferences stored by the bot for your user. | ||
| + | <span style="font-size:0%">Hidden commands? Why yes, of course! If you understand Dutch, try requesting the state of Henk or using a pudding command. Want to know other commands as well? Hey now, don't be greedy! Find those yourself!</span> | ||
| − | ' | + | = Known bugs = |
| + | * A lot of special characters in UTF-8 don't work correctly with the bot. | ||
| + | |||
| + | [[Category:SpaceAPI]] | ||
Latest revision as of 11:11, 24 May 2017
| Project: SpaceAPIBot | |
|---|---|
| Featured: | No |
| State | Completed |
| Members | Stuiterveer |
| GitHub | SpaceAPIBot |
| Description | Displays the open/close state for hackerspaces within Telegram. |
| Picture | |
| No project picture! Fill in form Picture or Upload a jpeg here | |
Synopsis
This bot can be used to display the open/close states for multiple hackerspaces within Telegram, using the JSON attributes for SpaceAPI. The bot can also be used within group chats. To start a new chat with this bot, send a message to "SpaceAPIBot".
The reason behind the bot was to provide a "central" hub (comparable to the SpaceAPI directory, but you can also add spaces that are not in this directory, as long as they comply with the API requirements) for displaying multiple hackerspaces and displaying their state without having to navigate to one or multiple web pages.
Commands
- /help - display all commands.
- /start - display all commands. It's the same effect as using /help, this is done because a new chat with a bot is handled by sending a /start command.
- /spaces - display all the spaces that are currently on the list.
- /default <space> - set a default hackerspace for displaying the state when using "/state". Will return an error when the space is not on the list.
- /state - display the state for the space that's set to default. Will return an error when no default is set. An extra parameter can be added:
- /state <space> - display the state for the space that's entered. Will return an error when the space is not on the list.
- /add <url> - add a space to the list using the provided URL. The URL must return a JSON object that complies with the SpaceAPI requirements. Will return an error when the URL doesn't provide a correct JSON object.
- /info - displays some additional information about the bot.
- /purge - removes all preferences stored by the bot for your user.
Hidden commands? Why yes, of course! If you understand Dutch, try requesting the state of Henk or using a pudding command. Want to know other commands as well? Hey now, don't be greedy! Find those yourself!
Known bugs
- A lot of special characters in UTF-8 don't work correctly with the bot.
