Teams mobile doc improvements #2154
Conversation
Includes a few formatting fixes and some informational links for APIs.
|
Thanks for helping update these docs! |
| @@ -814,6 +814,10 @@ export namespace app { | |||
|
|
|||
| /** | |||
| * Notifies the frame that app has loaded and to hide the loading indicator if one is shown. | |||
| * | |||
| * @remarks | |||
| * For information about mobile behavior, see the [Content pages](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/create-tab-pages/content-page?tabs=teamsjs-v2#show-a-native-loading-indicator) article. | |||
There was a problem hiding this comment.
What should we expect developers to see when they go to that URL? Here is where I think I would be confused: is that page telling me that... I shouldn't call methods like notifyAppLoaded() when I'm on mobile?
I think the answer is "No, your app should always call these methods and you don't need to write special code, but just know that the loading indicator behavior may be different on mobile." Is that correct? If so it's not totally clear from these comments or that doc page.
| @@ -814,6 +814,10 @@ export namespace app { | |||
|
|
|||
| /** | |||
| * Notifies the frame that app has loaded and to hide the loading indicator if one is shown. | |||
| * | |||
| * @remarks | |||
There was a problem hiding this comment.
Should these remarks be specifically on the notifyAppLoaded method like this? It seems like the documentation is generally about how loading indicator is handled and not specific to this one function.
| * @returns true if the user has granted the app permission to media information, false otherwise | ||
| * @remarks | ||
| * For additional information about deivce permissions, see the Learn articles: | ||
| * - [Integrate QR or barcode scanner capability](https://learn.microsoft.com/microsoftteams/platform/concepts/device-capabilities/qr-barcode-scanner-capability) |
There was a problem hiding this comment.
Following this link takes me to a page which provides great information about barcode scanning -- but that page then links to a function in the older (1.x) version of teamsjs and a different capability than this one (it links to media) -- is it weird that this capability and function links to docs that don't mention this function at all?
| @@ -63,7 +63,12 @@ export namespace barCode { | |||
| /** | |||
| * Checks whether or not media has user permission | |||
| * | |||
| * @returns true if the user has granted the app permission to media information, false otherwise | |||
| * @remarks | |||
| * For additional information about deivce permissions, see the Learn articles: | |||
There was a problem hiding this comment.
Would it be more appropriate if this documentation was on the barCode namespace rather than each function in it? Since the documentation is an overview of the functionality and not specific to each function?
| * - [Integrate QR or barcode scanner capability](https://learn.microsoft.com/microsoftteams/platform/concepts/device-capabilities/qr-barcode-scanner-capability) | ||
| * - [Request device permissions for your Teams app](https://learn.microsoft.com/microsoftteams/platform/concepts/device-capabilities/native-device-permissions?tabs=mobile%2Cteamsjs-v2%2Cmobile1#specify-permissions) | ||
| * | ||
| * @returns `true` if the user has granted the app permission to media information, `false` otherwise. The **media** permission refers to both camera and gallery. |
There was a problem hiding this comment.
| @@ -756,6 +756,9 @@ export namespace media { | |||
| /** | |||
| * Select an attachment using camera/gallery | |||
| * | |||
| * @remarks | |||
| @@ -0,0 +1,7 @@ | |||
| { | |||
| "type": "patch", | |||
There was a problem hiding this comment.
This should be type "none" since the docs only changes won't affect the behavior of the library at all.
Description
Documentation update to add links for Teams mobile clarifications
Main changes in the PR:
Validation
n/a
Unit Tests added:
No
End-to-end tests added:
No
Additional Requirements
Change file added:
Yes