WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsILivemarkService

IID:7879747e-8871-4a7b-9032-5c4fff1d6017
Inherits From:nsISupports

This interface is implemented by the following components:


Methods

PRInt64 createLivemark ( PRInt64 folder , AString name , nsIURI siteURI , nsIURI feedURI , PRInt32 index ) PRInt64 createLivemarkFolderOnly ( nsINavBookmarksService bms , PRInt64 folder , AString name , nsIURI siteURI , nsIURI feedURI , PRInt32 index ) nsIURI getFeedURI ( PRInt64 container ) nsIURI getSiteURI ( PRInt64 container ) PRBool isLivemark ( PRInt64 folder ) void reloadAllLivemarks ( ) void reloadLivemarkFolder ( PRInt64 folderID ) void setFeedURI ( PRInt64 container , nsIURI feedURI ) void setSiteURI ( PRInt64 container , nsIURI siteURI ) void start ( )

PRInt64 createLivemark ( PRInt64 folder , AString name , nsIURI siteURI , nsIURI feedURI , PRInt32 index )

Creates a new livemark

Arguments:
folder: The id of the parent folder
name: The name to show when displaying the livemark
siteURI: The URI of the site the livemark was created from
feedURI: The URI of the actual RSS feed
index: The index to insert at, or -1 to append

PRInt64 createLivemarkFolderOnly ( nsINavBookmarksService bms , PRInt64 folder , AString name , nsIURI siteURI , nsIURI feedURI , PRInt32 index )

Same as above, use during startup to avoid HTTP traffic

Arguments:
bms
folder
name
siteURI
feedURI
index

nsIURI getFeedURI ( PRInt64 container )

Gets the URI of the syndication feed associated with a livemark container.

Arguments:
container: The folder ID of a livemark container

nsIURI getSiteURI ( PRInt64 container )

Gets the URI of the website associated with a livemark container.

Arguments:
container: The folder ID of a livemark container

PRBool isLivemark ( PRInt64 folder )

Determines whether the folder with the given folder ID identifies a livemark container.

Arguments:
folder: A folder ID

void reloadAllLivemarks ( )

Reloads all livemark subscriptions, whether or not they've expired.


void reloadLivemarkFolder ( PRInt64 folderID )

Reloads the livemark with this folder ID, whether or not it's expired.

Arguments:
folderID: The ID of the folder to be reloaded

void setFeedURI ( PRInt64 container , nsIURI feedURI )

Sets the URI of the feed associated with a livemark container.

NOTE: The caller is responsible for reloading the livemark after changing its feed URI (since the contents are likely to be different given a different feed).

Arguments:
container: The folder ID of a livemark container
feedURI: nsIURI object representing the syndication feed URI

void setSiteURI ( PRInt64 container , nsIURI siteURI )

Sets the URI of the website associated with a livemark container.

Arguments:
container: The folder ID of a livemark container
siteURI: nsIURI object representing the site URI, or null to clear the site URI for this livemark container

void start ( )

Starts the livemark refresh timer. Being able to manually control this allows activity such as bookmarks import to occur without kicking off HTTP traffic.

Reference documentation is generated from Mozilla's source.