Package Shortcuts

Prev Next

Get-LiquitPackageShortcut

Synopsis

This command displays a list of all shortcuts associated with a package. Alternatively, you can use this command to select a specific shortcut.

Syntax

Get-LiquitPackageShortcut 
    [-Snapshot] <PackageSnapshot> 
    [-LiquitContext <LiquitContext>]  
    [<CommonParameters>]

Get-LiquitPackageShortcut 
    [-Snapshot] <PackageSnapshot> 
    [-ID] <string[]> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

Get-LiquitPackageShortcut 
    [-Snapshot] <PackageSnapshot> 
    [-Search] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

Get-LiquitPackageShortcut 
    [-Snapshot] <PackageSnapshot> 
    [-Name] <string> 
    [-LiquitContext <LiquitContext>]
    [<CommonParameters>]

Parameters

Name Value Description Required Default value
Search <string> This parameter serves a similar purpose to the search box found in the shortcuts table within a package, from the Application Workspace UI. It enables users to search multiple columns within the table, such as Display name and Deschiption. When a search term is provided, the parameter filters records by matching values in these indexed columns. However, it's important to note that not all columns in the table are indexed, meaning that searches for values in these non-indexed columns will not return results. Non-indexed columns include for example columns containing checkboxes. Yes
Name <string> Searches on the package shortcut name itself. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

New-LiquitPackageShortcut

Synopsis

This command associates a new shortcut with a package.

Syntax

New-LiquitPackageShortcut 
    [-Snapshot] <PackageSnapshot> 
    [-ID] <string> 
    [-Name] <string> 
    [-Description <string>]
    [-Enabled <bool>]
    [-Icon <Content>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Parameters

Name Value Description Required Default value
Snapshot <string> The snapshot to which you want to add the shortcut. Yes
ID <string> The ID of the package shortcut. Yes
Name <string> Provide a name for the package shortcut. Yes
Description <string> Provide a description for the package shortcut. No
Enabled <bool> Determines whether or not the package shortcut is enabled. No False
Icon <Content> The icon of the team. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Set-LiquitPackageShortcut

Synopsis

This command lets you edit the properties of a shortcut for a package.

Syntax

Set-LiquitPackageShortcut 
    [-Shortcut] <PackageShortcut[]> 
    [-Name <string>] 
    [-Description <string>] 
    [-Enabled <bool>] 
    [-Icon <Content>] 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]  
    [<CommonParameters>]

Parameters

Name Value Description Required Default value
Shortcut <string> The package shortcut to be updated. Yes
Name <string> Provide a name for the package shortcut. No
Description <string> Provide a description for the package shortcut. No
Enabled <bool> Determines whether or not the package shortcut is enabled. No False
Icon <Content> The icon of the team. No
LiquitContext <LiquitContext> Determines the selected zone. No Default

Remove-LiquitPackageShortcut

Synopsis

This command removes a shortcut from a package.

Syntax

Remove-LiquitPackageShortcut 
    [-Shortcut] <PackageShortcut[]> 
    [-LiquitContext <LiquitContext>] 
    [-WhatIf] 
    [-Confirm]
    [<CommonParameters>]

Parameters

Name Value Description Required Default value
Shortcut <string> The shortcut you wish to remove. Yes
LiquitContext <LiquitContext> Determines the selected zone. No Default