private static readonly TimeSpan PollingInterval = TimeSpan.FromSeconds(1); // Poll for token every 1 second.
public static void CheckForOAuthCards(BotFrameworkAdapter adapter, ILogger logger, ITurnContext turnContext, Activity activity, CancellationToken cancellationToken)
{
if (activity == null || activity.Attachments == null)
{
return;
}
foreach (var attachment in activity.Attachments.Where(a => a.ContentType == OAuthCard.ContentType))
{
OAuthCard oauthCard = attachment.Content as OAuthCard;
if (oauthCard != null)
{
if (string.IsNullOrWhiteSpace(oauthCard.ConnectionName))
{
throw new InvalidOperationException("The OAuthPrompt's ConnectionName property is missing a value.");
}
// Poll as a background task
Task.Run(() => PollForTokenAsync(adapter, logger, turnContext, activity, oauthCard.ConnectionName, cancellationToken))
.ContinueWith(t =>
{
if (t.Exception != null)
{
logger.LogError(t.Exception.InnerException ?? t.Exception, "PollForTokenAsync threw an exception", oauthCard.ConnectionName);
}
});
}
}
}
/**
* A shortcut to present an OAuthCard and trigger OAuth flow.
*/
private Activity CreateOAuthCard(Activity activity)
{
Activity message = activity.CreateReply();
if (message.Attachments == null)
{
message.Attachments = new List <Attachment>();
}
var card = new OAuthCard()
{
Text = "Please sign in.",
ConnectionName = "Outlook", // used to differentiate connections
Buttons = new List <CardAction> {
new CardAction(ActionTypes.Signin, "Sign-in", value: "")
} // value is ignored
};
// Create the attachment.
Attachment attachment = new Attachment()
{
ContentType = OAuthCard.ContentType,
Content = card
};
message.Attachments.Add(attachment);
return(message);
}
public void OAuthCardInitsWithNoArgs()
{
var oAuthCard = new OAuthCard();
Assert.NotNull(oAuthCard);
Assert.IsType <OAuthCard>(oAuthCard);
}
private static Activity CreateOAuthCardAttachmentActivity(string uri)
{
var oauthCard = new OAuthCard()
{
TokenExchangeResource = new TokenExchangeResource()
{
Uri = uri
}
};
var attachment = new Attachment()
{
ContentType = OAuthCard.ContentType,
Content = JObject.FromObject(oauthCard)
};
var attachmentActivity = MessageFactory.Attachment(attachment);
attachmentActivity.Conversation = new ConversationAccount()
{
Id = Guid.NewGuid().ToString()
};
attachmentActivity.From = new ChannelAccount("blah", "name");
return(attachmentActivity as Activity);
}
public static OAuthCard GetOAuthCard()
{
var oauthCard = new OAuthCard
{
Text = "BotFramework OAuth Card",
ConnectionName = "OAuth connection", // Replace with the name of your Azure AD connection.
Buttons = new List <CardAction> {
new CardAction(ActionTypes.Signin, "Sign In", value: "https://example.org/signin")
},
};
return(oauthCard);
}
public static Attachment GetOAuthCardAttachment()
{
var oauthCard = new OAuthCard
{
Text = "BotFramework Sign-in Card",
ConnectionName = "connectionName",
Buttons = new List <CardAction> {
new CardAction(ActionTypes.Signin, "Sign-in", value: "https://login.microsoftonline.com/")
},
};
var oauthAttachment = new Attachment
{
ContentType = OAuthCard.ContentType,
Content = oauthCard,
};
return(oauthAttachment);
}
public void OAuthCardToAttachmentTest()
{
var attachments = new List <Attachment>();
var oauthCard = new OAuthCard
{
Text = "Please, sign in",
ConnectionName = "testConnection",
Buttons = new List <CardAction> {
new CardAction(ActionTypes.Signin, "Login", value: "https://login.microsoftonline.com/")
},
};
attachments.Add(oauthCard.ToAttachment());
Assert.NotEmpty(attachments);
Assert.Equal("application/vnd.microsoft.card.oauth", attachments[0].ContentType);
}
public void OAuthCardInits()
{
var text = "I am an OAuthCard";
var connectionName = "myConnectionName";
var buttons = new List <CardAction>()
{
new CardAction("signin"), new CardAction("signout")
};
var tokenExchangeResource = new TokenExchangeResource("id", "http://example.com", "providerId");
var oAuthCard = new OAuthCard(text, connectionName, buttons)
{
TokenExchangeResource = tokenExchangeResource
};
Assert.NotNull(oAuthCard);
Assert.IsType <OAuthCard>(oAuthCard);
Assert.Equal(text, oAuthCard.Text);
Assert.Equal(connectionName, oAuthCard.ConnectionName);
Assert.Equal(buttons, oAuthCard.Buttons);
Assert.Equal(tokenExchangeResource, oAuthCard.TokenExchangeResource);
}
public static void SetInOAuthCard(OAuthCard card, string name, object value) => Set(card, name, value, TreeNodeType.OAuthCard);
/// <summary>
/// Creates a new attachment from <see cref="OAuthCard"/>.
/// </summary>
/// <param name="card"> The instance of <see cref="OAuthCard"/>.</param>
/// <returns> The generated attachment.</returns>
public static Attachment ToAttachment(this OAuthCard card)
{
return(CreateAttachment(card, OAuthCard.ContentType));
}
public static void SetInOAuthCard(OAuthCard card, DataIdOptions options = null) => CardTree.ApplyIds(card, options, TreeNodeType.OAuthCard);
public void TestSetInBatch()
{
const string ACTIONID = "Action ID";
const string CARDID = "Card ID";
const string CAROUSELID = "Carousel ID";
const string BATCHID = "Batch ID";
const string EXTRADATA = "Extra Data";
var jObject = new JObject();
var json = $"{{'{PropertyNames.LibraryData}': {{'{DataIdScopes.Card}': '{CARDID}',"
+ $" '{DataIdScopes.Carousel}': '{CAROUSELID}'}}}}";
var animationCard = new AnimationCard();
var audioCard = new AudioCard(buttons: new List <CardAction>
{
new CardAction(),
});
var heroCard = new HeroCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.PostBack),
});
var oAuthCard = new OAuthCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.MessageBack, value: new object()),
});
var receiptCard = new ReceiptCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.PostBack, text: "{}"),
});
var signinCard = new SigninCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.MessageBack, value: json),
});
var thumbnailCard = new ThumbnailCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.PostBack, value: "Not JSON"),
});
var videoCard = new VideoCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.MessageBack, text: "Not JSON"),
new CardAction(ActionTypes.PostBack, value: "Not JSON", text: "{}"),
new CardAction(ActionTypes.MessageBack, value: jObject, text: "{}"),
new CardAction(ActionTypes.PostBack, value: new { key = EXTRADATA }),
new CardAction(ActionTypes.ImBack, value: new JObject(), text: "{}"),
});
var adaptiveCard = new AdaptiveCard(new AdaptiveSchemaVersion(1, 2))
{
SelectAction = new AdaptiveSubmitAction(),
Body = new List <AdaptiveElement>
{
new AdaptiveActionSet
{
Actions = new List <AdaptiveAction>
{
new AdaptiveSubmitAction
{
Data = new
{
Foo = EXTRADATA,
},
},
},
},
},
Actions = new List <AdaptiveAction>
{
new AdaptiveSubmitAction
{
Data = new Dictionary <string, object>
{
{ DataIdScopes.Action, ACTIONID },
}.WrapLibraryData(),
},
new AdaptiveShowCardAction
{
Card = new AdaptiveCard(new AdaptiveSchemaVersion(1, 0))
{
SelectAction = new AdaptiveOpenUrlAction
{
UrlString = "https://adaptivecards.io/",
},
Actions = new List <AdaptiveAction>
{
new AdaptiveSubmitAction(),
new AdaptiveOpenUrlAction
{
UrlString = "https://adaptivecards.io/",
},
}
}
}
},
};
var batch = new List <IMessageActivity>
{
MessageFactory.Attachment(new List <Attachment>
{
new Attachment
{
ContentType = AdaptiveCard.ContentType,
Content = adaptiveCard,
},
animationCard.ToAttachment(),
}),
MessageFactory.Attachment(new List <Attachment>
{
audioCard.ToAttachment(),
heroCard.ToAttachment(),
new Attachment
{
ContentType = OAuthCard.ContentType,
Content = oAuthCard,
},
}),
MessageFactory.Attachment(new List <Attachment>
{
receiptCard.ToAttachment(),
signinCard.ToAttachment(),
thumbnailCard.ToAttachment(),
videoCard.ToAttachment(),
}),
};
var options = new DataIdOptions(DataId.Scopes);
options.Set(DataIdScopes.Batch, BATCHID);
DataId.SetInBatch(batch, options);
var newAdaptiveCard = (AdaptiveCard)batch[0].Attachments[0].Content;
var selectAction = (AdaptiveSubmitAction)newAdaptiveCard.SelectAction;
var data = (JObject)selectAction.Data;
var batchId = data.GetIdFromActionData(DataIdScopes.Batch);
var carouselId = data.GetIdFromActionData(DataIdScopes.Carousel);
var cardId = data.GetIdFromActionData(DataIdScopes.Card);
var actionId = data.GetIdFromActionData(DataIdScopes.Action);
var carouselIds = new HashSet <string>();
var cardIds = new HashSet <string>();
var actionIds = new HashSet <string>();
carouselIds.Add(carouselId);
cardIds.Add(cardId);
actionIds.Add(actionId);
Assert.AreNotSame(adaptiveCard, newAdaptiveCard, "New Adaptive Card reference was not assigned");
Assert.IsNotNull(batchId);
Assert.IsNotNull(carouselId);
Assert.IsNotNull(cardId);
Assert.IsNotNull(actionId);
data = (JObject)((AdaptiveSubmitAction)((AdaptiveActionSet)newAdaptiveCard.Body.Single()).Actions.Single()).Data;
actionId = data.GetIdFromActionData(DataIdScopes.Action);
// HashSet.Add returns false if the item was already in the set,
// so these IsTrue(HashSet.Add) calls are to test for uniqueness of an ID
Assert.IsTrue(
actionIds.Add(actionId),
"The action ID in the action set's submit action is the same as the action ID in the Adaptive Card's select action");
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.AreEqual(carouselId, data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.AreEqual(cardId, data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNotNull(actionId);
Assert.AreEqual(EXTRADATA, (string)data["Foo"], "The preexisting 'extra' data was modified");
data = (JObject)((AdaptiveSubmitAction)newAdaptiveCard.Actions[0]).Data;
actionId = data.GetIdFromActionData(DataIdScopes.Action);
Assert.IsTrue(actionIds.Add(actionId));
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.AreEqual(carouselId, data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.AreEqual(cardId, data.GetIdFromActionData(DataIdScopes.Card));
Assert.AreEqual(ACTIONID, actionId, "The preexisting action ID was overwritten");
data = (JObject)((AdaptiveSubmitAction)((AdaptiveShowCardAction)newAdaptiveCard.Actions[1]).Card.Actions[0]).Data;
actionId = data.GetIdFromActionData(DataIdScopes.Action);
Assert.IsTrue(actionIds.Add(actionId));
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.AreEqual(carouselId, data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.AreEqual(cardId, data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNotNull(actionId);
Assert.AreSame(animationCard, batch[0].Attachments[1].Content);
Assert.IsNull(animationCard.Buttons);
Assert.AreSame(audioCard, batch[1].Attachments[0].Content);
Assert.IsNull(audioCard.Buttons.Single().Value);
Assert.IsNull(audioCard.Buttons.Single().Text);
Assert.AreSame(heroCard, batch[1].Attachments[1].Content);
Assert.IsNull(heroCard.Buttons.Single().Value);
Assert.IsNull(heroCard.Buttons.Single().Text);
data = (JObject)oAuthCard.Buttons.Single().Value;
carouselId = data.GetIdFromActionData(DataIdScopes.Carousel);
cardId = data.GetIdFromActionData(DataIdScopes.Card);
actionId = data.GetIdFromActionData(DataIdScopes.Action);
Assert.AreSame(oAuthCard, batch[1].Attachments[2].Content);
Assert.IsNull(oAuthCard.Buttons.Single().Text);
Assert.IsTrue(carouselIds.Add(carouselId));
Assert.IsTrue(cardIds.Add(cardId));
Assert.IsTrue(actionIds.Add(actionId));
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.IsNotNull(carouselId);
Assert.IsNotNull(cardId);
Assert.IsNotNull(actionId);
data = receiptCard.Buttons.Single().Text.ToJObject(true);
carouselId = data.GetIdFromActionData(DataIdScopes.Carousel);
cardId = data.GetIdFromActionData(DataIdScopes.Card);
actionId = data.GetIdFromActionData(DataIdScopes.Action);
Assert.AreSame(receiptCard, batch[2].Attachments[0].Content);
Assert.IsNull(receiptCard.Buttons.Single().Value);
Assert.IsTrue(carouselIds.Add(carouselId));
Assert.IsTrue(cardIds.Add(cardId));
Assert.IsTrue(actionIds.Add(actionId));
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.IsNotNull(carouselId);
Assert.IsNotNull(cardId);
Assert.IsNotNull(actionId);
var valueString = (string)signinCard.Buttons.Single().Value;
data = valueString.ToJObject(true);
actionId = data.GetIdFromActionData(DataIdScopes.Action);
Assert.AreSame(signinCard, batch[2].Attachments[1].Content);
Assert.IsNull(signinCard.Buttons.Single().Text);
Assert.IsTrue(actionIds.Add(actionId));
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.AreEqual(CAROUSELID, data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.AreEqual(CARDID, data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNotNull(actionId);
valueString = (string)thumbnailCard.Buttons.Single().Value;
Assert.AreSame(thumbnailCard, batch[2].Attachments[2].Content);
Assert.IsNull(thumbnailCard.Buttons.Single().Text);
Assert.IsNull(valueString.ToJObject(true));
Assert.AreSame(videoCard, batch[2].Attachments[3].Content);
Assert.IsNull(videoCard.Buttons[0].Value);
Assert.IsNotNull(videoCard.Buttons[0].Text);
Assert.IsNull(videoCard.Buttons[0].Text.ToJObject(true));
valueString = (string)videoCard.Buttons[1].Value;
data = videoCard.Buttons[1].Text.ToJObject(true);
cardId = data.GetIdFromActionData(DataIdScopes.Card);
actionId = data.GetIdFromActionData(DataIdScopes.Action);
Assert.IsNotNull(valueString);
Assert.IsNull(valueString.ToJObject(true));
Assert.IsTrue(cardIds.Add(cardId));
Assert.IsTrue(actionIds.Add(actionId));
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.AreEqual(carouselId, data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.IsNotNull(cardId);
Assert.IsNotNull(actionId);
data = (JObject)videoCard.Buttons[2].Value;
actionId = data.GetIdFromActionData(DataIdScopes.Action);
Assert.AreSame(jObject, data);
Assert.AreEqual("{}", videoCard.Buttons[2].Text);
Assert.IsTrue(actionIds.Add(actionId));
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.AreEqual(carouselId, data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.AreEqual(cardId, data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNotNull(actionId);
data = (JObject)videoCard.Buttons[3].Value;
actionId = data.GetIdFromActionData(DataIdScopes.Action);
Assert.IsTrue(actionIds.Add(actionId));
Assert.AreEqual(batchId, data.GetIdFromActionData(DataIdScopes.Batch));
Assert.AreEqual(carouselId, data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.AreEqual(cardId, data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNotNull(actionId);
Assert.AreEqual(EXTRADATA, (string)data["key"]);
data = (JObject)videoCard.Buttons[4].Value;
Assert.AreEqual("{}", videoCard.Buttons[4].Text);
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Batch));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Action));
jObject = new AdaptiveCard("1.0")
{
Actions = new List <AdaptiveAction>
{
new AdaptiveSubmitAction
{
Data = new Dictionary <string, object>
{
{ DataIdScopes.Batch, BATCHID },
{ DataIdScopes.Action, ACTIONID },
}.WrapLibraryData(),
}
}
}.ToJObject();
batch = new List <IMessageActivity>
{
MessageFactory.Carousel(new List <Attachment>
{
new Attachment
{
ContentType = "This attachment will be ignored",
Content = new HeroCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.PostBack, value: new JObject(), text: "{}"),
}),
},
new Attachment
{
ContentType = ContentTypes.AdaptiveCard,
Content = jObject,
},
}),
MessageFactory.Attachment(new Attachment
{
ContentType = ContentTypes.AdaptiveCard,
Content = new HeroCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.MessageBack, value: new JObject(), text: "{}"),
}),
}),
};
options = new DataIdOptions(DataIdScopes.Batch, true);
options.Set(DataIdScopes.Carousel, CAROUSELID);
DataId.SetInBatch(batch, options);
heroCard = (HeroCard)batch[0].Attachments[0].Content;
data = (JObject)heroCard.Buttons.Single().Value;
Assert.AreEqual("{}", heroCard.Buttons.Single().Text);
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Batch));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Action));
data = (JObject)jObject["actions"][0]["data"];
Assert.AreSame(jObject, batch[0].Attachments[1].Content, "New Adaptive Card JObject reference was assigned");
Assert.AreNotEqual(BATCHID, data.GetIdFromActionData(DataIdScopes.Batch), "Batch ID was not generated");
Assert.AreEqual(CAROUSELID, data.GetIdFromActionData(DataIdScopes.Carousel), "Carousel ID was not applied");
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Card), "Card ID was applied");
Assert.AreEqual(ACTIONID, data.GetIdFromActionData(DataIdScopes.Action), "Action ID was generated/applied");
heroCard = (HeroCard)batch[1].Attachments.Single().Content;
data = (JObject)heroCard.Buttons.Single().Value;
Assert.AreEqual("{}", heroCard.Buttons.Single().Text);
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Batch));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Action));
// Empty options shouldn't apply any ID's
batch = new List <IMessageActivity>
{
MessageFactory.Attachment(new HeroCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.PostBack, value: new JObject()),
}).ToAttachment()),
};
DataId.SetInBatch(batch, new DataIdOptions());
heroCard = (HeroCard)batch.Single().Attachments.Single().Content;
data = (JObject)heroCard.Buttons.Single().Value;
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Batch));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Action));
// Null options should default to applying an action ID
batch = new List <IMessageActivity>
{
MessageFactory.Attachment(new HeroCard(buttons: new List <CardAction>
{
new CardAction(ActionTypes.MessageBack, value: new JObject()),
}).ToAttachment()),
};
DataId.SetInBatch(batch);
heroCard = (HeroCard)batch.Single().Attachments.Single().Content;
data = (JObject)heroCard.Buttons.Single().Value;
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Batch));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Carousel));
Assert.IsNull(data.GetIdFromActionData(DataIdScopes.Card));
Assert.IsNotNull(data.GetIdFromActionData(DataIdScopes.Action));
}
public static Attachment ToAttachment(this OAuthCard card) => CreateAttachment(card, OAuthCard.ContentType);
