sp-dev-fx-webparts/samples/react-yammer-api
Hugo Bernier 7e97daab76 Added more contributions 2023-03-15 01:23:34 -04:00
..
.devcontainer added remaining containers 2022-02-16 21:47:07 -05:00
.vscode Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
assets Changed docs links to learn 2022-10-24 09:42:45 -04:00
config Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
src/webparts/reactYammerApi Store the token in local storage (#853) 2019-05-04 18:02:39 +03:00
typings Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
.editorconfig Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
.gitattributes Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
.gitignore Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
.npmignore Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
.yo-rc.json Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
README.md Added more contributions 2023-03-15 01:23:34 -04:00
gulpfile.js Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
package.json Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
tsconfig.json Dev - SPFx Sample, Yammer REST API SPFx react webpart (#182) 2017-05-06 18:40:10 +03:00
tslint.json Add tslint at the root of each SPFx project (#394) 2018-01-08 15:58:48 +02:00

README.md

page_type products languages extensions
sample
office-sp
office-yammer
javascript
typescript
contentType technologies platforms createdDate
samples
SharePoint Framework
react
4/1/2017 12:00:00 AM

Yammer REST API SPFx web part

Summary

This sample shows how Yammer REST APIs can be consumed by using SharePoint Framework React web part and the Yammer JavaScript SDK. The SPFx web part contains wrapper around the Yammer JavaScript SDK that can be extended for fluent typescript api experience.

Sample SharePoint Framework client-side web part built using React that consumes the Yammer search REST API.

The yammer search web part displayed in SharePoint online

Smart Authentication, if Yammer Enforce Office 365 identity is enabled

If Yammer Office 365 Identity Enforcement is enabled, the web part will 'smart' authenticate Office 365 user when in SharePoint Online environment i.e. a user should allow the app (consent popup) once in a lifetime. After, the user will be logged in all the time. Smart because if you do not have the yammer auth cookies, you would not have to re-authenticate with login button and popups. To enable Office 365 Identity Enforcement on Office 365 Enterprise E3 Trial tenant, go to the Office 365 admin -> Admin centers -> Yammer -> Security Settings -> Enforce Office 365 identity.

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 1.0.0 Node.js v6 Compatible with SharePoint Online Compatible SharePoint 2019 Compatible with SharePoint 2016 (Feature Pack 2) Local Workbench Compatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Prerequisites

Contributors

Version history

Version Date Comments
0.0.1 April 19, 2017 Initial commit

Minimal Path to Awesome

  • Clone this repository.
  • In the Yammer corresponding to your Office 365 tenant, register a new Yammer App. Here is a how to register an app with Yammer guide.
  • Do not forget to paste your Office 365 tenant url in the Javascript Origins upon Yammer app registration e.g Javascript Origins: https://<your_tenant>.sharepoint.com.
  • Add Yammer app redirect URI e.g. https://<your_tenant>.sharepoint.com/SitePages/Home.aspx.
  • Make sure the Yammer app is enabled

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Yammer app enabled

  • Copy the Yammer app client Id and redirect uri.
  • Go to the SPFx web part folder and find src/webparts/reactYammerApi/yammer/ProdConfiguration.ts.
  • Replace the config client id and redirect uri with the copied from the yammer registered app values.
import { IConfiguration } from './IConfiguration';

/**
 * Web part production configuration.
 */
export class ProdConfiguration implements IConfiguration {
    public readonly clientId: string = "<YOUR_YAMMER_APP_CLIENT_ID>";
    public readonly redirectUri: string = "<YOUR_YAMMER_APP_REDIRECT_URI>";
}
  • Open the command line, navigate to the web part folder and execute:
    • npm i
    • gulp test (optional)
    • gulp serve --nobrowser
  • Navigate to the hosted version of the SharePoint workbench. (https://<your_tenant>.sharepoint.com/sites/<your_site>/_layouts/15/workbench.aspx).
  • Add the React Yammer API web part.

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

  • Using React for building SharePoint Framework client-side web parts.
  • Using Office UI Fabric React styles for building user experience consistent with SharePoint and Office.
  • On-demand authentication with Yammer using the Yammer JavaScript SDK.
  • Communicating with Yammer using its REST APIs.
  • Passing web part properties to React components.
  • Passing localized strings to React components.
  • Unit tests including spies, mocks and faking class methods and properties with stubs.

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.