Skip to content

Commit

Permalink
Changed readme and sample folders to have app-manifest name (OfficeDe…
Browse files Browse the repository at this point in the history
…v#935)

* added changes for manifest files

* added manifest and readme changes

* added more samples for manifest changes

* added meeting samples

* added changes for messaging extension sample

* added changes for tab samples

* updated root readme

* Update README.md

* added manifest name changes

* feedback changes

* feedback changes

* added feedback changes

* added build pipeline fixes

---------

Co-authored-by: ChetanSharma-MSFT <[email protected]>
  • Loading branch information
Prithvi-MSFT and ChetanSharma-msft authored Sep 20, 2023
1 parent 72427f3 commit 8d3d6f3
Show file tree
Hide file tree
Showing 480 changed files with 335 additions and 346 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# Sample lists

1. [Ready to try sample manifests](#try-it-yourself---experience-the-apps-in-your-microsoft-teams-client)
1. [Ready to try sample app manifests](#try-it-yourself---experience-the-apps-in-your-microsoft-teams-client)
1. [Teams Toolkit samples](#samples-built-using-new-generation-of-teams-development-tool---teams-toolkit)
1. [Getting Started Samples and Tutorials](#getting-started---samples-and-tutorials)
1. [Tabs samples](#Tabs-samples)
Expand All @@ -24,12 +24,12 @@ The [Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDev

## [Getting Started - Samples and Tutorials](https://docs.microsoft.com/microsoftteams/platform/tutorials/get-started-dotnet-app-studio)

| | Sample Name | Description | C# | TypeScript | Manifest
| | Sample Name | Description | C# | TypeScript | App Manifest
|:--:|:-------------------|:---------------------------------------------------------------------------------------------------------------------------|:--------|:-------------|:-------------|
|1|Hello World | Microsoft Teams hello world sample app. |[View][app-hello-world#cs] |[View][app-hello-world#ts] ![toolkit-icon](assets/toolkit-icon.png) |[View](/samples/app-hello-world/csharp/demo-manifest/app-hello-world.zip)

## [Tabs samples](https://docs.microsoft.com/microsoftteams/platform/tabs/what-are-tabs)
| | Sample Name | Description | C# | TypeScript | JavaScript | Manifest|
| | Sample Name | Description | C# | TypeScript | JavaScript | App Manifest|
|:--:|:-------------------|:----------------------------------------------------------------------------------------------|:--------|:-------------|:---------|:--------|
|1|Personal tabs | Sample app showing custom personal Tab with ASP. NET Core |[MVC][personal-tab#cs#mvc], [Razor][personal-tab#cs#razor] | [Yeoman Generator](https://docs.microsoft.com/microsoftteams/platform/tabs/quickstarts/create-personal-tab-node-yeoman#generate-your-project) | |[View](/samples/tab-personal/mvc-csharp/demo-manifest/tab-personal.zip) |
|2|Personal tab quick-start| Sample personal tab quick-start app. | |[View][personal-tab-quickstart#ts] ![toolkit-icon](assets/toolkit-icon.png) |[View][personal-tab-quickstart#js] ![toolkit-icon](assets/toolkit-icon.png)
Expand Down Expand Up @@ -59,7 +59,7 @@ The [Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDev
>NOTE:
>Visit the [Bot Framework Samples repository][botframework] to view Microsoft Bot Framework v4 SDK task-focused samples for C#, JavaScript, TypeScript, and Python.
| | Sample Name | Description | .NET | JavaScript | Python | Java | Manifest
| | Sample Name | Description | .NET | JavaScript | Python | Java | App Manifest
|:--:|:-------------------|:---------------------------------------------------------------------------------|:--------|:-------------|:-------------|:-------------|:-------------|
|1| Teams Conversation Bot quick-start | Messaging and conversation event handling hello world. | | [View][bot-conversation-quickstart#js] ![toolkit-icon](assets/toolkit-icon.png) | | |
|2| Teams Conversation Bot SSO quick-start | Messaging and conversation event handling hello world with SSO. | [View][bot-conversation-sso-quickstart#csharp_dotnetcore] | [View][bot-conversation-sso-quickstart#js] ![toolkit-icon](assets/toolkit-icon.png) | | |
Expand Down Expand Up @@ -96,7 +96,7 @@ The [Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDev
>NOTE:
>Visit the [Bot Framework Samples repository][botframework] to view Microsoft Bot Framework v4 SDK task-focused samples for C#, JavaScript, TypeScript, and Python.
| | Sample Name | Description | .NET | JavaScript | Python| Java | Manifest|
| | Sample Name | Description | .NET | JavaScript | Python| Java | App Manifest|
|:--:|:-------------------|:---------------------------------------------------------------------------------|:--------|:-------------|:-------------|:-------------|:-------------
|1|Messaging extensions - search quick-start | Hello world Messaging Extension that accepts search requests and returns results. | | [View][msgext-search-quickstart#js] ![toolkit-icon](assets/toolkit-icon.png) | ||[View](/samples/msgext-search-quickstart/js/demo-manifest/msgext-search-quickstart.zip)
|2|Messaging extensions - search | Messaging Extension that accepts search requests and returns results. | [View][msgext-search#cs] | [View][msgext-search#js] ![toolkit-icon](assets/toolkit-icon.png) | [View][msgext-search#python] | [View][msgext-search#java]|[View](/samples/msgext-search/csharp/demo-manifest/msgext-search.zip)
Expand Down Expand Up @@ -128,7 +128,7 @@ The [Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDev

## [Graph APIs](https://docs.microsoft.com/graph/teams-concept-overview)

| | Sample Name | Description | C# | JavaScript | Manifest
| | Sample Name | Description | C# | JavaScript | App Manifest
|:--:|:-------------------|:-------------------------------------------------------------------------------------------------|:--------|:-------------|:-------------|
|1|Resource Specific Consent (RSC) | This sample illustrates how you can use [Resource Specific Consent (RSC)](https://docs.microsoft.com/en-us/microsoftteams/platform/graph-api/rsc/resource-specific-consent) to call Graph APIs. . |[View][graph#rsc#cs] | [View][graph#rsc#js] ![toolkit-icon](assets/toolkit-icon.png) |[View](/samples/graph-rsc/csharp/demo-manifest/graph-rsc.zip)
|2|Graph API Channel Life Cycle | This sample illustrates how you can use [Graph API Channel Life Cycle](https://docs.microsoft.com/en-us/graph/api/resources/channel?view=graph-rest-beta) to call Graph APIs. . |[View][graph#lifecycle#cs] | [View][graph#lifecycle#js] ![toolkit-icon](assets/toolkit-icon.png)
Expand Down Expand Up @@ -156,7 +156,7 @@ The [Teams Toolkit](https://marketplace.visualstudio.com/items?itemName=TeamsDev

## Scenario specific samples

| | Sample Name | Description | C# | JavaScript |Manifest|
| | Sample Name | Description | C# | JavaScript |App Manifest|
|:--:|:---------------|:---------------------------------------------------------------------------------|:------|:----------------|:-------|
|1|Task Modules | Sample app showing off the Teams Task Module, a way to invoke custom code from a bot, a tab, or both! |[View][bot-task-module#cs] |[View][app-task-module#ts]|[View](/samples/bot-task-module/csharp/demo-manifest/bot-task-module.zip)
|2|Authentication | Sample illustrating seamless inline authentication for Microsoft Teams apps. | | [View][app-auth#ts]
Expand Down
2 changes: 1 addition & 1 deletion samples/account-linking/csharp/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ ecf/
rcf/

# Windows Store app package directories and files
AppPackages/
AppManifest/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
Expand Down
6 changes: 3 additions & 3 deletions samples/account-linking/csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ For this example, we'll use the `590a2d6f8b31.ngrok-free.app` as our domain name
Please follow the instructions on [creating an Azure AD application with Tab SSO](https://docs.microsoft.com/en-us/microsoftteams/platform/tabs/how-to/authentication/auth-aad-sso?tabs=dotnet#1-create-your-azure-ad-application). The fully qualified domain name will be the ngrok url from before.

#### 2.1 Configure the app for v2 tokens
**IMPORTANT** Please ensure the `accessTokenAcceptedVersion` in the `Manifest` blade is set to `2`.
**IMPORTANT** Please ensure the `accessTokenAcceptedVersion` in the `AppManifest` blade is set to `2`.


Please save for a future step
Expand All @@ -101,7 +101,7 @@ Please save
2. A `client secret`

### 5. Filling in the Manifest file
Please fill in the following values into the `Manifest/Manifest.json` file (called out using the `{{ }}` fences)
Please fill in the following values into the `AppManifest/manifest.json` file (called out using the `{{ }}` fences)

| Parameter | Value |
|---|---|
Expand Down Expand Up @@ -140,7 +140,7 @@ dotnet run
### 9. Installing the app
Please follow the documentation on [creating a Microsoft Teams app package](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/build-and-test/apps-package) and [sideloading your app in Teams](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/build-and-test/apps-package).

The "manifest" in question is the `Manifest` directory filled out in step 5.
The "manifest" in question is the `AppManifest` directory filled out in step 5.

### 10. (Optional) Enable the Azure Ad version of the integration
If you want to try out the implementation using Azure you will need to provision a few resources first
Expand Down
4 changes: 2 additions & 2 deletions samples/app-anonymous-users/csharp/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,11 +144,11 @@ This sample shows anonymous users support in meeting apps.
7. __*This step is specific to Teams.*__
- **Edit** the `manifest.json` contained in the `TeamsAppManifest` folder to replace your Microsoft App Id `<<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` contained in the `AppManifest` folder to replace your Microsoft App Id `<<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 `{{domain-name}}` with base Url domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **Zip** up the contents of the `TeamsAppManifest` 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)
- **Zip** up the contents of the `AppManifest` 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.)
Expand Down
10 changes: 5 additions & 5 deletions samples/app-auth/nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,11 +66,11 @@ This sample demonstrates authentication in Microsoft Teams using bot and tab.
> **IMPORTANT**: Do not use the legacy Bot Framework portal, nor App Studio, to create the bot. Your bot MUST be registered with
> Azure Bot Service to use the authentication functionality provided by Azure Bot Service.
4. Create an app manifest. Navigate to the file, manifest/manifest.json - Change:
4. Create an app manifest. Navigate to the file, appManifest/manifest.json - Change:
1. <<REGISTERED_BOT_ID>> (there are 3) change to your registered bot's app ID
2. <<BASE_URI_DOMAIN>> (there are 5) change to your https endpoint from tunnel excluding the "https://" part
**Note:** If you want to test your app across multi hub like: Outlook/Office.com, please update the `manifest.json` in the `app-auth\nodejs\Manifest_Hub` folder with the required values.
3. Zip up the contents of the `manifest` folder to create a `manifest.zip` or `Manifest_Hub` folder into a `Manifest_Hub.zip`. (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
2. <<BASE_URI_DOMAIN>> (there are 5) change to your https endpoint from ngrok excluding the "https://" part
**Note:** If you want to test your app across multi hub like: Outlook/Office.com, please update the `manifest.json` in the `app-auth\nodejs\appManifestHub` folder with the required values.
3. Zip up the contents of the `appManifest` folder to create a `manifest.zip` or `appManifestHub` folder into a `appManifestHub.zip`. (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
## Setup
Expand Down Expand Up @@ -136,7 +136,7 @@ Registering a bot with the Microsoft Bot Framework automatically creates a corre
### Update your Microsoft Teams application manifest
15. Add new properties to your Microsoft Teams manifest:
15. Add new properties to your Microsoft Teams app manifest:
- **WebApplicationInfo** - The parent of the following elements.
- **Id** - The client ID of the application. This is an application ID that you obtain as part of registering the application with Azure AD 1.0 endpoint.
Expand Down
File renamed without changes
2 changes: 1 addition & 1 deletion samples/app-auth/nodejs/gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ gulp.task('rebuild', gulp.series('clean', gulp.parallel('ts:lint', 'ts', 'static
* Build manifest
*/
gulp.task('generate-manifest', function() {
gulp.src(['./manifest/*.png', 'manifest/manifest.json'])
gulp.src(['./appManifest/*.png', 'appManifest/manifest.json'])
.pipe(zip('AuthBot.zip'))
.pipe(gulp.dest('manifest'));
});
Expand Down
6 changes: 3 additions & 3 deletions samples/app-checkin-location/csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,14 +100,14 @@ Please find below demo manifest which is deployed on Microsoft Azure and you can
4) Setup Manifest for Teams
- __*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 app registration earlier) *everywhere* you see the place holder string `{{Microsoft-App-Id}}` (depending on the scenario the Microsoft App Id may occur multiple times in the `manifest.json`)
- **Edit** the `manifest.json` contained in the ./AppManifest folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) *everywhere* you see the place holder string `{{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` and replace `{{domain-name}}` with base Url of your domain. E.g. if you are using ngrok it would be `https://1234.ngrok-free.app` then your domain-name will be `1234.ngrok-free.app` and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.
- **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)
- **Zip** up the contents of the `AppManifest` 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 the Apps view click "Upload a custom app")
- Go to Microsoft Teams. From the lower left corner, select Apps
- From the lower left corner, choose Upload a custom App
- Go to your project directory, the ./AppPackage folder, select the zip folder, and choose Open.
- Go to your project directory, the ./AppManifest folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.
## Running the sample
Expand Down
6 changes: 3 additions & 3 deletions samples/app-complete-auth/csharp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,9 @@ Please find below demo manifest which is deployed on Microsoft Azure and you can
- `{{Microsoft-App-Id}}` with Application id generated from Step 3
- `{Base_URL_Domain}` - Your application's base url domain. E.g. for https://12345.ngrok-free.app the base url domain will be 12345.ngrok-free.app if you are using ngrok and if you are using dev tunnels then your domain will be like: `12345.devtunnels.ms`.

**Note:** If you want to test your app across multi hub like: Outlook/Office.com, please update the `manifest.json` in the `app-complete-auth\csharp\AppCompleteAuth\Manifest_Hub` folder with the required values.
**Note:** If you want to test your app across multi hub like: Outlook/Office.com, please update the `manifest.json` in the `app-complete-auth\csharp\AppCompleteAuth\AppManifest_Hub` folder with the required values.

2. Zip up the contents of the `AppManifest` folder to create a `manifest.zip` or `Manifest_Hub` folder into a `Manifest_Hub.zip`. (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
2. Zip up the contents of the `AppManifest` folder to create a `manifest.zip` or `AppManifest_Hub` folder into a `AppManifest_Hub.zip`. (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)

3. Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")
- Go to Microsoft Teams and then go to side panel, select Apps
Expand Down Expand Up @@ -307,4 +307,4 @@ To learn more about deploying a bot to Azure, see [Deploy your bot to Azure](htt
- [Create facebook app for development](https://developers.facebook.com/docs/development/create-an-app/)


<img src="https://pnptelemetry.azurewebsites.net/microsoft-teams-samples/samples/app-complete-auth-csharp" />
<img src="https://pnptelemetry.azurewebsites.net/microsoft-teams-samples/samples/app-complete-auth-csharp" />
2 changes: 1 addition & 1 deletion samples/app-complete-sample/csharp/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ ecf/
rcf/

# Windows Store app package directories and files
AppPackages/
AppManifest/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
Expand Down
Loading

0 comments on commit 8d3d6f3

Please sign in to comment.