https://github.com/raralabs/rara-bot-guide

https://github.com/raralabs/rara-bot-guide

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/raralabs/rara-bot-guide
• Owner: raralabs
• Created: 2021-10-19T04:29:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-11T13:43:30.000Z (about 3 years ago)
• Last Synced: 2025-04-15T01:12:40.669Z (about 2 months ago)
• Size: 3.91 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 1. How To Use

We can directly message **Rara bot** in our workspace using following commands.

### 1.1 Commands

* `/help`:- Give short details and link to assist with using commands.

* `/out`:- Command to work with recording absent data. Commands available:

    * `/out` - > Give modal to register absent details

    * `/out -d n` where n is *number of day* ->  Record details *n* day from today, reason will be *null*

    * `/out -d n "I am travelling"`-> Record details *n* day from today, reason for *leave*

    * `/out -undo` -> Leave will be removed but with limit (default: 30 minutes)

        

   Eg:- `/out -d 2 "Fever and common cold"` -> 2 days leave starting from today

    

* `/out-today`:- Gets all name of member who are absent today.

* `/out-month`:- Gets all member who are absent by month.

    * `/out-month` - > All members absent in current month

    * `/out-month -m n` where n is *number of month* -> All members absent by specific month

    * `/out-month -m [m, n]` where m and n is *number of month* -> Data between *m* and *n* (including *both*)

    * `/out-month -m n false`-> All members absent by specific month, _false_ represent include holidays or not

    * `/out-month -me` -> Total leaves by current user in current month

    Note:- `-me` takes same values as by `-m`.

   Eg:- `/out-month -m [4, 8] false` -> Members leave from month 4 till 8 and does not count weekends

    

* `/out-year`:- Gets all member who are absent by year.

    * `/out-year` - > All members absent in current year

    * `/out-year -y n` where n is *number of year* -> All members absent by specific year

    * `/out-year -y [m, n]` where m and n is *number of year* -> Data between *m* and *n* (including *both*)

    * `/out-year -y n false`-> All members absent by specific year, _false_ represent include holidays or not

    * `/out-year -me` -> Total leaves by current user in current year

    Note:- `-me` takes same values as by `-y`.

   Eg:- `/out-year -y [2019, 2021]` -> Members leave from 2019 till 2021 includes weekends 

 * `/holiday-today`:- Return if today is holiday or not

 * `/holiday-month`:- Returns holidays by month

    * `/holiday-month` -> All holidays in the current month.

    * `/holiday-month -m n` -> All holidays in month number, *n*. 

    * `/holiday-month -m [m, n]` where m and n is *number of month* -> Holidays between *m* and *n*

    Eg:- `/holiday-month -m [4, 8]` -> Holidays from month *4* till *8* in current year.

* `/late`:- Command to work with recording late data. Commands available:

    * `/late -l late_remarks`-> Record late details, *late_remarks* is late remarks text within quotes.

        

   Eg:- `/late -l "I will be 30 min late"` -> Late with remarks

    

* `/late-today`:- Gets all name of member who are late today.

* `/lunch-today`:- Gets number of members having or not having lunch the current date.

   

#### 1.1.1 Commands for admin/manager

* `/out`

    * `/out -add "[email protected]" "Fever"` -> Add leave for the user. Leave will be taken for the current day. Description is _optional_.

    * `/out -del "[email protected]"` - > Cancel leave for user with given _email_ . 

    Note:- Command will work only if leave start day *is greater than or equal to* current date. In other word, leaves that are *passed will not be touched* by the command.

* `/late`

    * `/late -add "[email protected]" "30 mins late"` -> Add late for the user. Late will be taken for the current day. Description is _required_.

    * `/late -del "[email protected]"` - > Cancel late for user with given _email_ . 

    Note:- Command will work only if late created date *is greater than or equal to* current date.

    

* `/holiday`

    * `/holiday` -> Gives modal to register using form. But, cannot use to insert multiple holiday at once.

    * `/holiday -h [n*] "Tihar vacation"` where n is *list of dates*  ->  Register records for holiday with more than one date.

    * `/holiday -del [n*]` where n* is *list of dates*  ->  Delete records for holiday with list of dates. 

    

    Eg:- `/holiday -h ['2021-11-05', '2021-11-06'] 'Tihar vacation'` where *description* is optional. Note that date should follow exact format.

* `/message`

    * `/message -del ['ts1', 'ts2', **] 'channel_id'` -> Delete messages where *ts* is message timestamp that can be found from copying link. channel_id is optional. If channel id is not given then channel_id will be the channel id from where the command is run.

    Eg:- `/message -del ['1635913924024900', "1635913925025000",  “1635913925025100”]`