nsMicrosummaryService.js File Reference

Go to the source code of this file.

Functions
Cu	import ("resource://gre/modules/XPCOMUtils.jsm")
function	MicrosummaryService ()
function	LiveTitleNotificationSubject (bookmarkID, microsummary)
function	Microsummary (aPageURI, aGenerator)
function	MicrosummaryGenerator (aURI, aLocalURI, aName)
function	MicrosummarySet ()
function	ArrayEnumerator (aItems)
function	LOG (aText)
function	MicrosummaryResource (uri)
function	getLoadedMicrosummaryResource (uri)
function	getPref (prefName, defaultValue)
function	sanitizeName (aName)
function	NSGetModule (compMgr, fileSpec)

Variables
const	Cc = Components.classes
const	Ci = Components.interfaces
const	Cr = Components.results
const	Cu = Components.utils
const	PERMS_FILE = 0644
const	MODE_WRONLY = 0x02
const	MODE_CREATE = 0x08
const	MODE_TRUNCATE = 0x20
const	NS_ERROR_MODULE_DOM = 2152923136
const	NS_ERROR_DOM_BAD_URI = NS_ERROR_MODULE_DOM + 1012
const	CHECK_INTERVAL = 15 * 1000
const	GENERATOR_INTERVAL = 7 * 86400
const	MICSUM_NS = "http://www.mozilla.org/microsummaries/0.1"
const	XSLT_NS = "http://www.w3.org/1999/XSL/Transform"
const	ANNO_MICSUM_GEN_URI = "microsummary/generatorURI"
const	ANNO_MICSUM_EXPIRATION = "microsummary/expiration"
const	ANNO_STATIC_TITLE = "bookmarks/staticTitle"
const	ANNO_CONTENT_TYPE = "bookmarks/contentType"
const	MAX_SUMMARY_LENGTH = 4096
MicrosummaryService	prototype

Function Documentation

function ArrayEnumerator

(

aItems

)

An enumeration of items in a JS array.

Definition at line 1652 of file nsMicrosummaryService.js.

function getLoadedMicrosummaryResource

(

uri

)

Get a resource currently loaded into a browser window. Checks windows one at a time, starting with the frontmost (a.k.a. most recent) one.

Parameters

uri	the URI of the resource

Returns

a Resource object, if the resource is currently loaded into a browser window; otherwise null

Definition at line 2223 of file nsMicrosummaryService.js.

Here is the call graph for this function:

function getPref	(		prefName,
			defaultValue
	)

Get a value from a pref or a default value if the pref doesn't exist.

Parameters

prefName
defaultValue

Returns

the pref's value or the default (if it is missing)

Definition at line 2254 of file nsMicrosummaryService.js.

Here is the call graph for this function:

Here is the caller graph for this function:

Cu import

(

"resource://gre/modules/XPCOMUtils.jsm"

)

function LiveTitleNotificationSubject	(		bookmarkID,
			microsummary
	)

Definition at line 806 of file nsMicrosummaryService.js.

function LOG

(

aText

)

Outputs aText to the JavaScript console as well as to stdout if the microsummary logging pref (browser.microsummary.log) is set to true.

Parameters

aText

the text to log

Definition at line 1689 of file nsMicrosummaryService.js.

Here is the call graph for this function:

function Microsummary	(		aPageURI,
			aGenerator
	)

Definition at line 823 of file nsMicrosummaryService.js.

function MicrosummaryGenerator	(		aURI,
			aLocalURI,
			aName
	)

Definition at line 1145 of file nsMicrosummaryService.js.

function MicrosummaryResource

(

uri

)

A resource (page, microsummary, generator, etc.) identifiable by URI. This object abstracts away much of the code for loading resources and parsing their content if they are XML or HTML.

Parameters

uri	the location of the resource

Definition at line 1716 of file nsMicrosummaryService.js.

Here is the caller graph for this function:

function MicrosummaryService

(

)

Definition at line 72 of file nsMicrosummaryService.js.

Here is the call graph for this function:

Here is the caller graph for this function:

function MicrosummarySet

(

)

Definition at line 1506 of file nsMicrosummaryService.js.

function NSGetModule	(		compMgr,
			fileSpec
	)

Definition at line 2308 of file nsMicrosummaryService.js.

Here is the call graph for this function:

function sanitizeName

(

aName

)

Removes all characters not in the "chars" string from aName.

Returns

a sanitized name to be used as a filename, or a random name if a sanitized name cannot be obtained (if aName contains no valid characters).

Definition at line 2281 of file nsMicrosummaryService.js.

Variable Documentation

const ANNO_CONTENT_TYPE = "bookmarks/contentType"

Definition at line 66 of file nsMicrosummaryService.js.

const ANNO_MICSUM_EXPIRATION = "microsummary/expiration"

Definition at line 64 of file nsMicrosummaryService.js.

const ANNO_MICSUM_GEN_URI = "microsummary/generatorURI"

Definition at line 63 of file nsMicrosummaryService.js.

const ANNO_STATIC_TITLE = "bookmarks/staticTitle"

Definition at line 65 of file nsMicrosummaryService.js.

const Cc = Components.classes

Definition at line 42 of file nsMicrosummaryService.js.

const CHECK_INTERVAL = 15 * 1000

Definition at line 56 of file nsMicrosummaryService.js.

const Ci = Components.interfaces

Definition at line 43 of file nsMicrosummaryService.js.

const Cr = Components.results

Definition at line 44 of file nsMicrosummaryService.js.

const Cu = Components.utils

Definition at line 45 of file nsMicrosummaryService.js.

const GENERATOR_INTERVAL = 7 * 86400

Definition at line 58 of file nsMicrosummaryService.js.

const MAX_SUMMARY_LENGTH = 4096

Definition at line 68 of file nsMicrosummaryService.js.

const MICSUM_NS = "http://www.mozilla.org/microsummaries/0.1"

Definition at line 60 of file nsMicrosummaryService.js.

const MODE_CREATE = 0x08

Definition at line 49 of file nsMicrosummaryService.js.

const MODE_TRUNCATE = 0x20

Definition at line 50 of file nsMicrosummaryService.js.

const MODE_WRONLY = 0x02

Definition at line 48 of file nsMicrosummaryService.js.

const NS_ERROR_DOM_BAD_URI = NS_ERROR_MODULE_DOM + 1012

Definition at line 53 of file nsMicrosummaryService.js.

const NS_ERROR_MODULE_DOM = 2152923136

Definition at line 52 of file nsMicrosummaryService.js.

const PERMS_FILE = 0644

Definition at line 47 of file nsMicrosummaryService.js.

MicrosummaryResource prototype

Definition at line 86 of file nsMicrosummaryService.js.

const XSLT_NS = "http://www.w3.org/1999/XSL/Transform"

Definition at line 61 of file nsMicrosummaryService.js.