Public Member Functions

nsILivemarkService Interface Reference

import "nsILivemarkService.idl";

List of all members.

Public Member Functions

void start ()
 Starts the livemark refresh timer.
void stopUpdateLivemarks ()
 Stop the livemark refresh timer.
long long createLivemark (in long long folder, in AString name, in nsIURI siteURI, in nsIURI feedURI, in long index)
 Creates a new livemark.
long long createLivemarkFolderOnly (in long long folder, in AString name, in nsIURI siteURI, in nsIURI feedURI, in long index)
 Same as above, use during startup to avoid HTTP traffic.
boolean isLivemark (in long long folder)
 Determines whether the folder with the given folder ID identifies a livemark container.
long long getLivemarkIdForFeedURI (in nsIURI aFeedURI)
 Determines whether the feed URI is a currently registered livemark.
nsIURI getSiteURI (in long long container)
 Gets the URI of the website associated with a livemark container.
void setSiteURI (in long long container, in nsIURI siteURI)
 Sets the URI of the website associated with a livemark container.
nsIURI getFeedURI (in long long container)
 Gets the URI of the syndication feed associated with a livemark container.
void setFeedURI (in long long container, in nsIURI feedURI)
 Sets the URI of the feed associated with a livemark container.
void reloadAllLivemarks ()
 Reloads all livemark subscriptions, whether or not they've expired.
void reloadLivemarkFolder (in long long folderID)
 Reloads the livemark with this folder ID, whether or not it's expired.

Member Function Documentation

long long nsILivemarkService::createLivemark ( in long long  folder,
in AString  name,
in nsIURI  siteURI,
in nsIURI  feedURI,
in long  index 
)

Creates a new livemark.

Parameters:
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
Returns:
the ID of the folder for the livemark
long long nsILivemarkService::createLivemarkFolderOnly ( in long long  folder,
in AString  name,
in nsIURI  siteURI,
in nsIURI  feedURI,
in long  index 
)

Same as above, use during startup to avoid HTTP traffic.

nsIURI nsILivemarkService::getFeedURI ( in long long  container  ) 

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

Parameters:
container The folder ID of a livemark container
Returns:
nsIURI representing the URI of the feed; if the livemark container doesn't have a valid feed URI, null will be returned of the nsIURI object returned will be the empty string.
Exceptions:
NS_ERROR_INVALID_ARG if the folder ID isn't known or identifies a folder that isn't a livemark container
NS_ERROR_MALFORMED_URI if the site URI annotation has somehow been corrupted (and can't be turned into an nsIURI)
long long nsILivemarkService::getLivemarkIdForFeedURI ( in nsIURI  aFeedURI  ) 

Determines whether the feed URI is a currently registered livemark.

Parameters:
aFeedURI Feed URI to look for.
Returns:
the found livemark folder id, or -1 if nothing was found.
nsIURI nsILivemarkService::getSiteURI ( in long long  container  ) 

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

Parameters:
container The folder ID of a livemark container
Returns:
nsIURI representing the URI of the website; if the livemark container doesn't have a valid site URI, null will be returned
Exceptions:
NS_ERROR_INVALID_ARG if the folder ID isn't known or identifies a folder that isn't a livemark container
NS_ERROR_MALFORMED_URI if the site URI annotation has somehow been corrupted (and can't be turned into an nsIURI)
boolean nsILivemarkService::isLivemark ( in long long  folder  ) 

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

Parameters:
folder A folder ID
Returns:
true if the given folder is a livemark folder, or false otherwise
Exceptions:
NS_ERROR_INVALID_ARG if the folder ID isn't known
void nsILivemarkService::reloadAllLivemarks (  ) 

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

void nsILivemarkService::reloadLivemarkFolder ( in long long  folderID  ) 

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

Parameters:
folderID The ID of the folder to be reloaded
void nsILivemarkService::setFeedURI ( in long long  container,
in 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).

Parameters:
container The folder ID of a livemark container
feedURI nsIURI object representing the syndication feed URI
Exceptions:
NS_ERROR_INVALID_ARG if the folder ID isn't known or identifies a folder that isn't a livemark container; also if the feedURI argument isn't a valid nsIURI object
void nsILivemarkService::setSiteURI ( in long long  container,
in nsIURI  siteURI 
)

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

Parameters:
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
Exceptions:
NS_ERROR_INVALID_ARG if the folder ID isn't known or identifies a folder that isn't a livemark container; also if the siteURI argument isn't a valid nsIURI object (or null)
void nsILivemarkService::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.

void nsILivemarkService::stopUpdateLivemarks (  ) 

Stop the livemark refresh timer.


The documentation for this interface was generated from the following file: