nsITaggingService Interface Reference

import "nsITaggingService.idl";

List of all members.

Public Member Functions
void	tagURI (in nsIURI aURI, in nsIVariant aTags)
void	untagURI (in nsIURI aURI, in nsIVariant aTags)
nsIVariant	getURIsForTag (in AString aTag)
void	getTagsForURI (in nsIURI aURI, out unsigned long length,[retval, array, size_is(length)] out wstring aTags)
Public Attributes
readonly attribute nsIVariant	allTags

---

Detailed Description

Definition at line 45 of file nsITaggingService.idl.

---

Member Function Documentation

void nsITaggingService::getTagsForURI	(	in nsIURI	aURI,
		out unsigned long	length,
		[retval, array, size_is(length)] out wstring	aTags
	)

Retrieves all tags set for the given URL.

Parameters:

aURI

a URL.

Returns:

array of tags (sorted by name).

nsIVariant nsITaggingService::getURIsForTag

(

in AString

aTag

)

Retrieves all URLs tagged with the given tag.

Parameters:

aTag

tag name

Returns:

Array of uris tagged with aTag.

void nsITaggingService::tagURI	(	in nsIURI	aURI,
		in nsIVariant	aTags
	)

Tags a URL with the given set of tags. Current tags set for the URL persist. Tags in aTags which are already set for the given URL are ignored.

Parameters:

	aURI	the URL to tag.
	aTags	Array of tags to set for the given URL. Each element within the array can be either a tag name or a concrete itemId of a tag container.

void nsITaggingService::untagURI	(	in nsIURI	aURI,
		in nsIVariant	aTags
	)

Removes tags from a URL. Tags from aTags which are not set for the given URL are ignored.

Parameters:

	aURI	the URL to un-tag.
	aTags	Array of tags to unset. pass null to remove all tags from the given url. Each element within the array can be either a tag name or a concrete itemId of a tag container.

---

Member Data Documentation

readonly attribute nsIVariant nsITaggingService::allTags

Retrieves all tags used to tag URIs in the data-base (sorted by name).

Definition at line 95 of file nsITaggingService.idl.

---

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

• /Users/dietrich/moz/trunk/mozilla/toolkit/components/places/public/nsITaggingService.idl