@microsoft/teams-js 2.2.0-beta.0 → 2.3.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +11 -11
- package/README.md +74 -74
- package/dist/MicrosoftTeams.d.ts +809 -163
- package/dist/MicrosoftTeams.js +702 -248
- package/dist/MicrosoftTeams.js.map +1 -1
- package/dist/MicrosoftTeams.min.js +1 -1
- package/dist/MicrosoftTeams.min.js.map +1 -1
- package/package.json +1 -1
package/LICENSE
CHANGED
@@ -1,12 +1,12 @@
|
|
1
|
-
Microsoft Teams JS Library
|
2
|
-
|
3
|
-
Copyright (c) Microsoft Corporation
|
4
|
-
All rights reserved.
|
5
|
-
|
6
|
-
MIT License
|
7
|
-
|
8
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
9
|
-
|
10
|
-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
11
|
-
|
1
|
+
Microsoft Teams JS Library
|
2
|
+
|
3
|
+
Copyright (c) Microsoft Corporation
|
4
|
+
All rights reserved.
|
5
|
+
|
6
|
+
MIT License
|
7
|
+
|
8
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
9
|
+
|
10
|
+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
11
|
+
|
12
12
|
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
@@ -1,74 +1,74 @@
|
|
1
|
-
# Microsoft Teams JavaScript client SDK
|
2
|
-
|
3
|
-
Welcome to the Teams JavaScript client SDK! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
|
4
|
-
|
5
|
-
This JavaScript library is part of the [Microsoft Teams developer platform](https://docs.microsoft.com/en-us/microsoftteams/platform/). See full [SDK reference documentation](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
|
6
|
-
|
7
|
-
## Getting Started
|
8
|
-
|
9
|
-
See [instructions](../../README.md#Getting-Started) in the monorepo root for how to clone and build the repository.
|
10
|
-
|
11
|
-
Whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
|
12
|
-
|
13
|
-
## Installation
|
14
|
-
|
15
|
-
To install the stable [version](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest):
|
16
|
-
|
17
|
-
### npm
|
18
|
-
|
19
|
-
`npm install --save @microsoft/teams-js`
|
20
|
-
|
21
|
-
### yarn
|
22
|
-
|
23
|
-
`yarn add @microsoft/teams-js`
|
24
|
-
|
25
|
-
### Production
|
26
|
-
|
27
|
-
You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.
|
28
|
-
|
29
|
-
## Usage
|
30
|
-
|
31
|
-
### As a package
|
32
|
-
|
33
|
-
Install either using npm or yarn.
|
34
|
-
|
35
|
-
**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.
|
36
|
-
|
37
|
-
```typescript
|
38
|
-
import { app } from '@microsoft/teams-js';
|
39
|
-
```
|
40
|
-
|
41
|
-
### As a script tag
|
42
|
-
|
43
|
-
Reference the SDK inside of your `.html` page using:
|
44
|
-
|
45
|
-
```html
|
46
|
-
<!-- Microsoft Teams JavaScript API (via CDN) -->
|
47
|
-
<script
|
48
|
-
src="https://res.cdn.office.net/teams-js/2.
|
49
|
-
integrity="sha384-
|
50
|
-
crossorigin="anonymous"
|
51
|
-
></script>
|
52
|
-
|
53
|
-
<!-- Microsoft Teams JavaScript API (via npm) -->
|
54
|
-
<script src="node_modules/@microsoft/teams-js@2.
|
55
|
-
|
56
|
-
<!-- Microsoft Teams JavaScript API (via local) -->
|
57
|
-
<script src="MicrosoftTeams.min.js"></script>
|
58
|
-
```
|
59
|
-
|
60
|
-
### Dependencies
|
61
|
-
|
62
|
-
Teams client SDK depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as [es6-promise](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client SDK, you need to make sure the polyfill is included and initialized before the Teams client SDK is.
|
63
|
-
|
64
|
-
## Examples
|
65
|
-
|
66
|
-
Stay tuned for examples coming soon.
|
67
|
-
|
68
|
-
## Testing
|
69
|
-
|
70
|
-
The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
|
71
|
-
|
72
|
-
## Contributing
|
73
|
-
|
74
|
-
Please be sure to check out the [Contributor's guide](../../CONTRIBUTING.md) for crucial steps.
|
1
|
+
# Microsoft Teams JavaScript client SDK
|
2
|
+
|
3
|
+
Welcome to the Teams JavaScript client SDK! For breaking changes, please refer to our [changelog](./CHANGELOG.md) in the current `<root>/packages/teams-js` directory.
|
4
|
+
|
5
|
+
This JavaScript library is part of the [Microsoft Teams developer platform](https://docs.microsoft.com/en-us/microsoftteams/platform/). See full [SDK reference documentation](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest).
|
6
|
+
|
7
|
+
## Getting Started
|
8
|
+
|
9
|
+
See [instructions](../../README.md#Getting-Started) in the monorepo root for how to clone and build the repository.
|
10
|
+
|
11
|
+
Whenever building or testing the Teams client SDK, you can run `yarn build` or `yarn test` from the packages/teams-js directory.
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
To install the stable [version](https://docs.microsoft.com/javascript/api/overview/msteams-client?view=msteams-client-js-latest):
|
16
|
+
|
17
|
+
### npm
|
18
|
+
|
19
|
+
`npm install --save @microsoft/teams-js`
|
20
|
+
|
21
|
+
### yarn
|
22
|
+
|
23
|
+
`yarn add @microsoft/teams-js`
|
24
|
+
|
25
|
+
### Production
|
26
|
+
|
27
|
+
You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js) or point your package manager at them.
|
28
|
+
|
29
|
+
## Usage
|
30
|
+
|
31
|
+
### As a package
|
32
|
+
|
33
|
+
Install either using npm or yarn.
|
34
|
+
|
35
|
+
**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.
|
36
|
+
|
37
|
+
```typescript
|
38
|
+
import { app } from '@microsoft/teams-js';
|
39
|
+
```
|
40
|
+
|
41
|
+
### As a script tag
|
42
|
+
|
43
|
+
Reference the SDK inside of your `.html` page using:
|
44
|
+
|
45
|
+
```html
|
46
|
+
<!-- Microsoft Teams JavaScript API (via CDN) -->
|
47
|
+
<script
|
48
|
+
src="https://res.cdn.office.net/teams-js/2.2.0/js/MicrosoftTeams.min.js"
|
49
|
+
integrity="sha384-yBjE++eHeBPzIg+IKl9OHFqMbSdrzY2S/LW3qeitc5vqXewEYRWegByWzBN/chRh"
|
50
|
+
crossorigin="anonymous"
|
51
|
+
></script>
|
52
|
+
|
53
|
+
<!-- Microsoft Teams JavaScript API (via npm) -->
|
54
|
+
<script src="node_modules/@microsoft/teams-js@2.2.0/dist/MicrosoftTeams.min.js"></script>
|
55
|
+
|
56
|
+
<!-- Microsoft Teams JavaScript API (via local) -->
|
57
|
+
<script src="MicrosoftTeams.min.js"></script>
|
58
|
+
```
|
59
|
+
|
60
|
+
### Dependencies
|
61
|
+
|
62
|
+
Teams client SDK depends on [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) type. If you support older browsers and devices which may not yet provide it natively (e.g. IE 11), you need to provide a global polyfill, such as [es6-promise](https://www.npmjs.com/package/es6-promise), in your bundled application. If you're using a script tag to reference the Teams client SDK, you need to make sure the polyfill is included and initialized before the Teams client SDK is.
|
63
|
+
|
64
|
+
## Examples
|
65
|
+
|
66
|
+
Stay tuned for examples coming soon.
|
67
|
+
|
68
|
+
## Testing
|
69
|
+
|
70
|
+
The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
|
71
|
+
|
72
|
+
## Contributing
|
73
|
+
|
74
|
+
Please be sure to check out the [Contributor's guide](../../CONTRIBUTING.md) for crucial steps.
|