userChrome.js作成メモWiki

resource://gre/modules/PlacesUtils.jsm

メソッド

isVirtualLeftPaneItem(guid)

引数：GUID

返り値：真偽値

引数GUIDがライブラリの左ペインにある、履歴、ダウンロード、タグ、すべてのブックマークのどれかに当てはまるかどうか

asContainer(aNode)

コンテナのインターフェースを取得させる

QueryInterface(Ci.nsINavHistoryContainerResultNode)

asQuery(aNode)

クエリのインターフェースを取得させる

QueryInterface(Ci.nsINavHistoryQueryResultNode)

isValidGuid(guid)

引数：文字列

返り値：真偽値

有効なGUIDかどうか

isValidGuidPrefix(guidPrefix)

引数：文字列

返り値：真偽値

GUID用Prefixとして有効かどうか

generateGuidWithPrefix(prefix)

引数：文字列

返り値：指定Prefix付GUID文字列

toURI(url)

引数：文字列 or URLオブジェクト

返り値：nsIURI

toPRTime(date)

引数：Dateオブジェクト

返り値：マイクロ秒数（date*1000）

toDate(time)

引数：マイクロ秒数

返り値：Dateオブジェクト

toISupportsString(aString)

引数：文字列

返り値：nsISupportsString

getFormattedString(key, params)

chrome://places/locale/places.properties の文字列取得

getString(key)

chrome://places/locale/places.properties の文字列取得

parseActionUrl(url)

moz-action URLを解析し、その部分を返す

convertMatchBucketsStringToArray(str)

browser.urlbar.matchBuckets設定で使用されているmatchBuckets文字列を解析

*nodeAncestors(aNode)

引数：Placesノード

返り値：ジェネレーター

ノードの親（祖先）ノードを取得するジェネレーターを返す

validateItemProperties(name, validators, props, behavior = {})

オブジェクトの有効性をチェックし、オプションのプロパティのデフォルト値を入力

QueryInterface(aIID)

registerShutdownFunction(aFunc)

observe(aSubject, aTopic, aData)

getConcreteItemId(aNode)

引数：Placesノード

返り値：ノードのアイテムID

getConcreteItemGuid(aNode)

引数：Placesノード

返り値：ノードのGUID

getReversedHost(url)

ホスト文字列を逆にし、末尾にピリオドを追加

wrapNode(aNode, aType)

unwrapNodes(blob, type)

validatePageInfo(pageInfo, validateVisits = true)

normalizeToURLOrGUID(key)

getFolderContents(aFolderGuid, aExcludeItems, aExpandQueries)

返り値：nsINavHistoryResult

フォルダの内容に対してnsINavHistoryResultを生成

isRootItem(guid)

アイテムがルートかどうか

getContainerNodeWithOptions(aNode, aExcludeItems, aExpandQueries)

返り値：nsINavHistoryContainerResultNode

hasChildURIs(aNode)

引数：コンテナのPlacesノード

返り値：真偽値

コンテナがURIノードを直接持っているかどうか

getURLsForContainerNode(aNode)

引数：コンテナのPlacesノード

返り値：コンテナが直接持っているURIノードの配列

promiseDBConnection()

promiseLargeCacheDBConnection()

promiseUnsafeWritableDBConnection()

async withConnectionWrapper(name, task)

promiseFaviconData(aPageUrl, preferredWidth = 0)

返り値：promise（resolve値：{uri、dataLen、data、mimeType}）

ファビコンデータを取得。ファビコンがない場合はreject

urlWithSizeRef(window, href, size)

promiseItemGuid(aItemId)

引数：アイテムID

返り値：promise（resolve値：GUID）

promiseItemId(aGuid)

引数：GUID

返り値：promise（resolve値：アイテムID）

promiseManyItemIds(aGuids)

引数：GUIDの配列

返り値：promise（resolve値：アイテムIDのMap）

全てのGUIDが見つからなかった場合はreject

invalidateCachedGuidFor(aItemId)

指定アイテムのGUIDキャッシュを無効にする

invalidateCachedGuids()

GUIDキャッシュ全体を無効にする

async promiseBookmarksTree(aItemGuid = "", aOptions = {})

Placesブックマークアイテム（ブックマーク、フォルダ、またはセパレータ）のJSオブジェクト表現とそのすべての子孫を非同期で取得

*chunkArray(array, chunkLength)

「配列」を反復処理し、一度に「chunkLength」要素以下のスライスを生成するジェネレータを返す

Placesノード判別用メソッド

isQueryGeneratedFolder(node)

引数：Placesノード

返り値：真偽値

ノードがクエリから生成されたフォルダかどうか

nodeIsFolder(aNode)

ノードがブックマークフォルダかどうか

nodeIsBookmark(aNode)

ノードがブックマークかどうか

nodeIsSeparator(aNode)

ノードがセパレーターかどうか

nodeIsURI(aNode)

ノードがURIアイテムかどうか

nodeIsQuery(aNode)

ノードがクエリアイテムかどうか

nodeIsHost(aNode)

ノードがクエリアイテムのホストコンテナかどうか

nodeIsDay(aNode)

ノードがクエリアイテムの日付コンテナかどうか

nodeIsTagQuery(aNode)

ノードがクエリアイテムのタグコンテナかどうか

nodeIsContainer(aNode)

ノードがコンテナかどうか

nodeIsHistoryContainer(aNode)

ノードが履歴関連のコンテナかどうか

プロパティ

PlacesUtils.metadata

メソッド

get(key, defaultValue)

set(key, value)

delete(...keys)

async getWithConnection(db, key, defaultValue)

async setWithConnection(db, key, value)

async deleteWithConnection(db, ...keys)

canonicalizeKey(key)

PlacesUtils.keywords

メソッド

fetch(keywordOrEntry, onResult = null)

insert(keywordEntry)

remove(keywordOrEntry)

reassign(oldURL, newURL, source = PlacesUtils.bookmarks.SOURCES.DEFAULT)

removeFromURLsIfNotBookmarked(urls)

eraseEverything()

invalidateCachedKeywords()