Draft of article to explain app initialization #12537
Conversation
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 0ea233a:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| msteams-platform/tabs/how-to/app-initialization-process.md | View | Details | |
| msteams-platform/assets/images/tabs/app-initialization-immediate-flow.png | ✅Succeeded | View | |
| msteams-platform/assets/images/tabs/app-initialization-loading-indicator-flow.png | ✅Succeeded | View | |
| msteams-platform/TOC.yml | ✅Succeeded | View |
msteams-platform/tabs/how-to/app-initialization-process.md
- Line 4, Column 9: [Warning: author-not-found - See documentation]
Invalid value for author: 'mosdevdocs' is not a valid GitHub ID. - Line 30, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/javascript/api/@microsoft/teams-js/app#@microsoft-teams-js-app-notifyexpectedfailure' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 30, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/javascript/api/@microsoft/teams-js/app#@microsoft-teams-js-app-notifyexpectedfailure' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 55f7170:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| msteams-platform/tabs/how-to/app-initialization-process.md | View | Details | |
| msteams-platform/assets/images/tabs/app-initialization-immediate-flow.png | ✅Succeeded | View | |
| msteams-platform/assets/images/tabs/app-initialization-loading-indicator-flow.png | ✅Succeeded | View | |
| msteams-platform/TOC.yml | ✅Succeeded | View |
msteams-platform/tabs/how-to/app-initialization-process.md
- Line 4, Column 9: [Warning: author-not-found - See documentation]
Invalid value for author: 'mosdevdocs' is not a valid GitHub ID. - Line 30, Column 3: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/javascript/api/@microsoft/teams-js/app#@microsoft-teams-js-app-notifyexpectedfailure' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 30, Column 3: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/javascript/api/@microsoft/teams-js/app#@microsoft-teams-js-app-notifyexpectedfailure' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit c6e78a0: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
|
||
| :::image type="content" source="../../assets/images/tabs/app-initialization-loading-indicator-flow.png" alt-text="State diagram showing the initialization flow for an app that requires a loading indicator."::: | ||
|
|
||
| For apps that need time to load the most common path is to call `app.initialize()` and then either `app.notifySuccess()` or `app.notifyExpectedFailure()` to complete loading. That said, an app can alternately call `app.notifyAppLoaded()` after `app.initialize()` to remove the spinner while still loading. |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
|
||
| :::image type="content" source="../../assets/images/tabs/app-initialization-immediate-flow.png" alt-text="State diagram showing the initialization flow for an app that loads immediately."::: | ||
|
|
||
| For apps that don't require time for loading the process is straight forward, the app calls `app.initialize()` and is fully loaded. |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 51a58d7: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit dbc0f56:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| msteams-platform/tabs/how-to/app-initialization-process.md | View | Details | |
| msteams-platform/assets/images/tabs/app-initialization-immediate-flow.png | ✅Succeeded | View | |
| msteams-platform/assets/images/tabs/app-initialization-loading-indicator-flow.png | ✅Succeeded | View | |
| msteams-platform/tabs/how-to/app-caching.md | ✅Succeeded | View | |
| msteams-platform/tabs/how-to/create-tab-pages/content-page.md | ✅Succeeded | View | |
| msteams-platform/TOC.yml | ✅Succeeded | View |
msteams-platform/tabs/how-to/app-initialization-process.md
- Line 95, Column 3: [Warning: file-not-found - See documentation]
Invalid file link: 'create-tab-pages/content-page'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 36f95f3: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
|
||
| The following state diagram shows the behavior of an app that is intended to load with a loading indicator. Unlike an app that loads immediately after `app.initialize()`, apps that use the loading indicator must call other APIs to inform the system of the apps progress. | ||
|
|
||
| :::image type="content" source="../../assets/images/tabs/app-initialization-loading-indicator-flow.png" alt-text="State diagram showing the initialization flow for an app that requires a loading indicator."::: |
There was a problem hiding this comment.
If we're only talking about the flow of Uninitialized -> Loading ->(Loading w/o spinner) -> Loaded, what about the rest of the diagram such as Error state, etc.? This can be confusing to developers due to the mismatch between our explaining text and the diagram. Same for "immeidate app" flow above.
I don't have a good answer for now. Just calling it out for thoughts.
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit faf219d: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 044f744: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 20bbc16: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 135058e: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Co-authored-by: v-hsrilata <[email protected]>
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
Thanks for your review, your comment should be addressed in latest build. |
|
Learn Build status updates of commit e318722: ✅ Validation status: passed
For more details, please refer to the build report. |
Co-authored-by: v-hsrilata <[email protected]>
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
|
Learn Build status updates of commit 695d25d: 💡 Validation status: suggestions
msteams-platform/tabs/how-to/app-initialization-process.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
|
Learn Build status updates of commit d9ac9db: 💡 Validation status: suggestions
msteams-platform/tabs/how-to/app-initialization-process.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
Article is still being authored, staging for review.
#do-not-merge