New-BrowserBookmark

New-BrowserBookmark 
    -Title 
    -URL 
    [-Description ]
    [-Path ]
    [-Stars ]
    [-Notes ]
    [-DateAdded ]
    [-AttemptIconDiscovery ]

Description

Creates a generic BrowserBookmark object from an URL and a corresponding title as well as further optional metadata.

Examples

Creates a bookmark object for the metaBPA homepage.

New-BrowserBookmark -URL 'https://metabpa.org' -Title 'Make on-premises great again!'

Creates a bookmark object for the metaBPA homepage with five stars and tries to extract a favicon reference.

New-BrowserBookmark -URL 'https://metabpa.org' -Title 'Make on-premises great again!' 
    -Stars 5 -AttemptIconDiscovery

Parameters

-Title

[string]

The mandatory title of the bookmarked resource. If the new bookmark is added to IE favourites, the file name of the .url file will be constructed from this string.

-URL

[string]

The mandatory URI of the bookmarked resource. Must resolve to a valid [uri] object.

-Description

[string]

The description of the bookmark. In browser-added bookmarks it is usually an abstract of the bookmarked resource, if provided by the website.

-Path

[string]

Backslash-joined (DOS style) folder path to place the bookmark in. Consult the help for the desired Add-*Bookmark function on how the path value will be handled.

-Stars

[int] value between 1 and 5

Star rating for the new bookmark. At present, it will only be used if adding the bookmark to IE favourites.

-Notes

[string]

Notes for the new bookmark. At present, it will only be used if adding the bookmark to IE favourites.

-DateAdded

[datetime]

Date the bookmark is added to the respective store. If omitted, the curent date and time will be used.

-AttemptIconDiscovery

[switch]

The function will invoke a WebRequest to the -URI and attempt to find a reference to a favicon in the resulting response. If successful, IconFile will be set to the absolute URI of the icon, IconIndex will be set to 1.

Input

This function does not accept pipeline input.

Output

A single BrowserBookmark object.

[ back to module ]