Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Version 2 #1061

Merged
merged 2 commits into from
Feb 13, 2020
Merged

Version 2 #1061

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d53c7d5
Update site-users.md
ValerasNarbutas Feb 10, 2020
1aab226
Merge pull request #3 from ValerasNarbutas/ValerasNarbutas-patch-1-fi…
ValerasNarbutas Feb 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions docs/sp/site-users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ The site users module provides methods to manage users for a sharepoint site.

|Scenario|Import Statement|
|--|--|
|Selective 2|import { sp } from "@pnp/sp";<br />import "@pnp/sp/src/webs";<br />import "@pnp/sp/src/site-users";|
|Selective 3|import { sp } from "@pnp/sp";<br />import "@pnp/sp/src/webs";<br />import "@pnp/sp/src/site-users/web";|
|Selective 2|import { sp } from "@pnp/sp";<br />import "@pnp/sp/webs";<br />import "@pnp/sp/site-users";|
|Selective 3|import { sp } from "@pnp/sp";<br />import "@pnp/sp/webs";<br />import "@pnp/sp/site-users/web";|
|Preset: All|import {sp, SiteUsers } from "@pnp/sp/presets/all";|

### Get all site user

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

const users = await sp.web.siteUsers();
```
Expand All @@ -26,8 +26,8 @@ const users = await sp.web.siteUsers();

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

let user = await sp.web.currentUser;
```
Expand All @@ -36,8 +36,8 @@ let user = await sp.web.currentUser;

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

const id = 6;
user = await sp.web.getUserById(id);
Expand All @@ -47,8 +47,8 @@ user = await sp.web.getUserById(id);

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

const username = "usernames@microsoft.com";
result = await sp.web.ensureUser(username);
Expand All @@ -60,16 +60,16 @@ result = await sp.web.ensureUser(username);

|Scenario|Import Statement|
|--|--|
|Selective 2|import { sp } from "@pnp/sp";<br />import "@pnp/sp/src/webs";<br />import "@pnp/sp/src/site-users";|
|Selective 3|import { sp } from "@pnp/sp";<br />import "@pnp/sp/src/webs";<br />import "@pnp/sp/src/site-users/web";|
|Selective 2|import { sp } from "@pnp/sp";<br />import "@pnp/sp/webs";<br />import "@pnp/sp/site-users";|
|Selective 3|import { sp } from "@pnp/sp";<br />import "@pnp/sp/webs";<br />import "@pnp/sp/site-users/web";|
|Preset: All|import {sp, SiteUsers, SiteUser } from "@pnp/sp/presets/all";|

### Get user Groups

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

let groups = await sp.web.currentUser.groups();
```
Expand All @@ -78,8 +78,8 @@ let groups = await sp.web.currentUser.groups();

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

const user = await sp.web.ensureUser("userLoginname")
const users = await sp.web.siteUsers;
Expand All @@ -91,8 +91,8 @@ await users.add(user.data.LoginName);

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

// get user object by id
const user = await sp.web.siteUsers.getById(6);
Expand All @@ -108,8 +108,8 @@ const user = await sp.web.siteUsers.getByLoginName("userLoginName");

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

let userProps = await sp.web.currentUser.get();
userProps.Title = "New title";
Expand All @@ -120,8 +120,8 @@ await sp.web.currentUser.update(userProps);

```TypeScript
import { sp } from "@pnp/sp";
import "@pnp/sp/src/webs";
import "@pnp/sp/src/site-users/web";
import "@pnp/sp/webs";
import "@pnp/sp/site-users/web";

// remove user by id
await sp.web.siteUsers.removeById(6);
Expand Down