Skip to content

Commit 6933c1e

Browse files
gautamdshethGautam Sheth
and
Gautam Sheth
authored
Feature: Add ToDo list management commands and update Viva Engage community privacy setting (#4653)
Co-authored-by: Gautam Sheth <gautam.sheth@staffbase.com>
1 parent 733dca0 commit 6933c1e

File tree

12 files changed

+641
-2
lines changed

12 files changed

+641
-2
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
4848
- Added `-ListPermissionScopes` parameter on `Get-PnPAccessToken` cmdlet to list the current permission scopes on the current access token.
4949
- Added `Get-PnPCopilotAgent` cmdlet that returns the Microsoft Copilot Agents in a site collection.
5050
- Added `Get-PnPFileRetentionLabel` cmdlet to fetch the file retention labels. [#4603](https://github.com/pnp/powershell/pull/4603)
51-
- Added `Get/Set/Remove-PnPUserProfilePhoto` cmdlet to download, upload or remove the profile photo of the specified user.
51+
- Added `Get/Set/Remove-PnPUserProfilePhoto` cmdlets to download, upload or remove the profile photo of the specified user.
52+
- Added `New/Get/Remove/Update-PnPTodoList` cmdlets to manage Todo lists.
5253

5354
### Changed
5455

documentation/Get-PnPTodoList.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
Module Name: PnP.PowerShell
3+
title: Get-PnPTodoList
4+
schema: 2.0.0
5+
applicable: SharePoint Online
6+
external help file: PnP.PowerShell.dll-Help.xml
7+
online version: https://pnp.github.io/powershell/cmdlets/Get-PnPTodoList.html
8+
---
9+
10+
# Get-PnPTodoList
11+
12+
## SYNOPSIS
13+
14+
**Required Permissions**
15+
16+
* Microsoft Graph API : One of Tasks.Read, Tasks.ReadWrite, Tasks.Read.All
17+
18+
Gets one Todo list or all Todo lists.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Get-PnPTodoList [[-Identity] <String>] [-[User] <AzureADUserPipeBind>]
24+
```
25+
26+
## DESCRIPTION
27+
Use the cmdlet to retrieve all Todo lists or a specific Todo list.
28+
29+
## EXAMPLES
30+
31+
### EXAMPLE 1
32+
```powershell
33+
Get-PnPTodoList
34+
```
35+
36+
This will return all your (logged-in user) todo lists.
37+
38+
### EXAMPLE 2
39+
```powershell
40+
Get-PnPTodoList -Identity "AAMkAGU4MGE1OTRiLTUzMGEtNDRjZi05ZmVmLWFiMTkyYmQxODRjOQAuAAAAAACQV8RStyZCQJ4ydzjIK5HmAQD2LFcxdwYMRqbupn47nEYYAASUnLfyAAA="
41+
```
42+
43+
This will return your (logged-in user) todo list with the specified Id.
44+
45+
### EXAMPLE 3
46+
```powershell
47+
Get-PnPTodoList -User john@doe.com
48+
```
49+
50+
This will return the todo lists for the user john.
51+
52+
### EXAMPLE 4
53+
```powershell
54+
Get-PnPTodoList -User john@doe.com -Identity "AAMkAGU4MGE1OTRiLTUzMGEtNDRjZi05ZmVmLWFiMTkyYmQxODRjOQAuAAAAAACQV8RStyZCQJ4ydzjIK5HmAQD2LFcxdwYMRqbupn47nEYYAASUnLfyAAA="
55+
```
56+
57+
This will return the todo list for the user john with specified Id.
58+
59+
## PARAMETERS
60+
61+
### -Identity
62+
Id of the Todo list.
63+
64+
```yaml
65+
Type: String
66+
Parameter Sets: (All)
67+
68+
Required: False
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### -User
76+
The UPN, Id or instance of an Azure AD user for which you would like to retrieve the todo list available to this user
77+
78+
```yaml
79+
Type: AzureADUserPipeBind
80+
Parameter Sets: (All)
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
89+
### -Connection
90+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
91+
92+
```yaml
93+
Type: PnPConnection
94+
Parameter Sets: (All)
95+
96+
Required: False
97+
Position: Named
98+
Default value: None
99+
Accept pipeline input: False
100+
Accept wildcard characters: False
101+
```
102+
103+
## RELATED LINKS
104+
105+
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
106+

documentation/New-PnPTodoList.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
Module Name: PnP.PowerShell
3+
title: New-PnPTodoList
4+
schema: 2.0.0
5+
applicable: SharePoint Online
6+
external help file: PnP.PowerShell.dll-Help.xml
7+
online version: https://pnp.github.io/powershell/cmdlets/New-PnPTodoList.html
8+
---
9+
10+
# New-PnPTodoList
11+
12+
## SYNOPSIS
13+
14+
**Required Permissions**
15+
16+
* Microsoft Graph API : One of Tasks.ReadWrite, Tasks.ReadWrite.All
17+
18+
Creates a new todo list.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
New-PnPTodoList [[-DisplayName] <String>] [-[User] <AzureADUserPipeBind>]
24+
```
25+
26+
## DESCRIPTION
27+
Use the cmdlet to create a Todo list.
28+
29+
## EXAMPLES
30+
31+
### EXAMPLE 1
32+
```powershell
33+
New-PnPTodoList -DisplayName "Travel items"
34+
```
35+
36+
This will create a todo list associated with your (logged-in user) account.
37+
38+
### EXAMPLE 2
39+
```powershell
40+
New-PnPTodoList -User john@doe.com -DisplayName "Travel Items"
41+
```
42+
43+
This will create a todo list associated with John's account.
44+
45+
## PARAMETERS
46+
47+
### -DisplayName
48+
Display name of the Todo list.
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
54+
Required: True
55+
Position: Named
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -User
62+
The UPN, Id or instance of an Azure AD user for which you would like to create the todo list.
63+
64+
```yaml
65+
Type: AzureADUserPipeBind
66+
Parameter Sets: (All)
67+
68+
Required: False
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### -Connection
76+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
77+
78+
```yaml
79+
Type: PnPConnection
80+
Parameter Sets: (All)
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
89+
## RELATED LINKS
90+
91+
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
92+

documentation/Remove-PnPTodoList.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
Module Name: PnP.PowerShell
3+
title: Remove-PnPTodoList
4+
schema: 2.0.0
5+
applicable: SharePoint Online
6+
external help file: PnP.PowerShell.dll-Help.xml
7+
online version: https://pnp.github.io/powershell/cmdlets/Remove-PnPTodoList.html
8+
---
9+
10+
# Remove-PnPTodoList
11+
12+
## SYNOPSIS
13+
14+
**Required Permissions**
15+
16+
* Microsoft Graph API : Tasks.ReadWrite
17+
18+
Removes a new todo list.
19+
20+
## SYNTAX
21+
22+
```powershell
23+
Remove-PnPTodoList [[-Identity] <String>] [-[User] <AzureADUserPipeBind>]
24+
```
25+
26+
## DESCRIPTION
27+
Use the cmdlet to delete a Todo list.
28+
29+
## EXAMPLES
30+
31+
### EXAMPLE 1
32+
```powershell
33+
Remove-PnPTodoList -Identity "AAMkAGU4MGE1OTRiLTUzMGEtNDRjZi05ZmVmLWFiMTkyYmQxODRjOQAuAAAAAACQV8RStyZCQJ4ydzjIK5HmAQD2LFcxdwYMRqbupn47nEYYAASYG0vWAAA="
34+
```
35+
36+
This will delete a todo list with specified Id associated with your (logged-in user) account.
37+
38+
### EXAMPLE 2
39+
```powershell
40+
Remove-PnPTodoList -Identity "AAMkAGU4MGE1OTRiLTUzMGEtNDRjZi05ZmVmLWFiMTkyYmQxODRjOQAuAAAAAACQV8RStyZCQJ4ydzjIK5HmAQD2LFcxdwYMRqbupn47nEYYAASYG0vWAAA=" -User john@doe.com
41+
```
42+
43+
This will delete a todo list with specified Id associated with John's account.
44+
45+
## PARAMETERS
46+
47+
### -Identity
48+
Id of the Todo list.
49+
50+
```yaml
51+
Type: String
52+
Parameter Sets: (All)
53+
54+
Required: True
55+
Position: Named
56+
Default value: None
57+
Accept pipeline input: False
58+
Accept wildcard characters: False
59+
```
60+
61+
### -User
62+
The UPN, Id or instance of an Azure AD user for which you would like to create the todo list.
63+
64+
```yaml
65+
Type: AzureADUserPipeBind
66+
Parameter Sets: (All)
67+
68+
Required: False
69+
Position: Named
70+
Default value: None
71+
Accept pipeline input: False
72+
Accept wildcard characters: False
73+
```
74+
75+
### -Connection
76+
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
77+
78+
```yaml
79+
Type: PnPConnection
80+
Parameter Sets: (All)
81+
82+
Required: False
83+
Position: Named
84+
Default value: None
85+
Accept pipeline input: False
86+
Accept wildcard characters: False
87+
```
88+
89+
## RELATED LINKS
90+
91+
[Microsoft 365 Patterns and Practices](https://aka.ms/m365pnp)
92+

0 commit comments

Comments
 (0)