Skip to content

Commit caa2b41

Browse files
author
PSAppDeployToolkit Action Workflow
committed
Commit of document changes from PSAppDeployToolkit/PSAppDeployToolkit@9894f14 
1 parent 8484dba commit caa2b41

13 files changed

+262
-85
lines changed

‎docs/reference/functions/Add-ADTModuleCallback.mdx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ Valid hookpoints are:
4040
* OnStart (The callback is executed before the first deployment session is opened)
4141
* PreOpen (The callback is executed before a deployment session is opened)
4242
* PostOpen (The callback is executed after a deployment session is opened)
43-
* OnDefer (The callback is executed when a user defers the active deployment)
4443
* PreClose (The callback is executed before the deployment session is closed)
4544
* PostClose (The callback is executed after the deployment session is closed)
4645
* OnFinish (The callback is executed before the last deployment session is closed)
@@ -54,7 +53,7 @@ To see a list all the registered callbacks in order, use `Get-ADTModuleCallback`
5453
Type: CallbackType
5554
Parameter Sets: (All)
5655
Aliases:
57-
Accepted values: OnInit, OnStart, PreOpen, PostOpen, OnDefer, PreClose, PostClose, OnFinish, OnExit
56+
Accepted values: OnInit, OnStart, PreOpen, PostOpen, PreClose, PostClose, OnFinish, OnExit
5857

5958
Required: True
6059
Position: 1

‎docs/reference/functions/Clear-ADTModuleCallback.mdx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ Valid hookpoints are:
4040
* OnStart (The callback is executed before the first deployment session is opened)
4141
* PreOpen (The callback is executed before a deployment session is opened)
4242
* PostOpen (The callback is executed after a deployment session is opened)
43-
* OnDefer (The callback is executed when a user defers the active deployment)
4443
* PreClose (The callback is executed before the deployment session is closed)
4544
* PostClose (The callback is executed after the deployment session is closed)
4645
* OnFinish (The callback is executed before the last deployment session is closed)
@@ -52,7 +51,7 @@ To see a list all the registered callbacks in order, use `Get-ADTModuleCallback`
5251
Type: CallbackType
5352
Parameter Sets: (All)
5453
Aliases:
55-
Accepted values: OnInit, OnStart, PreOpen, PostOpen, OnDefer, PreClose, PostClose, OnFinish, OnExit
54+
Accepted values: OnInit, OnStart, PreOpen, PostOpen, PreClose, PostClose, OnFinish, OnExit
5655

5756
Required: True
5857
Position: 1

‎docs/reference/functions/Get-ADTEnvironment.mdx‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
id: Get-ADTEnvironment
3+
title: Get-ADTEnvironment
4+
hide_title: false
5+
hide_table_of_contents: false
6+
---
7+
8+
## SYNOPSIS
9+
10+
Retrieves the environment data for the ADT module.
11+
This function has been replaced by [Get-ADTEnvironmentTable]. Please migrate your scripts as this will be removed in PSAppDeployToolkit 4.2.0.
12+
13+
## SYNTAX
14+
15+
```powershell
16+
Get-ADTEnvironment [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
21+
The Get-ADTEnvironment function retrieves the environment data for the ADT module.
22+
This function ensures that the ADT module has been initialized before attempting to retrieve the environment data.
23+
If the module is not initialized, it throws an error.
24+
25+
This function has been replaced by [Get-ADTEnvironmentTable]. Please migrate your scripts as this will be removed in PSAppDeployToolkit 4.2.0.
26+
27+
## EXAMPLES
28+
29+
### EXAMPLE 1
30+
31+
```powershell
32+
$environment = Get-ADTEnvironment
33+
```
34+
35+
This example retrieves the environment data for the ADT module and stores it in the $environment variable.
36+
37+
## PARAMETERS
38+
39+
### CommonParameters
40+
41+
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).
42+
43+
## INPUTS
44+
45+
### None
46+
47+
### You cannot pipe objects to this function.
48+
## OUTPUTS
49+
50+
### System.Collections.Specialized.OrderedDictionary
51+
52+
### Returns the environment data as a read-only ordered dictionary.
53+
## NOTES
54+
An active ADT session is NOT required to use this function.
55+
56+
Tags: psadt<br />
57+
Website: https://psappdeploytoolkit.com<br />
58+
Copyright: (C) 2025 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).<br />
59+
License: https://opensource.org/license/lgpl-3-0
60+
61+
## RELATED LINKS
62+
63+
[https://psappdeploytoolkit.com/docs/reference/functions/Get-ADTEnvironment](https://psappdeploytoolkit.com/docs/reference/functions/Get-ADTEnvironment)

‎docs/reference/functions/Get-ADTModuleCallback.mdx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ Valid hookpoints are:
4040
* OnStart (The callback is executed before the first deployment session is opened)
4141
* PreOpen (The callback is executed before a deployment session is opened)
4242
* PostOpen (The callback is executed after a deployment session is opened)
43-
* OnDefer (The callback is executed when a user defers the active deployment)
4443
* PreClose (The callback is executed before the deployment session is closed)
4544
* PostClose (The callback is executed after the deployment session is closed)
4645
* OnFinish (The callback is executed before the last deployment session is closed)
@@ -50,7 +49,7 @@ Valid hookpoints are:
5049
Type: CallbackType
5150
Parameter Sets: (All)
5251
Aliases:
53-
Accepted values: OnInit, OnStart, PreOpen, PostOpen, OnDefer, PreClose, PostClose, OnFinish, OnExit
52+
Accepted values: OnInit, OnStart, PreOpen, PostOpen, PreClose, PostClose, OnFinish, OnExit
5453

5554
Required: True
5655
Position: 1

‎docs/reference/functions/Get-ADTUniversalDate.mdx‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
---
2+
id: Get-ADTUniversalDate
3+
title: Get-ADTUniversalDate
4+
hide_title: false
5+
hide_table_of_contents: false
6+
---
7+
8+
## SYNOPSIS
9+
10+
Returns the date/time for the local culture in a universal sortable date time pattern.
11+
This function has been deprecated and will be removed from PSAppDeployToolkit 4.2.0.
12+
13+
## SYNTAX
14+
15+
```powershell
16+
Get-ADTUniversalDate [[-DateTime] <String>] [<CommonParameters>]
17+
```
18+
19+
## DESCRIPTION
20+
21+
Converts the current datetime or a datetime string for the current culture into a universal sortable date time pattern, e.g.
22+
2013-08-22 11:51:52Z.
23+
24+
## EXAMPLES
25+
26+
### EXAMPLE 1
27+
28+
```powershell
29+
Get-ADTUniversalDate
30+
```
31+
32+
Returns the current date in a universal sortable date time pattern.
33+
34+
### EXAMPLE 2
35+
36+
```powershell
37+
Get-ADTUniversalDate -DateTime '25/08/2013'
38+
```
39+
40+
Returns the date for the current culture in a universal sortable date time pattern.
41+
42+
## PARAMETERS
43+
44+
### -DateTime
45+
46+
Specify the DateTime in the current culture.
47+
48+
```yaml
49+
Type: String
50+
Parameter Sets: (All)
51+
Aliases:
52+
53+
Required: False
54+
Position: 1
55+
Default value: [System.DateTime]::Now.ToString([System.Globalization.DateTimeFormatInfo]::CurrentInfo.UniversalSortableDateTimePattern).TrimEnd('Z')
56+
Accept pipeline input: False
57+
Accept wildcard characters: False
58+
```
59+
60+
### CommonParameters
61+
62+
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).
63+
64+
## INPUTS
65+
66+
### None
67+
68+
### You cannot pipe objects to this function.
69+
## OUTPUTS
70+
71+
### System.String
72+
73+
### Returns the date/time for the local culture in a universal sortable date time pattern.
74+
## NOTES
75+
An active ADT session is NOT required to use this function.
76+
77+
Tags: psadt<br />
78+
Website: https://psappdeploytoolkit.com<br />
79+
Copyright: (C) 2025 PSAppDeployToolkit Team (Sean Lillis, Dan Cunningham, Muhammad Mashwani, Mitch Richters, Dan Gough).<br />
80+
License: https://opensource.org/license/lgpl-3-0
81+
82+
## RELATED LINKS
83+
84+
[https://psappdeploytoolkit.com/docs/reference/functions/Get-ADTUniversalDate](https://psappdeploytoolkit.com/docs/reference/functions/Get-ADTUniversalDate)

‎docs/reference/functions/Get-ADTUserProfiles.mdx‎

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,6 @@ Get-ADTUserProfiles [-ExcludeNTAccount <NTAccount[]>] [-IncludeSystemProfiles] [
2424
Get-ADTUserProfiles [-FilterScript] <ScriptBlock> [-LoadProfilePaths] [<CommonParameters>]
2525
```
2626

27-
### Specific
28-
29-
```powershell
30-
Get-ADTUserProfiles -SID <SecurityIdentifier[]> [-LoadProfilePaths] [<CommonParameters>]
31-
```
32-
3327
## DESCRIPTION
3428

3529
Get the User Profile Path, User Account SID, and the User Account Name for all users that log onto the machine and also the Default User (which does not log on).
@@ -81,22 +75,6 @@ Accept pipeline input: False
8175
Accept wildcard characters: False
8276
```
8377
84-
### -SID
85-
86-
Specifies the SID to get rather than returning all user profiles.
87-
88-
```yaml
89-
Type: SecurityIdentifier[]
90-
Parameter Sets: Specific
91-
Aliases:
92-
93-
Required: True
94-
Position: Named
95-
Default value: None
96-
Accept pipeline input: False
97-
Accept wildcard characters: False
98-
```
99-
10078
### -ExcludeNTAccount
10179
10280
Specify NT account names in DOMAIN\username format to exclude from the list of user profiles.

‎docs/reference/functions/Invoke-ADTCommandWithRetries.mdx‎

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Drop-in replacement for any cmdlet/function where a retry is desirable due to tr
1313

1414
```powershell
1515
Invoke-ADTCommandWithRetries [-Command] <Object> [-Retries <UInt32>] [-SleepDuration <TimeSpan>]
16-
[-MaximumElapsedTime <TimeSpan>] [-Parameters <System.Collections.Generic.IReadOnlyList`1[System.Object]>]
17-
[<CommonParameters>]
16+
[-MaximumElapsedTime <TimeSpan>] [-SleepSeconds <UInt32>]
17+
[-Parameters <System.Collections.Generic.IReadOnlyList`1[System.Object]>] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -119,6 +119,23 @@ Accept pipeline input: False
119119
Accept wildcard characters: False
120120
```
121121

122+
### -SleepSeconds
123+
124+
This parameter is obsolete and will be removed in PSAppDeployToolkit 4.2.0.
125+
Please use `-SleepDuration` instead.
126+
127+
```yaml
128+
Type: UInt32
129+
Parameter Sets: (All)
130+
Aliases:
131+
132+
Required: False
133+
Position: Named
134+
Default value: 5
135+
Accept pipeline input: False
136+
Accept wildcard characters: False
137+
```
138+
122139
### -Parameters
123140

124141
A 'ValueFromRemainingArguments' parameter to collect the parameters as would be passed to the provided Command.

‎docs/reference/functions/Remove-ADTModuleCallback.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Where you wish for the callback to be removed from.
3939
Type: CallbackType
4040
Parameter Sets: (All)
4141
Aliases:
42-
Accepted values: OnInit, OnStart, PreOpen, PostOpen, OnDefer, PreClose, PostClose, OnFinish, OnExit
42+
Accepted values: OnInit, OnStart, PreOpen, PostOpen, PreClose, PostClose, OnFinish, OnExit
4343

4444
Required: True
4545
Position: 1

‎docs/reference/functions/Send-ADTKeys.mdx‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,15 @@ Send a sequence of keys to one or more application windows.
1414
### WindowTitle
1515

1616
```powershell
17-
Send-ADTKeys -WindowTitle <String> -Keys <String> [-WaitDuration <TimeSpan>] [<CommonParameters>]
17+
Send-ADTKeys -WindowTitle <String> -Keys <String> [-WaitSeconds <Int32>] [-WaitDuration <TimeSpan>]
18+
[<CommonParameters>]
1819
```
1920

2021
### WindowHandle
2122

2223
```powershell
23-
Send-ADTKeys -WindowHandle <IntPtr> -Keys <String> [-WaitDuration <TimeSpan>] [<CommonParameters>]
24+
Send-ADTKeys -WindowHandle <IntPtr> -Keys <String> [-WaitSeconds <Int32>] [-WaitDuration <TimeSpan>]
25+
[<CommonParameters>]
2426
```
2527

2628
## DESCRIPTION
@@ -107,6 +109,23 @@ Accept pipeline input: False
107109
Accept wildcard characters: False
108110
```
109111
112+
### -WaitSeconds
113+
114+
This parameter is obsolete and will be removed in PSAppDeployToolkit 4.2.0.
115+
Please use `-WaitDuration` instead.
116+
117+
```yaml
118+
Type: Int32
119+
Parameter Sets: (All)
120+
Aliases:
121+
122+
Required: False
123+
Position: Named
124+
Default value: None
125+
Accept pipeline input: False
126+
Accept wildcard characters: False
127+
```
128+
110129
### -WaitDuration
111130

112131
An optional amount of time to wait after the sending of the keys.

0 commit comments

Comments
 (0)