nsITaggingService

nsITaggingServiceインタフェースはあるURIに対するタグの付与とその除去を行う機能、与えられたタグからURIを取り出す機能、およびあるURIに関連付けられた全てのタグを取得するメソッドを提供します。

toolkit/components/places/public/nsITaggingService.idlScriptable

Please add a summary to this article.

最終更新: Gecko 1.9 (Firefox 3)

継承元: nsISupports

実装: @mozilla.org/browser/tagging-service;1

このサービスを使うには：

var taggingSvc = Components.classes["@mozilla.org/browser/tagging-service;1"]
                           .getService(Components.interfaces.nsITaggingService);

メソッドの概要

void tagURI(in nsIURI aURI, in nsIVariant aTags);

void untagURI(in nsIURI aURI, in nsIVariant aTags);

nsIVariant getURIsForTag(in AString aTag);

nsIVariant getTagsForURI(in nsIURI aURI);

属性

属性	型	説明
allTags	nsIVariant	URIに付与したタグの全て(名前順でソートされている)
tagContainerIconSpec	AUTF8String	タグコンテナアイコンのURLスペック

メソッド

tagURI()

与えられたタグのセットをあるURIに付与します。URIが持つ現在のタグのセットはそのまま残ります。aTagsに含まれるタグのうち、既に与えられたURIにセットされているものがあればそれは無視されます。

void tagURI(
  in nsIURI aURI,
  in nsIVariant aTags
);

引数

aURI: タグを付与するURI
aTags: 与えられたURIに対して付与するタグの配列(Array)

untagURI()

あるURIからタグを取り除きます。aTagsに含まれるタグのうち、与えられたURIにセットされていないものは無視されます。

void untagURI(
  in nsIURI aURI,
  in nsIVariant aTags
);

引数

aURI: タグを取り除くURI
aTags: URIから取り除くタグの配列(Array)。NULLを渡すことで与えられたURIの全てのタグを取り除きます。

getURIsForTag()

与えられたタグが付与されている全てのURIを取得します。

nsIvariant getURIsForTag(
  in AString aTag
);

引数

aTag: タグ名

戻り値

aTagで指定されたタグが付与された全てのURIの配列

getTagsForURI()

与えられたURIに付与されている全てのタグを取得します。

nsIVariant getTagsForURI(
  in nsIURI aURI
);

引数

aURI: URL

戻り値

aURIで指定されたURLに付与されている全てのタグの配列(名前順でソートされている)