Skip to content

Commit 8cd5900

Browse files
committed
doc updates
1 parent ed03860 commit 8cd5900

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+998
-84
lines changed

docs/reference/commands/Add-CommandPermission.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Adds a permission to a command.
1313
## SYNTAX
1414

1515
```
16-
Add-CommandPermission -Bot <Object> [-Command] <String> [-Permission] <String> [<CommonParameters>]
16+
Add-CommandPermission -Bot <Object> [-Command] <String> [-Permission] <String>
17+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
1718
```
1819

1920
## DESCRIPTION
@@ -75,6 +76,21 @@ Accept pipeline input: False
7576
Accept wildcard characters: False
7677
```
7778
79+
### -ProgressAction
80+
{{ Fill ProgressAction Description }}
81+
82+
```yaml
83+
Type: ActionPreference
84+
Parameter Sets: (All)
85+
Aliases: proga
86+
87+
Required: False
88+
Position: Named
89+
Default value: None
90+
Accept pipeline input: False
91+
Accept wildcard characters: False
92+
```
93+
7894
### CommonParameters
7995
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
8096

docs/reference/commands/Approve-PendingCommand.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Approved a command for execution.
1313
## SYNTAX
1414

1515
```
16-
Approve-PendingCommand -Bot <Object> [-Id] <String> [<CommonParameters>]
16+
Approve-PendingCommand -Bot <Object> [-Id] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -61,6 +61,21 @@ Accept pipeline input: False
6161
Accept wildcard characters: False
6262
```
6363
64+
### -ProgressAction
65+
{{ Fill ProgressAction Description }}
66+
67+
```yaml
68+
Type: ActionPreference
69+
Parameter Sets: (All)
70+
Aliases: proga
71+
72+
Required: False
73+
Position: Named
74+
Default value: None
75+
Accept pipeline input: False
76+
Accept wildcard characters: False
77+
```
78+
6479
### CommonParameters
6580
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
6681

docs/reference/commands/Deny-PendingCommand.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Deny the approval of a pending command.
1313
## SYNTAX
1414

1515
```
16-
Deny-PendingCommand -Bot <Object> [-Id] <String> [<CommonParameters>]
16+
Deny-PendingCommand -Bot <Object> [-Id] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -60,6 +60,21 @@ Accept pipeline input: False
6060
Accept wildcard characters: False
6161
```
6262
63+
### -ProgressAction
64+
{{ Fill ProgressAction Description }}
65+
66+
```yaml
67+
Type: ActionPreference
68+
Parameter Sets: (All)
69+
Aliases: proga
70+
71+
Required: False
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
6378
### CommonParameters
6479
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
6580

docs/reference/commands/Disable-ScheduledCommand.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Disable a scheduled command.
1313
## SYNTAX
1414

1515
```
16-
Disable-ScheduledCommand -Bot <Object> [-Id] <String> [<CommonParameters>]
16+
Disable-ScheduledCommand -Bot <Object> [-Id] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -60,6 +60,21 @@ Accept pipeline input: False
6060
Accept wildcard characters: False
6161
```
6262
63+
### -ProgressAction
64+
{{ Fill ProgressAction Description }}
65+
66+
```yaml
67+
Type: ActionPreference
68+
Parameter Sets: (All)
69+
Aliases: proga
70+
71+
Required: False
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
6378
### CommonParameters
6479
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
6580

docs/reference/commands/Enable-ScheduledCommand.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Enable a scheduled command.
1313
## SYNTAX
1414

1515
```
16-
Enable-ScheduledCommand -Bot <Object> [-Id] <String> [<CommonParameters>]
16+
Enable-ScheduledCommand -Bot <Object> [-Id] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -60,6 +60,21 @@ Accept pipeline input: False
6060
Accept wildcard characters: False
6161
```
6262
63+
### -ProgressAction
64+
{{ Fill ProgressAction Description }}
65+
66+
```yaml
67+
Type: ActionPreference
68+
Parameter Sets: (All)
69+
Aliases: proga
70+
71+
Required: False
72+
Position: Named
73+
Default value: None
74+
Accept pipeline input: False
75+
Accept wildcard characters: False
76+
```
77+
6378
### CommonParameters
6479
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
6580

docs/reference/commands/Find-Plugin.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Only plugins (PowerShell modules) with the 'PoshBot' tag are returned.
1414
## SYNTAX
1515

1616
```
17-
Find-Plugin -Bot <Object> [[-Name] <String>] [[-Repository] <String>] [<CommonParameters>]
17+
Find-Plugin -Bot <Object> [[-Name] <String>] [[-Repository] <String>] [-ProgressAction <ActionPreference>]
18+
[<CommonParameters>]
1819
```
1920

2021
## DESCRIPTION
@@ -91,6 +92,21 @@ Accept pipeline input: False
9192
Accept wildcard characters: False
9293
```
9394
95+
### -ProgressAction
96+
{{ Fill ProgressAction Description }}
97+
98+
```yaml
99+
Type: ActionPreference
100+
Parameter Sets: (All)
101+
Aliases: proga
102+
103+
Required: False
104+
Position: Named
105+
Default value: None
106+
Accept pipeline input: False
107+
Accept wildcard characters: False
108+
```
109+
94110
### CommonParameters
95111
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
96112

docs/reference/commands/Get-CommandHelp.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,20 @@ Show details and help information about bot commands.
1414

1515
### Detailed (Default)
1616
```
17-
Get-CommandHelp -Bot <Object> [[-Filter] <String>] [-Detailed] [-Type <String>] [<CommonParameters>]
17+
Get-CommandHelp -Bot <Object> [[-Filter] <String>] [-Detailed] [-Type <String>]
18+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
1819
```
1920

2021
### Examples
2122
```
22-
Get-CommandHelp -Bot <Object> [[-Filter] <String>] [-Examples] [-Type <String>] [<CommonParameters>]
23+
Get-CommandHelp -Bot <Object> [[-Filter] <String>] [-Examples] [-Type <String>]
24+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
2325
```
2426

2527
### Full
2628
```
27-
Get-CommandHelp -Bot <Object> [[-Filter] <String>] [-Full] [-Type <String>] [<CommonParameters>]
29+
Get-CommandHelp -Bot <Object> [[-Filter] <String>] [-Full] [-Type <String>]
30+
[-ProgressAction <ActionPreference>] [<CommonParameters>]
2831
```
2932

3033
## DESCRIPTION
@@ -159,6 +162,21 @@ Accept pipeline input: False
159162
Accept wildcard characters: False
160163
```
161164
165+
### -ProgressAction
166+
{{ Fill ProgressAction Description }}
167+
168+
```yaml
169+
Type: ActionPreference
170+
Parameter Sets: (All)
171+
Aliases: proga
172+
173+
Required: False
174+
Position: Named
175+
Default value: None
176+
Accept pipeline input: False
177+
Accept wildcard characters: False
178+
```
179+
162180
### CommonParameters
163181
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
164182

docs/reference/commands/Get-CommandHistory.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,19 @@ Get the recent execution history of a command
1414

1515
### all (Default)
1616
```
17-
Get-CommandHistory -Bot <Object> [[-Count] <Int32>] [<CommonParameters>]
17+
Get-CommandHistory -Bot <Object> [[-Count] <Int32>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
1818
```
1919

2020
### name
2121
```
22-
Get-CommandHistory -Bot <Object> [[-Name] <String>] [[-Count] <Int32>] [<CommonParameters>]
22+
Get-CommandHistory -Bot <Object> [[-Name] <String>] [[-Count] <Int32>] [-ProgressAction <ActionPreference>]
23+
[<CommonParameters>]
2324
```
2425

2526
### id
2627
```
27-
Get-CommandHistory -Bot <Object> [[-Id] <String>] [[-Count] <Int32>] [<CommonParameters>]
28+
Get-CommandHistory -Bot <Object> [[-Id] <String>] [[-Count] <Int32>] [-ProgressAction <ActionPreference>]
29+
[<CommonParameters>]
2830
```
2931

3032
## DESCRIPTION
@@ -115,6 +117,21 @@ Accept pipeline input: False
115117
Accept wildcard characters: False
116118
```
117119
120+
### -ProgressAction
121+
{{ Fill ProgressAction Description }}
122+
123+
```yaml
124+
Type: ActionPreference
125+
Parameter Sets: (All)
126+
Aliases: proga
127+
128+
Required: False
129+
Position: Named
130+
Default value: None
131+
Accept pipeline input: False
132+
Accept wildcard characters: False
133+
```
134+
118135
### CommonParameters
119136
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
120137

docs/reference/commands/Get-CommandStatus.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Get the status of running commands.
1313
## SYNTAX
1414

1515
```
16-
Get-CommandStatus [-Bot] <Object> [<CommonParameters>]
16+
Get-CommandStatus [-Bot] <Object> [-ProgressAction <ActionPreference>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -45,6 +45,21 @@ Accept pipeline input: False
4545
Accept wildcard characters: False
4646
```
4747
48+
### -ProgressAction
49+
{{ Fill ProgressAction Description }}
50+
51+
```yaml
52+
Type: ActionPreference
53+
Parameter Sets: (All)
54+
Aliases: proga
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
4863
### CommonParameters
4964
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
5065

docs/reference/commands/Get-MyCommands.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Returns all commands that the user is authorized to execute.
1313
## SYNTAX
1414

1515
```
16-
Get-MyCommands [-Bot] <Object> [<CommonParameters>]
16+
Get-MyCommands [-Bot] <Object> [-ProgressAction <ActionPreference>] [<CommonParameters>]
1717
```
1818

1919
## DESCRIPTION
@@ -45,6 +45,21 @@ Accept pipeline input: False
4545
Accept wildcard characters: False
4646
```
4747
48+
### -ProgressAction
49+
{{ Fill ProgressAction Description }}
50+
51+
```yaml
52+
Type: ActionPreference
53+
Parameter Sets: (All)
54+
Aliases: proga
55+
56+
Required: False
57+
Position: Named
58+
Default value: None
59+
Accept pipeline input: False
60+
Accept wildcard characters: False
61+
```
62+
4863
### CommonParameters
4964
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
5065

0 commit comments

Comments
 (0)