@microsoft/teams-js 2.10.0-beta.1 → 2.10.0-beta.3

package/README.md

@@ -8,7 +8,7 @@ This JavaScript library is part of the [Microsoft Teams developer platform](http
 
 See [instructions](../../README.md#Getting-Started) in the monorepo root for how to clone and build the repository.
 
-Whenever building or testing the Teams client library, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
+Whenever building or testing the Teams client library, you can run `pnpm build` or `pnpm test` from the packages/teams-js directory.
 
 ## Installation
 
@@ -18,9 +18,9 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 `npm install --save @microsoft/teams-js`
 
-### yarn
+### pnpm
 
-`yarn add @microsoft/teams-js`
+`pnpm add @microsoft/teams-js`
 
 ### Production
 
@@ -30,7 +30,7 @@ You can reference these files directly [from here](https://res.cdn.office.net/te
 
 ### As a package
 
-Install either using npm or yarn.
+Install either using npm or pnpm.
 
 **If you are using any dependency loader** such as [RequireJS](http://requirejs.org/) or [SystemJS](https://github.com/systemjs/systemjs) or module bundler such as [browserify](http://browserify.org/), [webpack](https://webpack.github.io/), you can use `import` syntax to import specific modules. For e.g.
 

package/dist/MicrosoftTeams.d.ts

@@ -3738,11 +3738,11 @@ export namespace app {
             */
         interface AppHostInfo {
                 /**
-                    * The name of the host client. Possible values are: Office, Orange, Outlook, Teams
+                    * Identifies which host is running your app
                     */
                 name: HostName;
                 /**
-                    * The type of the host client. Possible values are : android, ios, web, desktop, rigel
+                    * The client type on which the host is running
                     */
                 clientType: HostClientType;
                 /**
@@ -3898,7 +3898,7 @@ export namespace app {
                 isPSTNCallingAllowed?: boolean;
                 /**
                     * The license type for the current user. Possible values are:
-                    * "Unknown", "Teacher", "Student", "Free", "SmbBusinessVoice", "SmbNonVoice", "FrontlineWorker"
+                    * "Unknown", "Teacher", "Student", "Free", "SmbBusinessVoice", "SmbNonVoice", "FrontlineWorker", "Anonymous"
                     */
                 licenseType?: string;
                 /**
@@ -6382,24 +6382,54 @@ export namespace mail {
                 Forward = "forward"
         }
         /**
-            * Base of a discriminated union between compose scenarios.
+            * Foundational interface for all other mail compose interfaces
+            * Used for holding the type of mail item being composed
+            *
+            * @see {@link ComposeMailType}
             */
         interface ComposeMailBase<T extends ComposeMailType> {
                 type: T;
         }
         /**
-            * Interfaces for each type.
+            * Parameters supplied when composing a new mail item
             */
         export interface ComposeNewParams extends ComposeMailBase<ComposeMailType.New> {
+                /**
+                    * The To: recipients for the message
+                    */
                 toRecipients?: string[];
+                /**
+                    * The Cc: recipients for the message
+                    */
                 ccRecipients?: string[];
+                /**
+                    * The Bcc: recipients for the message
+                    */
                 bccRecipients?: string[];
+                /**
+                    * The subject of the message
+                    */
                 subject?: string;
+                /**
+                    * The body of the message
+                    */
                 message?: string;
         }
+        /**
+            * Parameters supplied when composing a reply to or forward of a message
+            *
+            * @see {@link ComposeMailType}
+            */
         export interface ComposeReplyOrForwardParams<T extends ComposeMailType> extends ComposeMailBase<T> {
                 itemid: string;
         }
+        /**
+            * Parameters supplied to {@link composeMail} when composing a new mail item
+            *
+            * @see {@link ComposeNewParams}
+            * @see {@link ComposeReplyOrForwardParams}
+            * @see {@link ComposeMailType}
+            */
         export type ComposeMailParams = ComposeNewParams | ComposeReplyOrForwardParams<ComposeMailType.Reply> | ComposeReplyOrForwardParams<ComposeMailType.ReplyAll> | ComposeReplyOrForwardParams<ComposeMailType.Forward>;
         export {};
 }
@@ -6738,11 +6768,11 @@ export namespace video {
                 /**
                     * Current video effect changed
                     */
-                EffectChanged = 0,
+                EffectChanged = "EffectChanged",
                 /**
                     * Disable the video effect
                     */
-                EffectDisabled = 1
+                EffectDisabled = "EffectDisabled"
         }
         /**
             * Video frame call back function definition