sp-dev-fx-webparts/samples/react-teams-message-user/README.md

110 lines
4.4 KiB
Markdown
Raw Normal View History

2021-02-28 13:48:56 -05:00
# Message Teams User
2021-02-28 11:12:24 -05:00
## Summary
2021-02-28 13:07:00 -05:00
Sample that shows how to send a message to Microsoft Teams using a SharePoint framework solution using Microsoft Graph.
![Message Teams Web part preview](./assets/webPart-preview.png).
## Compatibility
![SPFx 1.11](https://img.shields.io/badge/SPFx-1.11.0-green.svg)
2021-11-01 21:07:49 -04:00
![Node.js v10](https://img.shields.io/badge/Node.js-v10-green.svg)
2021-10-30 22:59:30 -04:00
![Compatible with SharePoint Online](https://img.shields.io/badge/SharePoint%20Online-Compatible-green.svg)
![Does not work with SharePoint 2019](https://img.shields.io/badge/SharePoint%20Server%202019-Incompatible-red.svg "SharePoint Server 2019 requires SPFx 1.4.1 or lower")
![Does not work with SharePoint 2016 (Feature Pack 2)](https://img.shields.io/badge/SharePoint%20Server%202016%20(Feature%20Pack%202)-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
![Teams Incompatible](https://img.shields.io/badge/Teams-Incompatible-lightgrey.svg)
![Local Workbench Incompatible](https://img.shields.io/badge/Local%20Workbench-Incompatible-red.svg "The solution requires access to Microsoft Graph")
![Hosted Workbench Compatible](https://img.shields.io/badge/Hosted%20Workbench-Compatible-green.svg)
2021-02-28 11:12:24 -05:00
## Applies to
* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-developer-tenant)
## Prerequisites
* SharePoint Online tenant
2021-02-28 13:07:00 -05:00
* You have provided permission in SharePoint admin for accessing Graph API on behalf of your solution. We can do it before deployment as proactive steps, or after deployment. You can refer to [steps about how to do this post-deployment](https://docs.microsoft.com/en-us/sharepoint/dev/spfx/use-aad-tutorial#deploy-the-solution-and-grant-permissions). Basically you have to use API Access Page of SharePoint admin and add below permission for our use case.
2021-02-28 11:12:24 -05:00
2021-02-28 13:07:00 -05:00
```json
2021-02-28 11:12:24 -05:00
"webApiPermissionRequests": [
{
"resource": "Microsoft Graph",
"scope": "ChatMessage.Send"
},
{
"resource": "Microsoft Graph",
"scope": "Chat.Create"
},
{
"resource": "Microsoft Graph",
"scope": "Chat.ReadWrite"
},
{
"resource": "Microsoft Graph",
"scope": "User.Read"
},
{
"resource": "Microsoft Graph",
"scope": "User.ReadWrite.All"
},
{
"resource": "Microsoft Graph",
"scope": "Directory.Read.All"
},
{
"resource": "Microsoft Graph",
"scope": "Directory.ReadWrite.All"
}
]
```
## Concepts
This Web Part illustrates the following concepts on top of the SharePoint Framework:
2021-02-28 13:07:00 -05:00
* Using react framework in SPFx web part
* Calling Microsoft Graph API in SPFx web part
2021-02-28 11:12:24 -05:00
## Solution
Solution|Author(s)
--------|---------
2021-10-30 22:59:30 -04:00
teams-messages| [David Ramalho](https://github.com/DRamalho92) ([@davRamalho](https://twitter.com/davRamalho))
2021-02-28 11:12:24 -05:00
## Version history
Version|Date|Comments
-------|----|--------
1.0|February 28, 2021|Initial release
2021-10-30 22:59:30 -04:00
## Minimal Path to Awesome
- Clone this repository
- in the command line run:
- `npm install`
- `gulp serve`
2021-02-28 11:12:24 -05:00
## Disclaimer
**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
2021-10-30 22:59:30 -04:00
## Help
2021-02-28 11:12:24 -05:00
2021-10-30 22:59:30 -04:00
We do not support samples, but we this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.
2021-02-28 11:12:24 -05:00
2021-10-30 22:59:30 -04:00
If you encounter any issues while using this sample, [create a new issue](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=bug-report.yml&sample=react-teams-message-user&authors=@DRamalho92&title=react-teams-message-user%20-%20).
For questions regarding this sample, [create a new question](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=question.yml&sample=react-teams-message-user&authors=@DRamalho92&title=react-teams-message-user%20-%20).
2021-02-28 11:12:24 -05:00
2021-10-30 22:59:30 -04:00
Finally, if you have an idea for improvement, [make a suggestion](https://github.com/pnp/sp-dev-fx-webparts/issues/new?assignees=&labels=Needs%3A+Triage+%3Amag%3A%2Ctype%3Abug-suspected&template=suggestion.yml&sample=react-teams-message-user&authors=@DRamalho92&title=react-teams-message-user%20-%20).
2021-02-28 11:12:24 -05:00
2021-02-28 13:07:00 -05:00
<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-teams-message-user" />