forked from OfficeDev/Microsoft-Teams-Samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move samples from bot builder to Teams Samples Repository: NodeJS (Of…
…ficeDev#485) * bot-message-reaction-nodejs sample * bot-task-module-nodejs sample * msgext-action nodejs sample * bot-file-upload nodejs sample * readme fix for file upload sample * bot-initiate-thread nodejs sample * messaging extension action preview nodejs sample * bot-conversation nodejs sample * messaging extension link unfurling nodejs sample * readme fixes for msgext auth sample * readme fixes * PR fixes * broken link fixes * readme changs and image fixes * added deployment scripts * msgext-search nodejs sample * removed msgext-search sample. * added msg-ext-search sample * readme updates for samples Co-authored-by: Chetan Sharma (Tata Consultancy Services Ltd) <[email protected]>
- Loading branch information
1 parent
ed66f90
commit f9e9ecc
Showing
328 changed files
with
42,064 additions
and
392 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| MicrosoftAppType= | ||
| MicrosoftAppId= | ||
| MicrosoftAppPassword= | ||
| MicrosoftAppTenantId= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| /* eslint-disable */ | ||
| module.exports = { | ||
| "extends": "standard", | ||
| "rules": { | ||
| "semi": [2, "always"], | ||
| "indent": [2, 4], | ||
| "no-return-await": 0, | ||
| "space-before-function-paren": [2, { | ||
| "named": "never", | ||
| "anonymous": "never", | ||
| "asyncArrow": "always" | ||
| }], | ||
| "template-curly-spacing": [2, "always"] | ||
| } | ||
| }; |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+83.2 KB
samples/bot-conversation/nodejs/Images/groupChat-BotCommands-interactions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+46.4 KB
samples/bot-conversation/nodejs/Images/personal-MessageAllMembersCommand.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+45.3 KB
samples/bot-conversation/nodejs/Images/personal-WelcomeCard-Interaction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+40.7 KB
samples/bot-conversation/nodejs/Images/personal-WelcomeCommand-Card.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+64.7 KB
samples/bot-conversation/nodejs/Images/team-MentionCommand-Interaction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+81.3 KB
samples/bot-conversation/nodejs/Images/team-MessageAllMembers-interaction.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| --- | ||
| page_type: sample | ||
| description: This sample showcases usage of various conversation events for teams bot for both personal and teams scope. | ||
| products: | ||
| - office-teams | ||
| - office | ||
| - office-365 | ||
| languages: | ||
| - nodejs | ||
| extensions: | ||
| contentType: samples | ||
| createdDate: "10-04-2022 20:15:25" | ||
| urlFragment: officedev-microsoft-teams-samples-bot-conversation-nodejs | ||
| --- | ||
|
|
||
| # Teams Conversation Bot | ||
|
|
||
| Bot Framework v4 Conversation Bot sample for Teams. | ||
|
|
||
| This bot has been created using [Bot Framework](https://dev.botframework.com). This sample shows | ||
| how to incorporate basic conversational flow into a Teams application. It also illustrates a few of the Teams specific calls you can make from your bot. | ||
|
|
||
| - **Interaction with bot** | ||
|
|
||
|  | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Microsoft Teams is installed and you have an account | ||
| - [NodeJS](https://nodejs.org/en/) | ||
| - [ngrok](https://ngrok.com/) or equivalent tunnelling solution | ||
|
|
||
| ## Setup | ||
|
|
||
| > Note these instructions are for running the sample on your local machine, the tunnelling solution is required because | ||
| the Teams service needs to call into the bot. | ||
|
|
||
| 1) Run ngrok - point to port 3978 | ||
|
|
||
| ```bash | ||
| ngrok http --host-header=rewrite 3978 | ||
| ``` | ||
|
|
||
| ## Setup for bot | ||
| In Azure portal, create a [Azure Bot resource](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-quickstart-registration). | ||
| - For bot handle, make up a name. | ||
| - Select "Use existing app registration" (Create the app registration in Azure Active Directory beforehand.) | ||
| - __*If you don't have an Azure account*__ create an [Azure free account here](https://azure.microsoft.com/en-us/free/) | ||
| In the new Azure Bot resource in the Portal, | ||
| - Ensure that you've [enabled the Teams Channel](https://learn.microsoft.com/en-us/azure/bot-service/channel-connect-teams?view=azure-bot-service-4.0) | ||
| - In Settings/Configuration/Messaging endpoint, enter the current `https` URL you were given by running ngrok. Append with the path `/api/messages` | ||
|
|
||
| ## Setup for code | ||
| 1) Clone the repository | ||
|
|
||
| ```bash | ||
| git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git | ||
| ``` | ||
|
|
||
| 1) In a terminal, navigate to `samples/bot-conversation/nodejs` | ||
|
|
||
| 1) Install modules | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| 1) Update the `.env` configuration for the bot to use the Microsoft App Id and App Password from the Bot Framework registration. (Note the App Password is referred to as the "client secret" in the azure portal and you can always create a new client secret anytime.) `MicrosoftAppTenantId` will be the id for the tenant where application is registered. | ||
| - Also, set MicrosoftAppType in the `.env`. (**Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI**) | ||
|
|
||
| 1) Run your bot at the command line: | ||
|
|
||
| ```bash | ||
| npm start | ||
| ``` | ||
|
|
||
| 1) __*This step is specific to Teams.*__ | ||
| - **Edit** the `manifest.json` contained in the `appPackage` folder to replace your Microsoft App Id (that was created when you registered your bot earlier) *everywhere* you see the place holder string `<<YOUR-MICROSOFT-APP-ID>>` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`) | ||
| - **Edit** the `manifest.json` for `validDomains` with base Url domain. E.g. if you are using ngrok it would be `https://1234.ngrok.io` then your domain-name will be `1234.ngrok.io`. | ||
| - **Zip** up the contents of the `appPackage` folder to create a `manifest.zip` (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package) | ||
| - **Upload** the `manifest.zip` to Teams (In Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.) | ||
| - Add the app to personal/team/groupChat scope (Supported scopes) | ||
| ## Running the sample | ||
| You can interact with this bot in Teams by sending it a message, or selecting a command from the command list. The bot will respond to the following strings. | ||
| 1. **Show Welcome** | ||
| - **Result:** The bot will send the welcome card for you to interact with | ||
| - **Valid Scopes:** personal, group chat, team chat | ||
| - **Personal Scope Interactions:** | ||
| **Adding bot UI:** | ||
|  | ||
| **Added bot UI:** | ||
|  | ||
| **Show Welcome command interaction:** | ||
|  | ||
| - **Group Chat Scope Interactions:** | ||
| **Adding bot UI:** | ||
|  | ||
| **Added bot UI:** | ||
|  | ||
| **Show Welcome command interaction:** | ||
|  | ||
| - **Team Scope Interactions:** | ||
| **Adding bot UI:** | ||
|  | ||
| **Added bot UI:** | ||
|  | ||
| **Show Welcome command interaction:** | ||
|  | ||
| 2. **MentionMe** | ||
| - **Result:** The bot will respond to the message and mention the user | ||
| - **Valid Scopes:** personal, group chat, team chat | ||
| - **Personal Scope Interactions:** | ||
| **MentionMe command interaction:** | ||
|  | ||
| - **Group Chat Scope Interactions:** | ||
| **MentionMe command interaction:** | ||
|  | ||
| - **Team Scope Interactions:** | ||
| **MentionMe command interaction:** | ||
|  | ||
| 3. **MessageAllMembers** | ||
| - **Result:** The bot will send a 1-on-1 message to each member in the current conversation (aka on the conversation's roster). | ||
| - **Valid Scopes:** personal, group chat, team chat | ||
| - **Personal Scope Interactions:** | ||
| **MessageAllMembers command interaction:** | ||
|  | ||
| - **Group Chat Scope Interactions:** | ||
| **MessageAllMembers command interaction:** | ||
|  | ||
| - **Team Scope Interactions:** | ||
| **MessageAllMembers command interaction:** | ||
|  | ||
| You can select an option from the command list by typing ```@TeamsConversationBot``` into the compose message area and ```What can I do?``` text above the compose area. | ||
| ## Deploy the bot to Azure | ||
| To learn more about deploying a bot to Azure, see [Deploy your bot to Azure](https://aka.ms/azuredeployment) for a complete list of deployment instructions. | ||
| ## Further reading | ||
| - [How Microsoft Teams bots work](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-basics-teams?view=azure-bot-service-4.0&tabs=javascript) |
File renamed without changes
Oops, something went wrong.