rocketchat / rocket.chat.demo.app Goto Github PK

A new slash command /increment

• takes an integer as a subcommand and increments the stored value in persistence storage by that integer.
• the stored value initially defaults to 0.
• /increment 2 will increase the value of 0 to 2. Subsequently, /increment 4 will make the stored value 6.
• /increment reset will reset the stored value back to 0.
• /increment help will show instructions on usage of the command

Just like the sendMessage and sendNotification helper we need to have a sendDirect helper for the app.
The implementation is already done in the /example command file, we just need to move it to lib directory and use it

To get cleaner code and encourage code reuse, specifically while implementing slash commands, following helper modules are required:

• sendMessage.ts - to send message in a channel
• sendNotification.ts - to send notifications in a channel
• sendDirectMessage.ts - to send direct message to a user through the channel

More helper functions can be listed and implemented, as required, in this list.

Description:

• There are several issues which is breaking our chat messages guidelines provided in documentation, when running all /increment command (with or without argument). The guideline is as follows (highlighted point).

EDIT: UI GUIDELINE: https://developer.rocket.chat/apps-engine/ui-guidelines

To be more clear lets walk through:

When running /increment, /increment help and /increment NotANumberSomeRandomText:

• the message to the channel has been send by the user which is the account owner of rocketchat and it is persistance so it won't get removed when refresh and can be seen by the other users within room. Which is against the guidelines and this is usually not the ideal behaviour of rocket.chat apps for such behaviour commands. Check [Fig 9.1]

When running /increment reset and /increment <number>

• the message to the channel has been send by the user which is the account owner of rocketchat this is against the guidelines but in this case we must note messages are already persistance and needs to be persistance and as it is and should be visible to other users in the room. Check [Fig 9.2]

To reproduce:

• Run /increment command with all the above case mentioned and check the resulting message.

Expected behavior:

• when running /increment, /increment help and /increment NotANumberSomeRandomText message should be send by the AppBot, should not be persistance and should not be visible by the other user of room.
• when running /increment reset and /increment <number> message should be send by the AppBot.
  NOTE: should be persistance as it is currently and should also be visible by the other user in the room.

Actual behavior:

[Fig. 9.1]

[Fig. 9.2]

Additional context

• Willing to fix this one, waiting for your acknowledgement/assign
• Also do let me know if i misfigured out the feature and do correct me, Thanks.