New-STFWebReceiverPinnedLink
Create a new Pinned Link
Syntax
New-STFWebReceiverPinnedLink [-Hyperlink] <String> [-DisplayText] <String> [[-TooltipText] <String>] [[-Icon] <String>] [<CommonParameters>]
Detailed Description
The cmdlet creates a new Pinned Link object containing the data specified in the parameters.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Hyperlink | The hyperlink to be pinned. | true | true (ByValue) | |
| DisplayText | Display text for the link. | true | true (ByValue) | |
| TooltipText | Optional tooltip text for the pinned link. | false | true (ByValue) | |
| Icon | Optional icon to include alongside pinned link. | false | true (ByValue) |
Input Type
System.String
Parameter Hyperlink: The .NET
System.String reference type
System.String
Parameter DisplayText: The .NET
System.String reference type
System.String
Parameter TooltipText: The .NET
System.String reference type
System.String
Parameter Icon: The .NET
System.String reference type
Return Values
Link
The .NET
Citrix.StoreFront.Model.ReceiverForWeb.Link reference type
Examples
EXAMPLE 1 Create a Pinned Links
$link = New-STFWebReceiverPinnedLink -Hyperlink "https://example.link" -DisplayText "Example" `
-TooltipText "An example pinned link" -Icon "C:\Users\Current\Download\icon.jpg"
$collection = @($newLink)
$receiver = Get-STFWebReceiverService
Set-STFWebReceiverPinnedLinks -WebReceiverService $receiver -PinnedLinks $collection -Enabled $true
REMARKS
Adds a new pinned link to the WebReceiver and enables displaying pinned likes in the Web UI