[Facebook Adapter] Add typing indicator support #3130
Conversation
|
✔️ No Binary Compatibility issues for Microsoft.Bot.Builder.dll compared against version 4.6.3 |
There was a problem hiding this comment.
I think the tests should cover different scenarios.
Typing indicators will most often be used when an operation may take some time. IE, the typing indicator is sent, then the long running operation is undertaken, then the final message is sent.
- send a typing activity on its own, not as part of a special sendWithTypingIndicator method. This is most often how this will be used.
- include a typing indicator in a dialog.
| public static async Task SendActivityWithTypingIndicatorAsync(IActivity activity, ITurnContext turnContext, CancellationToken cancellationToken) | ||
| { | ||
| var typingActivity = GenerateTypingActivity(turnContext.Activity.Conversation.Id); | ||
| await turnContext.SendActivitiesAsync(new[] { typingActivity, activity }, cancellationToken).ConfigureAwait(false); |
There was a problem hiding this comment.
I think this might be extraneous since the messages will both go out very quickly in sequence meaning there won't be much time for the typing indicator to be displayed before the next message arrives...
There was a problem hiding this comment.
Hi Ben. Then we'll change it to let the user manually create the typing indicator activity and then send it before the message activity (basically what the method SendActivityWithTypingIndicatorAsync is doing. We would then remove the method of course).
We will also include an example with a dialog.
There was a problem hiding this comment.
Ok now SendActivityWithTypingIndicatorAsync has been removed. The bot needs to create a typing indicator activity by calling FacebookHelper.GenerateTypingActivity.
There are examples for sending messages with and without typing indicator in the bot, as well as a trigger phrase (display typing indicator) for displaying a typing indicator alone.
I also made some other minor corrections I found.
|
Also, the generated documentation should make clear how to send a typing indicator on its own. |
|
✔️ No Binary Compatibility issues for Microsoft.Bot.Builder.dll compared against version 4.6.3 |
|
@benbrown are you happy with this now? If so, please approve and I will get it merged. |
Description
The changes address the issue raised in bug #3071 where the typing indicator is not supported in the .NET version of the adapter yet.
Proposed changes
To display a
typing_onsender_action every time the bot prepares a message, we added the SendMessage method in FacebookHelper which creates an extra activity with the required format for the Sender Action (note thatFacebookMessage.Messageneeds to be null when Sender Actions are present) and then sends it along with the actual message activity using TurnContext SendActivitiesAsync method.Sample bots have been modified accordingly, displaying typing indicators for messages, attachments, and templates.