/// <summary>
/// Notifies both the conversation owner (agent) and the conversation client (customer)
/// about the connection status change.
/// </summary>
/// <param name="messageRouterResult">The result to handle.</param>
protected virtual async Task HandleConnectionChangedResultAsync(MessageRouterResult messageRouterResult)
{
IRoutingDataManager routingDataManager = _messageRouterManager.RoutingDataManager;
Party conversationOwnerParty = messageRouterResult.ConversationOwnerParty;
Party conversationClientParty = messageRouterResult.ConversationClientParty;
string conversationOwnerName = conversationOwnerParty?.ChannelAccount.Name;
string conversationClientName = conversationClientParty?.ChannelAccount.Name;
string messageToConversationOwner = string.Empty;
string messageToConversationClient = string.Empty;
if (messageRouterResult.Type == MessageRouterResultType.ConnectionRequested)
{
if (conversationClientParty == null || conversationClientParty.ChannelAccount == null)
{
await _messageRouterManager.BroadcastMessageToAggregationChannelsAsync(
ConversationText.ConnectionRequestMadeButRequestorIsNull);
throw new NullReferenceException(ConversationText.ConnectionRequestMadeButRequestorIsNull);
}
foreach (Party aggregationParty in _messageRouterManager.RoutingDataManager.GetAggregationParties())
{
Party botParty = routingDataManager
.FindBotPartyByChannelAndConversation(aggregationParty.ChannelId, aggregationParty.ConversationAccount);
if (botParty != null)
{
IMessageActivity messageActivity = Activity.CreateMessageActivity();
messageActivity.Conversation = aggregationParty.ConversationAccount;
messageActivity.Recipient = aggregationParty.ChannelAccount;
messageActivity.Attachments = new List <Attachment>
{
CommandCardFactory.CreateRequestCard(
conversationClientParty, botParty.ChannelAccount?.Name).ToAttachment()
};
try
{
await _messageRouterManager.SendMessageToPartyByBotAsync(aggregationParty, messageActivity);
}
catch (UnauthorizedAccessException e)
{
System.Diagnostics.Debug.WriteLine($"Failed to broadcast message: {e.Message}");
}
}
else
{
try
{
await _messageRouterManager.BroadcastMessageToAggregationChannelsAsync(
string.Format(
ConversationText.FailedToFindBotOnAggregationChannel,
aggregationParty.ConversationAccount.Name));
}
catch (UnauthorizedAccessException e)
{
System.Diagnostics.Debug.WriteLine($"Failed to send message: {e.Message}");
}
}
}
messageToConversationClient = ConversationText.NotifyClientWaitForRequestHandling;
}
else if (messageRouterResult.Type == MessageRouterResultType.ConnectionAlreadyRequested)
{
messageToConversationClient = ConversationText.NotifyClientDuplicateRequest;
}
else if (messageRouterResult.Type == MessageRouterResultType.ConnectionRejected)
{
messageToConversationOwner = string.Format(ConversationText.NotifyOwnerRequestRejected, conversationClientName);
messageToConversationClient = ConversationText.NotifyClientRequestRejected;
}
else if (messageRouterResult.Type == MessageRouterResultType.Connected)
{
messageToConversationOwner = string.Format(ConversationText.NotifyOwnerConnected, conversationClientName);
messageToConversationClient = string.Format(ConversationText.NotifyClientConnected, conversationOwnerName);
}
else if (messageRouterResult.Type == MessageRouterResultType.Disconnected)
{
messageToConversationOwner = string.Format(ConversationText.NotifyOwnerDisconnected, conversationClientName);
messageToConversationClient = string.Format(ConversationText.NotifyClientDisconnected, conversationOwnerName);
}
if (!string.IsNullOrEmpty(messageToConversationOwner) && conversationOwnerParty != null)
{
try
{
await _messageRouterManager.SendMessageToPartyByBotAsync(
conversationOwnerParty, messageToConversationOwner);
}
catch (UnauthorizedAccessException e)
{
System.Diagnostics.Debug.WriteLine($"Failed to send message: {e.Message}");
}
}
if (!string.IsNullOrEmpty(messageToConversationClient) && conversationClientParty != null)
{
try
{
await _messageRouterManager.SendMessageToPartyByBotAsync(
conversationClientParty, messageToConversationClient);
}
catch (UnauthorizedAccessException e)
{
System.Diagnostics.Debug.WriteLine($"Failed to send message: {e.Message}");
}
}
}
/// <summary>
/// Checks the given activity for a possible command.
///
/// All messages that start with a specific command keyword or contain a mention of the bot
/// ("@<bot name>") are checked for possible commands.
/// </summary>
/// <param name="activity">An Activity instance containing a possible command.</param>
/// <returns>True, if a command was detected and handled. False otherwise.</returns>
public async virtual Task <bool> HandleCommandAsync(Activity activity)
{
bool wasHandled = false;
Activity replyActivity = null;
if ((!string.IsNullOrEmpty(activity.Text) && activity.Text.StartsWith($"{Commands.CommandKeyword} ")) ||
WasBotAddressedDirectly(activity, false))
{
string commandMessage = ExtractCleanCommandMessage(activity);
Party senderParty = MessagingUtils.CreateSenderParty(activity);
switch (commandMessage.ToLower())
{
case string command when(command.StartsWith(Commands.CommandListOptions)):
// Present all command options in a card
replyActivity = CreateCommandOptionsCard(activity);
wasHandled = true;
break;
case string command when(command.StartsWith(Commands.CommandAddAggregationChannel)):
// Establish the sender's channel/conversation as an aggreated one if not already exists
Party aggregationParty = new Party(activity.ServiceUrl, activity.ChannelId, null, activity.Conversation);
if (_messageRouterManager.RoutingDataManager.AddAggregationParty(aggregationParty))
{
replyActivity = activity.CreateReply("This channel/conversation is now where the requests are aggregated");
}
else
{
replyActivity = activity.CreateReply("This channel/conversation is already receiving requests");
}
wasHandled = true;
break;
case string command when(command.StartsWith(Commands.CommandAcceptRequest) || command.StartsWith(Commands.CommandRejectRequest)):
// Accept/reject conversation request
bool doAccept = command.StartsWith(Commands.CommandAcceptRequest);
if (_messageRouterManager.RoutingDataManager.IsAssociatedWithAggregation(senderParty))
{
// The party is associated with the aggregation and has the right to accept/reject
string errorMessage = await AcceptOrRejectRequestAsync(senderParty, commandMessage, doAccept);
if (!string.IsNullOrEmpty(errorMessage))
{
replyActivity = activity.CreateReply(errorMessage);
}
}
else
{
replyActivity = activity.CreateReply("Sorry, you are not allowed to accept/reject requests");
}
wasHandled = true;
break;
case string command when(command.StartsWith(Commands.CommandDisconnect)):
// End the 1:1 conversation
IList <MessageRouterResult> messageRouterResults = _messageRouterManager.Disconnect(senderParty);
foreach (MessageRouterResult messageRouterResult in messageRouterResults)
{
await _messageRouterResultHandler.HandleResultAsync(messageRouterResult);
}
wasHandled = true;
break;
#region Implementation of debugging commands
#if DEBUG
case string command when(command.StartsWith(Commands.CommandDeleteAllRoutingData)):
// DELETE ALL ROUTING DATA
await _messageRouterManager.BroadcastMessageToAggregationChannelsAsync(
$"Deleting all data as requested by \"{senderParty.ChannelAccount?.Name}\"...");
replyActivity = activity.CreateReply("Deleting all data...");
_messageRouterManager.RoutingDataManager.DeleteAll();
wasHandled = true;
break;
case string command when(command.StartsWith(Commands.CommandListAllParties)):
// List user and bot parties
IRoutingDataManager routingDataManager = _messageRouterManager.RoutingDataManager;
string replyMessage = string.Empty;
string partiesAsString = PartyListToString(routingDataManager.GetUserParties());
if (string.IsNullOrEmpty(partiesAsString))
{
replyMessage = $"No user parties{LineBreak}";
}
else
{
replyMessage = $"Users:{LineBreak}{partiesAsString}";
}
partiesAsString = PartyListToString(routingDataManager.GetBotParties());
if (string.IsNullOrEmpty(partiesAsString))
{
replyMessage += "No bot parties";
}
else
{
replyMessage += $"Bot:{LineBreak}{partiesAsString}";
}
replyActivity = activity.CreateReply(replyMessage);
wasHandled = true;
break;
case string command when(command.StartsWith(Commands.CommandListPendingRequests)):
// List all pending requests
var attachments = new List <Attachment>();
foreach (Party party in _messageRouterManager.RoutingDataManager.GetPendingRequests())
{
attachments.Add(CreateRequestCard(party, activity.Recipient.Name));
}
if (attachments.Count > 0)
{
replyActivity = activity.CreateReply($"{attachments.Count} pending request(s) found:");
replyActivity.AttachmentLayout = AttachmentLayoutTypes.Carousel;
replyActivity.Attachments = attachments;
}
else
{
replyActivity = activity.CreateReply("No pending requests");
}
wasHandled = true;
break;
case string command when(command.StartsWith(Commands.CommandListConnections)):
// List all connections (conversations)
string parties = _messageRouterManager.RoutingDataManager.ConnectionsToString();
if (string.IsNullOrEmpty(parties))
{
replyActivity = activity.CreateReply("No conversations");
}
else
{
replyActivity = activity.CreateReply(parties);
}
wasHandled = true;
break;
case string command when(command.StartsWith(Commands.CommandListLastMessageRouterResults)):
// List all logged message router results
string resultsAsString = _messageRouterManager.RoutingDataManager.GetLastMessageRouterResults();
replyActivity = activity.CreateReply($"{(string.IsNullOrEmpty(resultsAsString) ? "No results" : resultsAsString)}");
wasHandled = true;
break;
#endif
#endregion
default:
replyActivity = activity.CreateReply($"Command \"{commandMessage}\" not recognized");
break;
}
if (replyActivity != null)
{
ConnectorClient connector = new ConnectorClient(new Uri(activity.ServiceUrl));
await connector.Conversations.ReplyToActivityAsync(replyActivity);
}
}
return(wasHandled);
}
/// <summary>
/// Checks the given activity for a possible command.
///
/// All messages that start with a specific command keyword or contain a mention of the bot
/// ("@<bot name>") are checked for possible commands.
/// </summary>
/// <param name="activity">An Activity instance containing a possible command.</param>
/// <returns>True, if a command was detected and handled. False otherwise.</returns>
public async virtual Task <bool> HandleCommandAsync(Activity activity)
{
bool wasHandled = false;
Activity replyActivity = null;
Command command = ExtractCommand(activity);
if (command != null)
{
Party senderParty = MessagingUtils.CreateSenderParty(activity);
switch (command.BaseCommand.ToLower())
{
case string baseCommand when(baseCommand.Equals(Commands.CommandListOptions)):
// Present all command options in a card
replyActivity = CommandCardFactory.AddCardToActivity(
activity.CreateReply(), CommandCardFactory.CreateCommandOptionsCard(activity.Recipient?.Name));
wasHandled = true;
break;
case string baseCommand when(baseCommand.Equals(Commands.CommandAddAggregationChannel)):
// Establish the sender's channel/conversation as an aggreated one if not already exists
Party aggregationPartyToAdd =
new Party(activity.ServiceUrl, activity.ChannelId, null, activity.Conversation);
if (_messageRouterManager.RoutingDataManager.AddAggregationParty(aggregationPartyToAdd))
{
replyActivity = activity.CreateReply(ConversationText.AggregationChannelSet);
}
else
{
replyActivity = activity.CreateReply(ConversationText.AggregationChannelAlreadySet);
}
wasHandled = true;
break;
case string baseCommand when(baseCommand.Equals(Commands.CommandRemoveAggregationChannel)):
// Remove the sender's channel/conversation from the list of aggregation channels
if (_messageRouterManager.RoutingDataManager.IsAssociatedWithAggregation(senderParty))
{
Party aggregationPartyToRemove =
new Party(activity.ServiceUrl, activity.ChannelId, null, activity.Conversation);
if (_messageRouterManager.RoutingDataManager.RemoveAggregationParty(aggregationPartyToRemove))
{
replyActivity = activity.CreateReply(ConversationText.AggregationChannelRemoved);
}
else
{
replyActivity = activity.CreateReply(ConversationText.FailedToRemoveAggregationChannel);
}
wasHandled = true;
}
break;
case string baseCommand when(baseCommand.Equals(Commands.CommandAcceptRequest) ||
baseCommand.Equals(Commands.CommandRejectRequest)):
// Accept/reject conversation request
bool doAccept = baseCommand.Equals(Commands.CommandAcceptRequest);
if (_messageRouterManager.RoutingDataManager.IsAssociatedWithAggregation(senderParty))
{
// The party is associated with the aggregation and has the right to accept/reject
if (command.Parameters.Count == 0)
{
replyActivity = activity.CreateReply();
IList <Party> pendingRequests =
_messageRouterManager.RoutingDataManager.GetPendingRequests();
if (pendingRequests.Count == 0)
{
replyActivity.Text = ConversationText.NoPendingRequests;
}
else
{
replyActivity = CommandCardFactory.AddCardToActivity(
replyActivity, CommandCardFactory.CreateAcceptOrRejectCardForMultipleRequests(
pendingRequests, doAccept, activity.Recipient?.Name));
}
}
else if (!doAccept &&
command.Parameters[0].Equals(Commands.CommandParameterAll))
{
if (!await new MessageRoutingUtils().RejectAllPendingRequestsAsync(
_messageRouterManager, _messageRouterResultHandler))
{
replyActivity = activity.CreateReply();
replyActivity.Text = ConversationText.FailedToRejectPendingRequests;
}
}
else
{
string errorMessage = await new MessageRoutingUtils().AcceptOrRejectRequestAsync(
_messageRouterManager, _messageRouterResultHandler, senderParty, doAccept, command.Parameters[0]);
if (!string.IsNullOrEmpty(errorMessage))
{
replyActivity = activity.CreateReply();
replyActivity.Text = errorMessage;
}
}
}
#if DEBUG
// We shouldn't respond to command attempts by regular users, but I guess
// it's okay when debugging
else
{
replyActivity = activity.CreateReply(ConversationText.ConnectionRequestResponseNotAllowed);
}
#endif
wasHandled = true;
break;
case string baseCommand when(baseCommand.Equals(Commands.CommandDisconnect)):
// End the 1:1 conversation
IList <MessageRouterResult> messageRouterResults = _messageRouterManager.Disconnect(senderParty);
foreach (MessageRouterResult messageRouterResult in messageRouterResults)
{
await _messageRouterResultHandler.HandleResultAsync(messageRouterResult);
}
wasHandled = true;
break;
#region Implementation of debugging commands
#if DEBUG
case string baseCommand when(baseCommand.Equals(Commands.CommandDeleteAllRoutingData)):
// DELETE ALL ROUTING DATA
await _messageRouterManager.BroadcastMessageToAggregationChannelsAsync(
string.Format(ConversationText.DeletingAllDataWithCommandIssuer, senderParty.ChannelAccount?.Name));
replyActivity = activity.CreateReply(ConversationText.DeletingAllData);
_messageRouterManager.RoutingDataManager.DeleteAll();
wasHandled = true;
break;
case string baseCommand when(baseCommand.Equals(Commands.CommandList)):
bool listAll = command.Parameters.Contains(Commands.CommandParameterAll);
replyActivity = activity.CreateReply();
string replyMessageText = string.Empty;
if (listAll || command.Parameters.Contains(Commands.CommandParameterParties))
{
// List user and bot parties
IRoutingDataManager routingDataManager = _messageRouterManager.RoutingDataManager;
string partiesAsString = PartyListToString(routingDataManager.GetUserParties());
replyMessageText += string.IsNullOrEmpty(partiesAsString)
? $"{ConversationText.NoUsersStored}{StringAndCharConstants.LineBreak}"
: $"{ConversationText.Users}:{StringAndCharConstants.LineBreak}{partiesAsString}{StringAndCharConstants.LineBreak}";
partiesAsString = PartyListToString(routingDataManager.GetBotParties());
replyMessageText += string.IsNullOrEmpty(partiesAsString)
? $"{ConversationText.NoBotsStored}{StringAndCharConstants.LineBreak}"
: $"{ConversationText.Bots}:{StringAndCharConstants.LineBreak}{partiesAsString}{StringAndCharConstants.LineBreak}";
wasHandled = true;
}
if (listAll || command.Parameters.Contains(Commands.CommandParameterRequests))
{
// List all pending requests
IList <Attachment> attachments =
CommandCardFactory.CreateMultipleRequestCards(
_messageRouterManager.RoutingDataManager.GetPendingRequests(), activity.Recipient?.Name);
if (attachments.Count > 0)
{
replyMessageText += string.Format(ConversationText.PendingRequestsFoundWithCount, attachments.Count);
replyMessageText += StringAndCharConstants.LineBreak;
replyActivity.AttachmentLayout = AttachmentLayoutTypes.Carousel;
replyActivity.Attachments = attachments;
}
else
{
replyMessageText += $"{ConversationText.NoPendingRequests}{StringAndCharConstants.LineBreak}";
}
wasHandled = true;
}
if (listAll || command.Parameters.Contains(Commands.CommandParameterConnections))
{
// List all connections (conversations)
string connectionsAsString = _messageRouterManager.RoutingDataManager.ConnectionsToString();
replyMessageText += string.IsNullOrEmpty(connectionsAsString)
? $"{ConversationText.NoConversations}{StringAndCharConstants.LineBreak}"
: $"{connectionsAsString}{StringAndCharConstants.LineBreak}";
wasHandled = true;
}
if (listAll || command.Parameters.Contains(Commands.CommandParameterResults))
{
// List all logged message router results
string resultsAsString = _messageRouterManager.RoutingDataManager.GetLastMessageRouterResults();
replyMessageText += string.IsNullOrEmpty(resultsAsString)
? $"{ConversationText.NoResults}{StringAndCharConstants.LineBreak}"
: $"{resultsAsString}{StringAndCharConstants.LineBreak}";
wasHandled = true;
}
if (!wasHandled)
{
replyMessageText = ConversationText.InvalidOrMissingCommandParameter;
}
replyActivity.Text = replyMessageText;
break;
#endif
#endregion
default:
replyActivity = activity.CreateReply(string.Format(ConversationText.CommandNotRecognized, command.BaseCommand));
break;
}
if (replyActivity != null)
{
ConnectorClient connector = new ConnectorClient(new Uri(activity.ServiceUrl));
await connector.Conversations.ReplyToActivityAsync(replyActivity);
}
}
return(wasHandled);
}