Search completed in 0.87 seconds.
nsIURI
netwerk/base/public/
nsiuri.idlscriptable this is an interface for an uniform resource identifier with internationalization support, offering attributes that allow setting and querying the basic components of a uri, and methods for performing basic operations on uris.
... inherits from: nsisupports last changed in gecko 6.0 (firefox 6.0 / thunderbird 6.0 / seamonkey 2.3) see the following rfcs for details: rfc3490: internationalizing domain names in applications (idna) rfc3986: uniform resource identifier (uri): generic syntax rfc3987: internationalized resource identifiers subclasses of
nsiuri, such as nsiurl, impose further structure on the uri.
... to create an
nsiuri object, you should use nsiioservice.newuri(), like this: function makeuri(aurl, aorigincharset, abaseuri) { var ioservice = components.classes["@mozilla.org/network/io-service;1"] .getservice(components.interfaces.nsiioservice); return ioservice.newuri(aurl, aorigincharset, abaseuri); } components of a uri prepath path scheme userpass host port ref ftp :// username@password @ hostname : portnumber /pathname?query=value #ref method overview
nsiuri clone();
nsiuri cloneignoringref(); boolean equals(in
nsiuri other); boolean equalsexceptref(in
nsiuri other); autf8string resolve(in autf8string relativepath); ...
...And 8 more matches
nsIURIFixup
docshell/base/
nsiurifixup.idlscriptable interface implemented by objects capable of fixing up strings into uris.
... inherits from: nsisupports last changed in gecko 9.0 (firefox 9.0 / thunderbird 9.0 / seamonkey 2.6) implemented by: @mozilla.org/docshell/urifixup;1 as a service: var urifixup = components.classes["@mozilla.org/docshell/urifixup;1"] .createinstance(components.interfaces.
nsiurifixup); method overview
nsiuri createexposableuri(in
nsiuri auri);
nsiuri createfixupuri(in autf8string auritext, in unsigned long afixupflags);
nsiuri keywordtouri(in autf8string akeyword);
nsiurifixupinfo getfixupuriinfo(in autf8string auritext, in unsigned long afixupflags); constants constant value description fixup_flag_none 0 no fixup flags.
...
nsiuri createexposableuri( in
nsiuri auri ); parameters auri the uri to be converted.
...And 5 more matches
nsIURIFixupInfo
docshell/base/
nsiurifixup.idlscriptable interface indicating what we found/corrected when fixing up a uri.
... preferreduri
nsiuri best guess of what uri consumer expects.
... fixeduri
nsiuri the fixed-up original input, *never* using a keyword search.
nsINavBookmarksService
: var navbookmarksservice = components.classes["@mozilla.org/browser/nav-bookmarks-service;1"] .getservice(components.interfaces.nsinavbookmarksservice); method overview void addobserver(in nsinavbookmarkobserver observer, in boolean ownsweak); void beginupdatebatch(); obsolete since gecko 1.9 void changebookmarkuri(in long long aitemid, in
nsiuri anewuri); long long createdynamiccontainer(in long long aparentfolder, in autf8string aname, in astring acontractid, in long aindex); note: renamed from createcontainer in gecko 1.9 obsolete since gecko 13.0 long long createfolder(in long long aparentfolder, in autf8string name, in long index); void endupdatebatch(); obsolete since gecko 1.9 void exportbookmark...
...shtml(in nsifile file); obsolete since gecko 1.9
nsiuri getbookmarkedurifor(in
nsiuri auri); void getbookmarkfolderstarray(in
nsiuri auri, in print64array aresult); native code only!
... obsolete since gecko 1.9 void getbookmarkidsforuri(in
nsiuri auri, [optional] out unsigned long count, [array, retval, size_is(count)] out long long bookmarks); note: renamed from getbookmarkfolders in gecko 1.9 void getbookmarkidsforuritarray(in
nsiuri auri, in print64array aresult); native code only!
...And 27 more matches
nsIAnnotationService
method overview void setpageannotation(in
nsiuri auri, in autf8string aname, in nsivariant avalue, in long aflags, in unsigned short aexpiration); void setitemannotation(in long long aitemid, in autf8string aname, in nsivariant avalue, in long aflags, in unsigned short aexpiration); void setpageannotationstring(in
nsiuri auri, in autf8string aname, in astring avalue, in long aflags, in unsigned short aexpiration); boo...
...lean setitemannotationstring(in long long aitemid, in autf8string aname, in astring avalue, in long aflags, in unsigned short aexpiration); void setpageannotationint32(in
nsiuri auri, in autf8string aname, in long avalue, in long aflags, in unsigned short aexpiration); void setitemannotationint32(in long long aitemid, in autf8string aname, in long avalue, in long aflags, in unsigned short aexpiration); void setpageannotationint64(in
nsiuri auri, in autf8string aname, in long long avalue, in long aflags, in unsigned short aexpiration); void setitemannotationint64(in long long aitemid, in autf8string aname, in long long avalue, in long aflags, in unsigned short aexpiration); void setpageannotationdouble(in
nsiuri auri, in autf8string aname, in double av...
...alue, in long aflags, in unsigned short aexpiration); void setitemannotationdouble(in long long aitemid, in autf8string aname, in double avalue, in long aflags, in unsigned short aexpiration); void setpageannotationbinary(in
nsiuri auri, in autf8string aname,[const, array, size_is(adatalen)] in octet adata, in unsigned long adatalen, in autf8string amimetype, in long aflags, in unsigned short aexpiration); void setitemannotationbinary(in long long aitemid, in autf8string aname,[const, array, size_is(adatalen)] in octet adata, in unsigned long adatalen, in autf8string amimetype, in long aflags, in unsigned short aexpiration); nsivariant getpageannotation(in
nsiuri auri, in autf8string aname); nsivariant getitemannotation(in long long aitemid, in autf8s...
...And 25 more matches
nsIMsgMessageService
inherits from: nsisupports method overview void copymessage(in string asrcuri, in nsistreamlistener acopylistener, in boolean amovemessage, in nsiurllistener aurllistener, in nsimsgwindow amsgwindow, out
nsiuri aurl); [noscript] void copymessages(in nsmsgkeyarrayptr keys, in nsimsgfolder srcfolder, in nsistreamlistener acopylistener, in boolean amovemessage, in nsiurllistener aurllistener, in nsimsgwindow amsgwindow, out
nsiuri aurl); void displaymessage(in string amessageuri, in nsisupports adisplayconsumer, in nsimsgwindow amsgwindow, in nsiurllistener aurllistener, in string acharse...
...toverride, out
nsiuri aurl); void openattachment(in string acontenttype, in string afilename, in string aurl, in string amessageuri, in nsisupports adisplayconsumer, in nsimsgwindow amsgwindow, in nsiurllistener aurllistener); void savemessagetodisk(in string amessageuri, in nsifilespec afile, in boolean ageneratedummyenvelope, in nsiurllistener aurllistener, out
nsiuri aurl, in boolean canonicallineending, in nsimsgwindow amsgwindow); void geturlforuri(in string amessageuri, out
nsiuri aurl, in nsimsgwindow amsgwindow); void displaymessageforprinting(in string amessageuri, in nsisupports adisplayconsumer, in nsimsgwindow amsgwindow, in nsiurllistener aurllistener, out
nsiuri aurl); void search(in nsimsgsearchsession asearchsession, in nsimsgwindow am...
...sgwindow, in nsimsgfolder amsgfolder, in string asearchuri);
nsiuri streammessage(in string amessageuri, in nsisupports aconsumer, in nsimsgwindow amsgwindow, in nsiurllistener aurllistener, in boolean aconvertdata, in string aadditionalheader);
nsiuri streamheaders(in string amessageuri, in nsistreamlistener aconsumer, in nsiurllistener aurllistener [optional] in boolean alocalonly); boolean ismsginmemcache(in
nsiuri aurl, in nsimsgfolder afolder, out nsicacheentrydescriptor acacheentry); nsimsgdbhdr messageuritomsghdr(in string uri); methods copymessage() pass in the uri for the message you want to have copied.
...And 15 more matches
nsIIOService
.getservice(components.interfaces.nsiioservice); method overview boolean allowport(in long aport, in string ascheme); acstring extractscheme(in autf8string urlstring); unsigned long getprotocolflags(in string ascheme); nsiprotocolhandler getprotocolhandler(in string ascheme); nsichannel newchannel(in autf8string aspec, in string aorigincharset, in
nsiuri abaseuri); obsolete since gecko 48 nsichannel newchannel2(in autf8string aspec, in string aorigincharset, in
nsiuri abaseuri, in nsidomnode aloadingnode, in nsiprincipal aloadingprincipal, in nsiprincipal atriggeringprincipal, in uint32_t asecurityflags, in uint32_t acontentpolicytype); nsichannel newchannelfromuri(in
nsiuri auri); obsolete since gecko 48 nsichannel ne...
...wchannelfromuri2(in
nsiuri auri, in nsidomnode aloadingnode, in nsiprincipal aloadingprincipal, in nsiprincipal atriggeringprincipal, in unsigned long asecurityflags, in unsigned long acontentpolicytype); nsichannel newchannelfromuriwithloadinfo(in
nsiuri auri, in nsiloadinfo aloadinfo); nsichannel newchannelfromuriwithproxyflags2(in
nsiuri auri, in
nsiuri aproxyuri, in uint32_t aproxyflags,in nsidomnode aloadingnode, in nsiprincipal aloadingprincipal, in nsiprincipal atriggeringprincipal, in uint32_t asecurityflags, in uint32_t acontentpolicytype);
nsiuri newfileuri(in nsifile afile);
nsiuri newuri(in autf8string aspec, in string aorigincharset, in
nsiuri abaseuri); attributes attribute type description offline boolean r...
... note: most url parsing is done via
nsiuri, and in fact the scheme can also be extracted from a url string via
nsiuri.
...And 14 more matches
nsILivemarkService
to use this service, use: var livemarkservice = components.classes["@mozilla.org/browser/livemark-service;2"] .getservice(components.interfaces.nsilivemarkservice); method overview long long createlivemark(in long long folder, in astring name, in
nsiuri siteuri, in
nsiuri feeduri, in long index); long long createlivemarkfolderonly(in long long folder, in astring name, in
nsiuri siteuri, in
nsiuri feeduri, in long index);
nsiuri getfeeduri(in long long container); long long getlivemarkidforfeeduri(in
nsiuri afeeduri);
nsiuri getsiteuri(in long long container); boolean islivemark(in long long folder);...
... void reloadalllivemarks(); void reloadlivemarkfolder(in long long folderid); void setfeeduri(in long long container, in
nsiuri feeduri); void setsiteuri(in long long container, in
nsiuri siteuri); void start(); void stopupdatelivemarks(); methods createlivemark() creates a new livemark.
... long long createlivemark( in long long folder, in astring name, in
nsiuri siteuri, in
nsiuri feeduri, in long index ); parameters folder the id of the parent folder.
...And 14 more matches
Finishing the Component
in the weblock component, the shouldload method looks like this: ns_imethodimp weblock::shouldload(print32 contenttype,
nsiuri *contentlocation, nsisupports *ctxt, nsidomwindow *window, prbool *_retval) uniform resource locators the method passes in an interface pointer of type
nsiuri, which is based on the uniform resource identifier, or uri.
... gecko encapsulates these identifiers into two interfaces,
nsiuri and nsiurl.
...when you pass that string to necko, it creates an object that implements at least the
nsiuri interface (and perhaps other interfaces as well).
...And 12 more matches
nsIFaviconService
to use this service, use: var faviconservice = components.classes["@mozilla.org/browser/favicon-service;1"] .getservice(components.interfaces.nsifaviconservice); method overview void addfailedfavicon(in
nsiuri afaviconuri); void expireallfavicons(); void getfavicondata(in
nsiuri afaviconuri, out autf8string amimetype, [optional] out unsigned long adatalen, [array,retval,size_is(adatalen)] out octet adata); obsolete since gecko 22.0 astring getfavicondataasdataurl(in
nsiuri afaviconuri); obsolete since gecko 22.0
nsiuri getfaviconforpage(in
nsiuri apageuri); obsolet...
...e since gecko 22.0
nsiuri getfaviconimageforpage(in
nsiuri apageuri); obsolete since gecko 22.0
nsiuri getfaviconlinkforicon(in
nsiuri afaviconuri); boolean isfailedfavicon(in
nsiuri afaviconuri); void removefailedfavicon(in
nsiuri afaviconuri); void setandloadfaviconforpage(in
nsiuri apageuri, in
nsiuri afaviconuri, in boolean aforcereload, in unsigned long afaviconloadtype, [optional] in nsifavicondatacallback acallback); obsolete since gecko 22.0 void setfavicondata(in
nsiuri afaviconuri, [const,array,size_is(adatalen)] in octet adata, in unsigned long adatalen, in autf8string amimetype, in prtime aexpiration); obsolete since gecko 22.0 void setfavicondatafromdataurl(in
nsiuri afaviconuri, in astring adataurl, in prtime aexpiratio...
...n); obsolete since gecko 22.0 void setfaviconurlforpage(in
nsiuri apageuri, in
nsiuri afaviconuri); obsolete since gecko 22.0 attributes attribute type description defaultfavicon
nsiuri the default favicon uri.
...And 12 more matches
Places utilities for JavaScript
placesutils method overview
nsiuri createfixeduri(string aspec); string getformattedstring(string key, string params); string getstring(string key); boolean nodeisfolder(nsinavhistoryresultnode anode); boolean nodeisbookmark(nsinavhistoryresultnode anode); boolean nodeisseparator(nsinavhistoryresultnode anode); boolean nodeisvisit(nsinavhistoryresultnode anode); boolea...
...ode); boolean nodeislivemarkcontainer(nsinavhistoryresultnode anode); obsolete since gecko 21 boolean nodeislivemarkitem(nsinavhistoryresultnode anode); obsolete since gecko 21 boolean isreadonlyfolder(nsinavhistoryresultnode anode); int getindexofnode(nsinavhistoryresultnode anode); string wrapnode(nsinavhistoryresultnode anode, string atype,
nsiuri aoverrideuri); array unwrapnodes(string blob, string atype); nsitransaction maketransaction(string data, string type, nsinavhistoryresultnode container, int index, boolean copy); nsinavhistoryresult getfoldercontents(int afolderid, boolean aexcludeitems, boolean aexpandqueries); boolean showaddbookmarkui(
nsiuri auri, string atitle, string adescription, int adef...
...aultinsertionpoint, boolean ashowpicker, boolean aloadinsidebar, string akeyword, string apostdata); boolean showminimaladdbookmarkui(
nsiuri auri, string atitle, string adescription, int adefaultinsertionpoint, boolean ashowpicker, boolean aloadinsidebar, string akeyword, string apostdata); boolean showaddlivemarkui(
nsiuri afeeduri,
nsiuri asiteuri, string atitle, string adescription, int adefaultinsertionpoint, boolean ashowpicker); boolean showminimaladdlivemarkui(
nsiuri afeeduri,
nsiuri asiteuri, string atitle, string adescription, int adefaultinsertionpoint, boolean ashowpicker); boolean showminimaladdmultibookmarkui(array
nsiuri aurilist); boolean showbookmarkproperties(int aid); boolean showfolderproperties(int aid); boolean sh...
...And 11 more matches
nsIContentPrefService
note: prior to gecko 2.0, the site could only be specified by
nsiuri.
...exceptions thrown ns_error_illegal_value if agroup is not a string,
nsiuri, or null.
... note: prior to gecko 2.0, the site could only be specified by
nsiuri.
...And 7 more matches
nsIDocShell
obsolete since gecko 1.8 nsisimpleenumerator getdocshellenumerator(in long aitemtype, in long adirection); nsidomstorage getsessionstorageforprincipal(in nsiprincipal principal, in domstring documenturi, in boolean create); nsidomstorage getsessionstorageforuri(in
nsiuri uri, in domstring documenturi); void historypurged(in long numentries); void internalload(in
nsiuri auri, in
nsiuri areferrer, in nsisupports aowner, in pruint32 aflags, in wstring awindowtarget, in string atypehint, in nsiinputstream apostdatastream, in nsiinputstream aheadersstream, in unsigned long aloadflags, in nsishentry ashentry, in boolean firstparty, out nsidocshell a...
... boolean isbeingdestroyed(); void loadstream(in nsiinputstream astream, in
nsiuri auri, in acstring acontenttype, in acstring acontentcharset, in nsidocshellloadinfo aloadinfo); native code only!
... void loaduri(in
nsiuri uri, in nsidocshellloadinfo loadinfo, in unsigned long aloadflags, in boolean firstparty); native code only!
...And 7 more matches
nsINavHistoryService
to use this service, use: var historyservice = components.classes["@mozilla.org/browser/nav-history-service;1"] .getservice(components.interfaces.nsinavhistoryservice); method overview astring getpagetitle(in
nsiuri auri); void markpageasfollowedbookmark(in
nsiuri auri); void markpageasfollowedlink(in
nsiuri auri); void markpageastyped(in
nsiuri auri); boolean canadduri(in
nsiuri auri); long long addvisit(in
nsiuri auri, in prtime atime, in
nsiuri areferringuri, in long atransitiontype, in boolean aisredirect, in long long asessionid); obsolete since gecko 22.0 ...
...es, in unsigned long aquerycount, in nsinavhistoryqueryoptions options); void addobserver(in nsinavhistoryobserver observer, in boolean ownsweak); void removeobserver(in nsinavhistoryobserver observer); void runinbatchmode(in nsinavhistorybatchcallback acallback, in nsisupports aclosure); void importhistory(in nsifile file); astring getcharsetforuri(in
nsiuri auri); astring setcharsetforuri(in
nsiuri auri, in astring acharset); attributes attribute type description hashistoryentries boolean true if there is any history.
... astring getpagetitle( in
nsiuri auri ); parameters auri the page whose title needs to be retrieved.
...And 7 more matches
Document Loading - From Load Start to Finding a Handler - Archive of obsolete content
nsuriloader this is a service implementing
nsiuriloader.
...
nsiuricontentlistener implementations we try to find one of these which can handle data of the type we're looking at (that is, it can give us an nsistreamlistener to pump data into).
...service" coords="527,305,839,339" href="#nsiexternalhelperappservice"> <area alt="category manager" coords="683,467,807,527" href="#nscategorymanager"> <area alt="nsdocumentopeninfo" coords="371,71,635,185" href="#nsdocumentopeninfo"> <area alt="necko" coords="721,113,821,157" href="#necko"> <area alt="nsuriloader" coords="23,335,215,455" href="#nsuriloader"> <area coords="227,515,485,575" href="#
nsiuricontentlistener"> <area alt="nsdocshell" coords="47,83,203,153" href="#nsdocshell"></map> this block diagram is out of date as of january 2012 with regard to some minor control flow shuffling in nsuriloader.
...And 6 more matches
NetUtil.jsm
method overview nsiasyncstreamcopier asynccopy(nsiinputstream asource, nsioutputstream asink, [optional] acallback) void asyncfetch(asource, acallback) nsichannel newchannel(awhattoload, [optional] aorigincharset, [optional]
nsiuri abaseuri)
nsiuri newuri(atarget, [optional] aorigincharset, [optional]
nsiuri abaseuri) string readinputstreamtostring(ainputstream, acount, aoptions) attributes attribute type description ioservice nsiioservice returns a reference to nsiioservice.
...this may be specified as an
nsiuri, nsifile, nsichannel, nsiinputstream or as a string specifying the url to open.
... newchannel() creates a new channel for the specified uri string,
nsiuri, or nsifile.
...And 6 more matches
nsIBrowserHistory
to use this service, use: var browserhistory = components.classes["@mozilla.org/browser/nav-history-service;1"] .getservice(components.interfaces.nsibrowserhistory); method overview void addpagewithdetails(in
nsiuri auri, in wstring atitle, in long long alastvisited); obsolete since gecko 15.0 void markpageasfollowedlink(in
nsiuri auri); obsolete since gecko 22.0 void markpageastyped(in
nsiuri auri); obsolete since gecko 22.0 void registeropenpage(in
nsiuri auri); obsolete since gecko 9.0 void removeallpages(); void removepage(in
nsiuri auri); void remo...
...vepages([array, size_is(alength)] in
nsiuri auris, in unsigned long alength, in boolean adobatchnotify); void removepagesbytimeframe(in long long abegintime, in long long aendtime); void removepagesfromhost(in autf8string ahost, in boolean aentiredomain); void removevisitsbytimeframe(in long long abegintime, in long long aendtime); void unregisteropenpage(in
nsiuri auri); obsolete since gecko 9.0 note: the markpageasfollowedlink and markpageastyped methods were moved to nsinavhistoryservice in gecko 22.0 so that all markpageas* methods can be found in one interface.
... void addpagewithdetails( in
nsiuri auri, in wstring atitle, in long long alastvisited ); parameters auri the page that will be added to the history.
...And 6 more matches
nsINavHistoryObserver
method overview void onbeforedeleteuri(in
nsiuri auri, in acstring aguid); obsolete since gecko 21.0 void onbeginupdatebatch(); void onclearhistory(); void ondeleteuri(in
nsiuri auri, in acstring aguid); void ondeletevisits(in
nsiuri auri, in prtime avisittime, in acstring aguid); void onendupdatebatch(); void onpagechanged(in
nsiuri auri, in unsigned long awhat, in astring avalue); ...
... void onpageexpired(in
nsiuri auri, in prtime avisittime, in boolean awholeentry); obsolete since gecko 2.0 void ontitlechanged(in
nsiuri auri, in astring apagetitle); void onvisit(in
nsiuri auri, in long long avisitid, in prtime atime, in long long asessionid, in long long areferringid, in unsigned long atransitiontype, in acstring aguid, out unsigned long aadded); constants constant value description attribute_favicon 3 the page's favicon changed.
... note: see using onbeforedeleteuri() in gecko 1.9.1 for how to implement this in gecko 1.9.1 void onbeforedeleteuri( in
nsiuri auri, in acstring aguid ); parameters auri the uri of the page about to be deleted.
...And 6 more matches
Places Developer Guide
collection of wrapper apis for easing access to a number of firefox utilities and services nsiplacestransactionsservice - a firefox service for modifying bookmarks in a transactional manner, providing facilities for undo/redo places utilities for javascript - accessors and helper functions for firefox and extensions creating bookmarks, folders and other items creating a bookmark // create an
nsiuri for the url to be bookmarked.
... bookmarkuri, // the uri of the bookmark - an
nsiuri object.
...a
nsiuri object.
...And 4 more matches
mozIAsyncFavicons
method overview void getfaviconurlforpage(in
nsiuri apageuri, in nsifavicondatacallback acallback); void getfavicondataforpage(in
nsiuri apageuri, in nsifavicondatacallback acallback); void setandfetchfaviconforpage(in
nsiuri apageuri, in
nsiuri afaviconuri, in boolean aforcereload, in unsigned long afaviconloadtype, [optional] in nsifavicondatacallback acallback); void replacefavicondata(in
nsiuri ...
...afaviconuri, [const,array,size_is(adatalen)] in octet adata, in unsigned long adatalen, in autf8string amimetype, [optional] in prtime aexpiration); void replacefavicondatafromdataurl(in
nsiuri afaviconuri, in astring adataurl, [optional] in prtime aexpiration); methods getfaviconurlforpage() retrieve the url of the favicon for the given page.
... void getfaviconurlforpage( in
nsiuri apageuri, in nsifavicondatacallback acallback ); parameters apageuri uri of the page whose favicon's url we're looking up.
...And 4 more matches
nsINavBookmarkObserver
ecko 1.9 void onfoldermoved(in print64 folder, in print64 oldparent, in print32 oldindex, in print64 newparent, in print32 newindex); obsolete since gecko 1.9 void onfolderremoved(in print64 folder, in print64 parent, in print32 index); obsolete since gecko 1.9 void onitemadded(in long long aitemid, in long long aparentid, in long aindex, in unsigned short aitemtype, in
nsiuri auri, in autf8string atitle, in prtime adateadded, in acstring aguid, in acstring aparentguid); void onitemchanged(in long long aitemid, in acstring aproperty, in boolean aisannotationproperty, in autf8string anewvalue, in prtime alastmodified, in unsigned short aitemtype, in long long aparentid, in acstring aguid, in acstring aparentguid); void onitemmoved(in long long aitemid,...
... in long long aoldparentid, in long aoldindex, in long long anewparentid, in long anewindex, in unsigned short aitemtype, in acstring aguid, in acstring aoldparentguid, in acstring anewparentguid); void onitemremoved(in long long aitemid, in long long aparentid, in long aindex, in unsigned short aitemtype, in
nsiuri auri, in acstring aguid, in acstring aparentguid); void onitemreplaced(in print64 folder, in
nsiuri item, in
nsiuri newitem); obsolete since gecko 1.9 void onitemvisited(in long long aitemid, in long long avisitid, in prtime atime, in unsigned long atransitiontype, in
nsiuri auri, in long long aparentid, in acstring aguid, in acstring aparentguid); void onseparatoradded(in print64 parent, in print32 index); obsolete since gecko 1.9 void o...
...void onitemadded( in long long aitemid, in long long aparentid, in long aindex, in unsigned short aitemtype, in
nsiuri auri, in autf8string atitle, in prtime adateadded, in acstring aguid, in acstring aparentguid ); parameters aitemid the id of the item that was added.
...And 4 more matches
nsIPermissionManager
last changed in gecko 16 (firefox 16 / thunderbird 16 / seamonkey 2.13) inherits from: nsisupports method overview void add(in
nsiuri uri, in string type, in pruint32 permission, [optional] in pruint32 expiretype, [optional] in print64 expiretime); void addfromprincipal(in nsiprincipal principal, in string type, in pruint32 permission, [optional] in pruint32 expiretype, [optional] in print64 expiretime); void remove(in autf8string host, in string type); void removefromprincipal(in nsiprincipal p...
...rincipal, in string type); void removepermission(in nsipermission perm); void removeallsince(in int64_t since); void removeall(); pruint32 testexactpermission(in
nsiuri uri, in string type); pruint32 testexactpermissionfromprincipal(in nsiprincipal principal, in string type); pruint32 testpermission(in
nsiuri uri, in string type); pruint32 testpermissionfromprincipal(in nsiprincipal principal, in string type); attributes attribute type description enumerator nsisimpleenumerator enumerates all stored permissions.
... void add( in
nsiuri uri, in string type, in pruint32 permission, [optional] in pruint32 expiretype, [optional] in print64 expiretime ); parameters uri the uri to add the permission for.
...And 4 more matches
Creating Sandboxed HTTP Connections
setting up an http connection the first step in setting up an http connection from an url (stored in a string) is to create an
nsiuri out of it.
...
nsiuri is an xpcom representation of an uri, with useful methods to query and manipulate the uri.
... to create an
nsiuri from an string, we use the newuri method of nsiioservice: // the io service var ioservice = components.classes["@mozilla.org/network/io-service;1"] .getservice(components.interfaces.nsiioservice); // create an
nsiuri var uri = ioservice.newuri(myurlstring, null, null); once the
nsiuri has been created, a nsichannel can be generated from it using nsiioservice's newchannelfromuri method: // get a channel for that
nsiuri var channel = ioservice.newchannelfromuri(uri); to initiate the connection, the asyncopen method is called.
...And 3 more matches
nsIChromeRegistry
inherits from: nsisupports last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) implemented by: @mozilla.org/chrome/chrome-registry;1 as a service: var chromeregistry = components.classes["@mozilla.org/chrome/chrome-registry;1"] .getservice(components.interfaces.nsichromeregistry); method overview void canonify(in
nsiuri achromeurl); obsolete since gecko 1.8 void checkfornewchrome();
nsiuri convertchromeurl(in
nsiuri achromeurl); boolean wrappersenabled(in
nsiuri auri); violates the xpcom interface guidelines constants constant value description none 0 partial 1 full 2 methods canonify() obso...
... void canonify( in
nsiuri achromeurl ); parameters achromeurl the url that is to be canonified.
...a new
nsiuri is returned; the original is left unmodified.
...And 3 more matches
nsICookieService
an
nsiuri interface pointer representing the uri that attempted to set the cookie.
... method overview string getcookiestring(in
nsiuri auri, in nsichannel achannel); string getcookiestringfromhttp(in
nsiuri auri, in
nsiuri afirsturi, in nsichannel achannel); void setcookiestring(in
nsiuri auri, in nsiprompt aprompt, in string acookie, in nsichannel achannel); void setcookiestringfromhttp(in
nsiuri auri, in
nsiuri afirsturi, in nsiprompt aprompt, in string acookie, in string aservertime, in nsichannel achannel); attributes attribute type description cookieiconisvisible boolean this attribute really doesn't belong on this interface.
... string getcookiestring( in
nsiuri auri, in nsichannel achannel ); parameters auri the uri of the document for which cookies are being queried.
...And 3 more matches
nsIFileProtocolHandler
netwerk/protocol/file/nsifileprotocolhandler.idlscriptable this interface provides methods to convert between nsifile and
nsiuri.
... inherits from: nsiprotocolhandler last changed in gecko 1.9.2 (firefox 3.6 / thunderbird 3.1 / fennec 1.0) method overview nsifile getfilefromurlspec(in autf8string url); autf8string geturlspecfromactualfile(in nsifile file); autf8string geturlspecfromdir(in nsifile file); autf8string geturlspecfromfile(in nsifile file);
nsiuri newfileuri(in nsifile afile);
nsiuri readurlfile(in nsifile file); methods getfilefromurlspec() converts the url string into the corresponding nsifile if possible.
...
nsiuri newfileuri( in nsifile afile ); parameters afile the nsifile to convert.
...And 3 more matches
nsIMicrosummaryService
(firefox 3) warning: microsummary support was removed in gecko 6.0 (firefox 6.0 / thunderbird 6.0 / seamonkey 2.3) implemented by: @mozilla.org/microsummary/service;1 as a service: var microsummaryservice = components.classes["@mozilla.org/microsummary/service;1"] .getservice(components.interfaces.nsimicrosummaryservice); method overview void addgenerator(in
nsiuri generatoruri); nsimicrosummary createmicrosummary(in
nsiuri pageuri, in
nsiuri generatoruri); nsisimpleenumerator getbookmarks(); nsimicrosummarygenerator getgenerator(in
nsiuri generatoruri); nsimicrosummaryset getmicrosummaries(in
nsiuri pageuri, in long long bookmarkid); nsimicrosummary getmicrosummary(in long long bookmarkid); boolean ha...
...void addgenerator( in
nsiuri generatoruri ); parameters generatoruri the uri of the resource providing the generator.
...nsimicrosummary createmicrosummary( in
nsiuri pageuri, in
nsiuri generatoruri ); parameters pageuri the uri of the page to be summarized.
...And 3 more matches
nsIPluginHost
void instantiateembeddedplugin(in string amimetype, in
nsiuri aurl, in nsiplugininstanceowner aowner); native code only!
... void instantiateembededplugin(in string amimetype, in
nsiuri aurl, in nsiplugininstanceowner aowner); obsolete since gecko 1.8 void instantiatefullpageplugin(in string amimetype, in
nsiuri auri, in nsiplugininstanceowner aowner, out nsistreamlistener astreamlistener); native code only!
... obsolete since gecko 2.0 void setupplugininstance(in string amimetype, in
nsiuri aurl, in nsiplugininstanceowner aowner); native code only!
...And 3 more matches
nsISHistoryListener
method overview boolean onhistorygoback(in
nsiuri abackuri); boolean onhistorygoforward(in
nsiuri aforwarduri); boolean onhistorygotoindex(in long aindex, in
nsiuri agotouri); void onhistorynewentry(in
nsiuri anewuri); boolean onhistorypurge(in long anumentries); boolean onhistoryreload(in
nsiuri areloaduri, in unsigned long areloadflags); methods onhistorygoback() called when navigating to a previous session history entry, for exam...
...boolean onhistorygoback( in
nsiuri abackuri ); parameters abackuri the uri of the session history entry being navigated to.
...boolean onhistorygoforward( in
nsiuri aforwarduri ); parameters aforwarduri the uri of the session history entry being navigated to.
...And 3 more matches
nsIWebBrowserPersist
teinstance(components.interfaces.nsiwebbrowserpersist); method overview void cancelsave(); void savechannel(in nsichannel achannel, in nsisupports afile); void savedocument(in nsidomdocument adocument, in nsisupports afile, in nsisupports adatapath, in string aoutputcontenttype, in unsigned long aencodingflags, in unsigned long awrapcolumn); void saveuri(in
nsiuri auri, in nsisupports acachekey, in
nsiuri areferrer, in long areferrerpolicy, in nsiinputstream apostdata, in string aextraheaders, in nsisupports afile, in nsiloadcontext aprivacycontext); void saveprivacyawareuri(in
nsiuri auri, in nsisupports acachekey, in
nsiuri areferrer, in long areferrerpolicy, in nsiinputstream apostdata, in string aextraheaders, in nsisupports afile, in boolean ...
...this may be a nsilocalfile object or an
nsiuri object with a file scheme.
...this may be a nsilocalfile object or an
nsiuri object with a file scheme or a scheme that supports uploading (for example ftp).
...And 3 more matches
URIs and URLs - Archive of obsolete content
nsiuri and nsiurl in a strict sense necko does only know urls, uris by the above definition are much too generic to be properly represented inside a library.
... there are however two interfaces which loosely relate to the distinction between uri and url as per the above definition:
nsiuri and nsiurl.
...
nsiuri represents access to a very simple, very generic form of an url.
...And 2 more matches
Addon
overview of required methods void iscompatiblewith(in string appversion, in string platformversion) void findupdates(in updatelistener listener, in integer reason, in string appversion, in string platformversion) overview of optional methods void uninstall() void canceluninstall() boolean hasresource(in string path)
nsiuri getresourceuri(in string path) void getdatadirectory(in datadirectorycallback callback) required properties attribute type description appdisabled read only boolean true if this add-on cannot be used in the application based on version compatibility, dependencies, and blocklisting.
... releasenotesuri read only
nsiuri a uri for release notes for this version.
... sourceuri read only
nsiuri the uri that this add-on was installed from.
...And 2 more matches
AddonManager
callback) void installaddonsfromwebpage(in string mimetype, in nsidomwindow source, in
nsiuri uri, in addoninstall installs[]) void addinstalllistener(in installlistener listener) void removeinstalllistener(in installlistener listener) promise?
...callback) void addaddonlistener(in addonlistener listener) void removeaddonlistener(in addonlistener listener) void addtypelistener(in typelistener listener) void removetypelistener(in typelistener listener)
nsiuri geturiforresourceinfile(in nsifile afile, in string apath) properties overview attribute type description addontypes dictionary a dictionary that maps type id to addontype.
... void installaddonsfromwebpage( in string mimetype, in nsidomwindow source, in
nsiuri uri, in addoninstall installs[] ) parameters mimetype the mimetype of add-ons being installed source the nsidomwindow that started the installs uri the
nsiuri that started the installs installs the array of addoninstalls to be installed addinstalllistener() adds a new installlistener if the listener is not already registered.
...And 2 more matches
nsIContentSecurityPolicy
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview boolean permitsancestry(in nsidocshell docshell); void refinepolicy(in astring policystring, in
nsiuri selfuri); void scanrequestdata(in nsihttpchannel achannel); void sendreports(in astring blockeduri, in astring violateddirective); short shouldload(in unsigned long acontenttype, in
nsiuri acontentlocation, in
nsiuri arequestorigin, in nsisupports acontext, in acstring amimetypeguess, in nsisupports aextra); short shouldprocess(in unsigned long acontenttype, in
nsiuri acontentlocation, in...
...
nsiuri arequestorigin, in nsisupports acontext, in acstring amimetype, in nsisupports aextra); attributes attribute type description allowseval boolean whether this policy allows eval and eval-like functions such as settimeout("code string", time).
...void refinepolicy( in astring policystring, in
nsiuri selfuri ); parameters policystring selfuri scanrequestdata() called after the content security policy object is created to fill in the appropriate request and request header information needed in case a report needs to be sent.
...And 2 more matches
nsICookiePermission
last changed in gecko 1.9 (firefox 3) inherits from: nsisupports method overview nscookieaccess canaccess(in
nsiuri auri, in nsichannel achannel); boolean cansetcookie(in
nsiuri auri, in nsichannel achannel, in nsicookie2 acookie, inout boolean aissession, inout print64 aexpiry);
nsiuri getoriginatinguri(in nsichannel achannel); void setaccess(in
nsiuri auri, in nscookieaccess aaccess); constants constant value description access_default 0 nscookieaccess's access default value access_allow 1 nscookieaccess's access allow value access_deny 2 nscookieaccess's access deny value access_session 8 additi...
...nscookieaccess canaccess( in
nsiuri auri, in
nsiuri afirsturi, obsolete since gecko 1.9 in nsichannel achannel ); parameters auri the uri trying to access cookies.
...boolean cansetcookie( in
nsiuri auri, in nsichannel achannel, in nsicookie2 acookie, inout boolean aissession, inout print64 aexpiry ); parameters auri the uri trying to set the cookie.
...And 2 more matches
nsIEffectiveTLDService
method overview acstring getbasedomain(in
nsiuri auri, [optional] in pruint32 aadditionalparts); acstring getbasedomainfromhost(in autf8string ahost, [optional] in pruint32 aadditionalparts); acstring getpublicsuffix(in
nsiuri auri); acstring getpublicsuffixfromhost(in autf8string ahost); methods getbasedomain() returns the base domain of a uri; that is, the public suffix with a given number of additional dom...
... acstring getbasedomain( in
nsiuri auri, [optional] in pruint32 aadditionalparts ); parameters auri the uri to be analyzed.
... note: it is strongly recommended that you use getbasedomain() if a suitable
nsiuri is available.
...And 2 more matches
nsIExternalProtocolService
method overview boolean externalprotocolhandlerexists(in string aprotocolscheme); astring getapplicationdescription(in autf8string ascheme); nsihandlerinfo getprotocolhandlerinfo(in acstring aprotocolscheme); nsihandlerinfo getprotocolhandlerinfofromos(in acstring aprotocolscheme, out boolean afound); boolean isexposedprotocol(in string aprotocolscheme); void loaduri(in
nsiuri auri, [optional] in nsiinterfacerequestor awindowcontext); void loadurl(in
nsiuri aurl); void setprotocolhandlerdefaults(in nsihandlerinfo ahandlerinfo, in boolean aoshandlerexists); methods externalprotocolhandlerexists() check whether a handler for a specific protocol exists.
...-nickolay <pre> // first construct an
nsiuri object using the ioservice var ioservice = components.classes["@mozilla.org/network/io-service;1"].getservice(components.interfaces.nsiioservice); var uritoopen = ioservice.newuri("http://www.example.com/", null, null); var extps = components.classes["@mozilla.org/uriloader/external-protocol-service;1"] .getservice(components.interfaces.nsiexternalprotocolservice); if (extps.externalprotocolhandl...
...void loaduri( in
nsiuri auri, [optional] in nsiinterfacerequestor awindowcontext ); parameters auri the uri to load.
...And 2 more matches
nsIGlobalHistory2
inherits from: nsisupports last changed in gecko 1.7 this interface replaces and deprecates nsiglobalhistory method overview void adduri(in
nsiuri auri, in boolean aredirect, in boolean atoplevel, in
nsiuri areferrer); boolean isvisited(in
nsiuri auri); void setpagetitle(in
nsiuri auri, in astring atitle); methods adduri() add a uri to global history.
...embedders should consider filtering out these schemes and others, for example mailbox:, for the main
nsiuri and the referrer.
... void adduri( in
nsiuri auri, in boolean aredirect, in boolean atoplevel, in
nsiuri areferrer ); parameters auri the
nsiuri of the page being added.
...And 2 more matches
nsIProtocolProxyService
to access the service use: var pps = components.classes["@mozilla.org/network/protocol-proxy-service;1"] .getservice(components.interfaces.nsiprotocolproxyservice); method overview deprecated since gecko 18 nsiproxyinfo resolve(in
nsiuri auri, in unsigned long aflags); nsicancelable asyncresolve(in
nsiuri auri, in unsigned long aflags,in nsiprotocolproxycallback acallback); nsiproxyinfo newproxyinfo(in acstring atype, in autf8string ahost,in long aport, in unsigned long aflags, in unsigned long afailovertimeout, in nsiproxyinfo afailoverproxy); nsiproxyinfo getfailoverforproxy(in nsiproxyinfo aproxyinfo...
..., in
nsiuri auri, in nsresult areason); void registerfilter(in nsiprotocolproxyfilter afilter, in unsigned long aposition); void unregisterfilter(in nsiprotocolproxyfilter afilter); constants constant value description resolve_non_blocking 1<<0 this flag may be passed to the resolve method to request that it fail instead of block the calling thread.
... nsiproxyinfo resolve( in
nsiuri auri, in unsigned long aflags ); parameters auri the uri to test.
...And 2 more matches
nsISHEntry
to create an instance, use: var shentry = components.classes["@mozilla.org/browser/session-history-entry;1"] .createinstance(components.interfaces.nsishentry); method overview void addchildshell(in nsidocshelltreeitem shell); nsidocshelltreeitem childshellat(in long index); void clearchildshells(); nsishentry clone(); void create(in
nsiuri uri, in astring title, in nsiinputstream inputstream, in nsilayouthistorystate layouthistorystate, in nsisupports cachekey, in acstring contenttype, in nsisupports owner, in unsigned long long docshellid, in boolean dynamiccreation); native code only!
...achededitor(); violates the xpcom interface guidelines boolean hasdynamicallyaddedchild(); boolean isdynamicallyadded(); void seteditordata(in nsdocshelleditordataptr adata); violates the xpcom interface guidelines void setissubframe(in boolean aflag); void setscrollposition(in long x, in long y); void settitle(in astring atitle); void setuniquedocidentifier(); void seturi(in
nsiuri auri); void setviewerbounds(in nsintrect bounds); native code only!
... referreruri
nsiuri referrer uri.
...And 2 more matches
nsIURL
netwerk/base/public/nsiurl.idlscriptable this interface provides convenience methods that further break down the path portion of
nsiuri.
... inherits from:
nsiuri last changed in gecko 9.0 (firefox 9.0 / thunderbird 9.0 / seamonkey 2.6) http://host/directory/filebasename.fileextension?query http://host/directory/filebasename.fileextension#ref http://host/directory/filebasename.fileextension;param \ \ / \ ----------------------- \ | / \ filename / ---------------------------- | filepath you can get a nsiurl from an
nsiuri, using the queryinterface() method: var myuri = components.classes["@mozilla.org/network/io-service;1"] .getservice(components.interfaces.nsiioservice) .newuri(...
..."http://developer.mozilla.org", null, null); try { var myurl = myuri.queryinterface(components.interfaces.nsiurl); } catch(e) { // the uri is not an url } or using instanceof: if (myuri instanceof components.interfaces.nsiurl) { // your code here } method overview autf8string getcommonbasespec(in
nsiuri auritocompare); autf8string getrelativespec(in
nsiuri auritocompare); attributes attribute type description directory autf8string directory portion of a url.
...And 2 more matches
Embedding Tips
alternatively, implement a
nsiuricontentlistener as described below.
... implement the
nsiuricontentlistener interface, and register it with the appropriate web browser object via the nsiwebbrowser::parenturicontentlistener attribute.
... watch for changes in
nsiuricontentlistener::onstarturiopen().
... if necessary you may also implement the
nsiuricontentlistener::ispreferred(), returning pr_true to ensure you are always the preferred uri handler and are called no matter what the content type.
amIWebInstallListener
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 8.0 (firefox 8.0 / thunderbird 8.0 / seamonkey 2.5) method overview boolean onwebinstallblocked(in nsidomwindow awindow, in
nsiuri auri, [array, size_is(acount)] in nsivariant ainstalls, [optional] in pruint32 acount); void onwebinstalldisabled(in nsidomwindow awindow, in
nsiuri auri, [array, size_is(acount)] in nsivariant ainstalls, [optional] in pruint32 acount); boolean onwebinstallrequested(in nsidomwindow awindow, in
nsiuri auri, [array, size_is(acount)] in nsivariant ainstalls, [optional] in pruint32 ...
...boolean onwebinstallblocked( in nsidomwindow awindow, in
nsiuri auri, [array, size_is(acount)] in nsivariant ainstalls, in pruint32 acount optional ); parameters awindow the window that triggered the installs.
...void onwebinstalldisabled( in nsidomwindow awindow, in
nsiuri auri, [array, size_is(acount)] in nsivariant ainstalls, in pruint32 acount optional ); parameters awindow the window that triggered the installs.
...boolean onwebinstallrequested( in nsidomwindow awindow, in
nsiuri auri, [array, size_is(acount)] in nsivariant ainstalls, in pruint32 acount optional ); parameters awindow the window that triggered the installs.
mozIThirdPartyUtil
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview boolean isthirdpartychannel(in nsichannel achannel, [optional] in
nsiuri auri); boolean isthirdpartyuri(in
nsiuri afirsturi, in
nsiuri aseconduri); boolean isthirdpartywindow(in nsidomwindow awindow, [optional] in
nsiuri auri); methods isthirdpartychannel() determine whether the given channel and its content window hierarchy is third party.
...boolean isthirdpartychannel( in nsichannel achannel, in
nsiuri auri optional ); parameters achannel the channel associated with the load.
...boolean isthirdpartyuri( in
nsiuri afirsturi, in
nsiuri aseconduri ); parameters afirsturi missing description aseconduri missing description return value true if afirsturi is third party with respect to aseconduri.
...boolean isthirdpartywindow( in nsidomwindow awindow, in
nsiuri auri optional ); parameters awindow the bottommost window in the hierarchy.
nsIAccessibleHyperLink
inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview nsiaccessible getanchor(in long index); note: renamed from getobject in gecko 1.9
nsiuri geturi(in long index); boolean isselected(); obsolete since gecko 1.9 boolean isvalid(); obsolete since gecko 1.9 attributes attribute type description anchorcount long the number of anchors within this hyperlink.
...
nsiuri geturi( in long index ); parameters index the 0-based index of the uri to be returned.
... return value the
nsiuri object containing the specifications for the uri.
... see also nsiaccessible
nsiuri ...
nsIDOMWindowUtils
ong ascript); astring getpccountscriptcontents(in long ascript); void getscrollxy(in boolean aflushlayout, out long ascrollx, out long ascrolly); astring getvisiteddependentcomputedstyle(in nsidomelement aelement, in astring apseudoelement, in astring apropertyname); boolean isinmodalstate(); void leavemodalstate(); void loadsheet(in
nsiuri sheeturi, in unsigned long type); nsidomnodelist nodesfromrect(in float ax, in float ay, in float atopsize, in float arightsize, in float abottomsize, in float aleftsize, in boolean aignorerootscrollframe, in boolean aflushlayout); void processupdates(); obsolete since gecko 13.0 void purgepccounts(); unsigned long redraw([optional] in unsigned long acoun...
... void removesheet(in
nsiuri sheeturi, in unsigned long type); void resumetimeouts(); void sendcompositionevent(in astring atype); obsolete since gecko 9 void sendcompositionevent(in astring atype, in astring adata, in astring alocale); obsolete since gecko 38.0 void sendcontentcommandevent(in astring atype, [optional] in nsitransferable atransferable); void getclassname(in object aobj); boolean sendkeyevent(in astring atype, in long akeycode, in long acharcode, in long amodifiers, [optional] in boolean apreventdefault); obsolete since gecko 15.0 boolean sendkeyevent(in...
... unsigned long loadsheet( in
nsiuri sheeturi, in unsigned long type ); parameters sheeturi the
nsiuri of the css file to be removed.
... unsigned long removesheet( in
nsiuri sheeturi, in unsigned long type ); parameters sheeturi the
nsiuri of the css file to be removed.
nsIFeedProcessor
to create an instance, use: var feedprocessor = components.classes["@mozilla.org/feed-processor;1"] .createinstance(components.interfaces.nsifeedprocessor); method overview void parseasync(in nsirequestobserver requestobserver, in
nsiuri uri); void parsefromstream(in nsiinputstream stream, in
nsiuri uri); void parsefromstring(in astring str, in
nsiuri uri); attributes attribute type description listener nsifeedresultlistener the feed result listener that will respond to feed events.
... void parseasync( in nsirequestobserver requestobserver, in
nsiuri uri ); parameters requestobserver the observer to be notified when parsing starts and stops.
... void parsefromstream( in nsiinputstream stream, in
nsiuri uri ); parameters stream pointer to the nsiinputstream from which to read and parse the feed.
... void parsefromstring( in astring str, in
nsiuri uri ); parameters str the string to parse as a feed.
nsIHttpChannel
var ch = ios.newchannel("https://www.example.com/", null, null); method overview void getoriginalresponseheader(in acstring aheader, in nsihttpheadervisitor avisitor); acstring getrequestheader(in acstring aheader); acstring getresponseheader(in acstring header); boolean isnocacheresponse(); boolean isnostoreresponse(); void redirectto(in
nsiuri anewuri); void setemptyrequestheader(in acstring aheader); void setreferrerwithpolicy(in
nsiuri referrer, in unsigned long referrerpolicy); void setrequestheader(in acstring aheader, in acstring avalue, in boolean amerge); void setresponseheader(in acstring header, in acstring value, in boolean merge); void visitoriginalresponseheaders(in nsihttphea...
... referrer
nsiuri get or set the uri of the http referer: header.
... void redirectto( in
nsiuri anewuri ); parameters anewuri the new uri to which we should redirect.
... void setreferrerwithpolicy( in
nsiuri areferrer, in unsigned long areferrerpolicy ); parameters areferrer the uri to base the referrer on.
nsIParentalControlsService
to create an instance, use: var parentalcontrolsservice = components.classes["@mozilla.org/parental-controls-service;1"] .createinstance(components.interfaces.nsiparentalcontrolsservice); method overview void log(in short aentrytype, in boolean aflag, in
nsiuri asource, [optional] in nsifile atarget); boolean requesturioverride(in
nsiuri atarget, [optional] in nsiinterfacerequestor awindowcontext); boolean requesturioverrides(in nsiarray atargets, [optional] in nsiinterfacerequestor awindowcontext); attributes attribute type description blockfiledownloadsenabled boolean true if the current user acc...
... void log( in short aentrytype, in boolean aflag, in
nsiuri asource, in nsifile atarget optional ); parameters aentrytype the type of event to log.
... boolean requesturioverride( in
nsiuri atarget, in nsiinterfacerequestor awindowcontext optional ); parameters atarget the uri to be overridden.
... boolean requesturioverrides( in nsiarray atargets, in nsiinterfacerequestor awindowcontext optional ); parameters atargets an array of
nsiuri objects, each representing a uri for which an override is desired.
nsIPrincipal
void checkmayload(in
nsiuri uri, in boolean report); void disablecapability(in string capability, inout voidptr annotation); native code only!
... domain
nsiuri the domain uri to which this principal pertains.
... uri
nsiuri the codebase uri to which this principal pertains.
...void checkmayload( in
nsiuri uri, in boolean report ); parameters uri missing description report if true, will report a warning to the console service if the load is not allowed.
nsIScriptableIO
in nsivariant abase, in astring amode, [optional] in astring acharset, [optional] in astring areplacechar, [optional] in unsigned long abuffersize); nsisupports newoutputstream(in nsivariant abase, in astring amode, [optional] in astring acharset, [optional] in astring areplacechar, [optional] in unsigned long abuffersize, [optional] in unsigned long apermissions);
nsiuri newuri(in nsivariant auri); methods getfile() retrieves a reference to a file or directory on disk.
... newuri() creates a uri object that implements the
nsiuri interface.
...
nsiuri newuri( in nsivariant auri ); parameters auri the file for which to create a new
nsiuri object.
... return value returns an
nsiuri object corresponding to the specified string or file.
nsIStyleSheetService
to create an instance, use: var stylesheetservice = components.classes["@mozilla.org/content/style-sheet-service;1"] .getservice(components.interfaces.nsistylesheetservice); method overview void loadandregistersheet(in
nsiuri sheeturi, in unsigned long type); boolean sheetregistered(in
nsiuri sheeturi, in unsigned long type); void unregistersheet(in
nsiuri sheeturi, in unsigned long type); constants constant value description agent_sheet 0 user_sheet 1 author_sheet 2 ...
...void loadandregistersheet( in
nsiuri sheeturi, in unsigned long type ); parameters sheeturi uri of the stylesheet to load and register.
... sheetregistered() check if a stylesheet has been registered boolean sheetregistered( in
nsiuri sheeturi, in unsigned long type ); parameters sheeturi uri of the stylesheet to check.
...void unregistersheet( in
nsiuri sheeturi, in unsigned long type ); parameters sheeturi uri of the stylesheet to unregister.
nsITaggingService
to use this service, use: var taggingsvc = components.classes["@mozilla.org/browser/tagging-service;1"] .getservice(components.interfaces.nsitaggingservice); method overview 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, [optional] out unsigned long length, [retval, array, size_is(length)] out wstring atags); attributes attribute type description alltags...
... void taguri( in
nsiuri auri, in nsivariant atags ); parameters auri the url to tag.
... void untaguri( in
nsiuri auri, in nsivariant atags ); parameters auri the url to un-tag.
...nsivariant gettagsforuri( in
nsiuri auri, [optional] out unsigned long length, [retval, array, size_is(length)] out wstring atags ); parameters auri the uri for which to return the tags.
nsIWebNavigation
method overview void goback void goforward void gotoindex( in long index ) void loaduri(in wstring uri , in unsigned long loadflags , in
nsiuri referrer , in nsiinputstream postdata, in nsiinputstream headers) void reload(in unsigned long reloadflags) void stop(in unsigned long stopflags) constants load flags constant value description load_flags_mask 65535 this flag defines the range of bits that may be specified.
... currenturi
nsiuri the currently loaded uri or null.
... referringuri
nsiuri the referring uri for the currently loaded uri or null.
... void loaduri( wstring uri, unsigned long loadflags,
nsiuri referrer, nsiinputstream postdata, nsiinputstream headers ); parameters uri the uri string to load.
nsIWebSocketChannel
to create an instance, use: var websocketchannel = components.classes["@mozilla.org/????????????????????????????"] .createinstance(components.interfaces.nsiwebsocketchannel); method overview void asyncopen(in
nsiuri auri, in acstring aorigin, in nsiwebsocketlistener alistener, in nsisupports acontext); void close(in unsigned short acode, in autf8string areason); void sendbinarymsg(in acstring amsg); void sendmsg(in autf8string amsg); attributes attribute type description extensions acstring sec-websocket-extensions response header value.
... originaluri
nsiuri the original uri used to construct the protocol connection.
... uri
nsiuri the uri corresponding to the protocol connection after any redirections are completed.
...void asyncopen( in
nsiuri auri, in acstring aorigin, in nsiwebsocketlistener alistener, in nsisupports acontext ); parameters auri the uri of the websocket protocol; this may be redirected.
Common Pitfalls - Archive of obsolete content
["@mozilla.org/network/io-service;1"] .getservice(components.interfaces.nsiioservice); var uriobj = ioserv.newuri(uristring, uricharset, baseuri); } catch (e) { // may want to catch ns_error_malformed_uri for some applications } c++: nsresult rv; nscomptr<nsiioservice> ioserv = do_getservice("@mozilla.org/network/io-service;1"); ns_ensure_success(rv, rv); nscomptr<
nsiuri> uriobj; rv = ioserv->newuri(uristring, uricharset, baseuri, getter_addrefs(uriobj)); if (ns_failed(rv)) { // may want to handle ns_error_malformed_uri for // some applications return rv; } or, if the code can include nsnetutil.h: nscomptr<
nsiuri> uriobj; nsresult rv = ns_newuri(getter_addrefs(uriobj), uristring, uricharset, baseuri); in all cases the baseuri can be...
... in all other cases, one should call checkloaduriwithprincipal and pass the principal that the uri originates from as the first argument and an
nsiuri object representing the uri as the second argument.
... if there is no
nsiuri object on hand, it is secure to call checkloaduristrwithprincipal, but this will perform a more stringent security check than is strictly necessary.
browser - Archive of obsolete content
contentwindow type: todo use the contentwindow.wrappedjsobject to obtain a dom(html) window object currenturi type:
nsiuri this read-only property contains the currently loaded url.
... the first argument should be a string, not a
nsiuri object.
... to get a string from an
nsiuri, use
nsiuri.spec or
nsiuri.asciispec loaduriwithflags( uri, flags, referrer, charset, postdata ) return type: no return value load a url into the document, with the specified load flags, the given referrer, character set, and post data.
tabbrowser - Archive of obsolete content
contentwindow type: todo use the contentwindow.wrappedjsobject to obtain a dom(html) window object currenturi type:
nsiuri this read-only property contains the currently loaded url.
... the first argument should be a string, not a
nsiuri object.
... to get a string from an
nsiuri, use
nsiuri.spec or
nsiuri.asciispec loaduriwithflags( uri, flags, referrer, charset, postdata ) return type: no return value load a url into the document, with the specified load flags, the given referrer, character set, and post data.
nsIContentPolicy - Archive of obsolete content
method overview short shouldload(in unsigned long acontenttype, in
nsiuri acontentlocation, in
nsiuri arequestorigin, in nsisupports acontext, in acstring amimetypeguess, in nsisupports aextra, in nsiprincipal arequestprincipal); short shouldprocess(in unsigned long acontenttype, in
nsiuri acontentlocation, in
nsiuri arequestorigin, in nsisupports acontext, in acstring amimetype, in nsisupports aextra, in nsiprincipal arequestprincipal); constants cont...
... short shouldload( in unsigned long acontenttype, in
nsiuri acontentlocation, in
nsiuri arequestorigin, in nsisupports acontext, in acstring amimetypeguess, in nsisupports aextra, in nsiprincipal arequestprincipal ); parameters acontenttype the type of content being tested.
... short shouldprocess( in unsigned long acontenttype, in
nsiuri acontentlocation, in
nsiuri arequestorigin, in nsisupports acontext, in acstring amimetype, in nsisupports aextra, in nsiprincipal arequestprincipal ); parameters acontenttype the type of content being tested.
Listening to events on all tabs
void onlocationchange( nsidomxulelement abrowser, nsiwebprogress awebprogress, nsirequest arequest,
nsiuri alocation [optional] in unsigned long aflags ); parameters abrowser the browser representing the tab whose location changed.
... alocation an
nsiuri object indicating the tab's new uri.
...boolean onrefreshattempted( nsidomxulelement abrowser, nsiwebprogress webprogress,
nsiuri arefreshuri, long amillis, boolean asameuri ); parameters abrowser the browser that fired the notification.
Overview of Mozilla embedding APIs
contract-id: ns_uri_loader_contractid implemented interfaces:
nsiuriloader related interfaces:
nsiuricontentlistener nsunknowncontenttypehandler the unknowncontenttypehandler service is the last resort of the uriloader when no other content handler can be located.
...interface definition:
nsiuriloader interface status...
... interface definition:
nsiuricontentlistener interface status...
Necko Interfaces Overview
nsiioservice central necko service manages protocol handlers thin layer over protocol handlers provides interface for creating uri objects from uri strings maps uri scheme to appropriate nsiprotocolhandler impl
nsiuri (nsiurl, nsifileurl, nsistandardurl) represents an uri, with getters and setters for various uri parts (eg.
... scheme, host, path, ...) per protocol implementation necko provides uri impl's for common uri formats (see nsstandardurl, nssimpleuri) nsichannel : nsirequest represents a logical connection to the resource identified by a
nsiuri per protocol implementation single use (ie.
...http) maps uri string to
nsiuri instance via newuri method creates nsichannel instance from
nsiuri instance via newchannel method nsistreamlistener : nsirequestobserver implemented by the consumer of a nsichannel instance passed to nsichannel::asyncopen method nsirequestobserver::onstartrequest - notifies start of async download nsistreamlistener::ondataavailable - notifies presence of downloaded data nsirequestobserver::onstoprequest - notifies completion of async download, possibly w/ error nsiload...
Using the Places livemark service
the third parameter is the uri of the site the livemark was created from (specified as an
nsiuri object.
...you can convert a string into an
nsiuri using nsiioservice.
... determine whether a folder is a livemark you can use the nsilivemarkservice.islivemark() method to determine whether or not a given folder is a livemark container: if (livemarkservice.islivemark(folderid)) { // it's a livemark } else { // it's not a livemark } accessing the container's site uri the nsilivemarkservice.getsiteuri() method lets you obtain the
nsiuri of the website associated with a livemark container.
amIWebInstaller
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 8.0 (firefox 8.0 / thunderbird 8.0 / seamonkey 2.5) method overview boolean installaddonsfromwebpage(in astring amimetype, in nsidomwindow awindow, in
nsiuri areferer, [array, size_is(ainstallcount)] in wstring auris, [array, size_is(ainstallcount)] in wstring ahashes, [array, size_is(ainstallcount)] in wstring anames, [array, size_is(ainstallcount)] in wstring aicons, [optional] in amiinstallcallback acallback, [optional] in pruint32 ainstallcount); boolean isinstallenabled(in astring amimetype, in
nsiuri areferer); note: prior to ge...
...boolean installaddonsfromwebpage( in astring amimetype, in nsidomwindow awindow, in
nsiuri areferer, [array, size_is(ainstallcount)] in wstring auris, [array, size_is(ainstallcount)] in wstring ahashes, [array, size_is(ainstallcount)] in wstring anames, [array, size_is(ainstallcount)] in wstring aicons, in amiinstallcallback acallback, optional in pruint32 ainstallcount optional ); parameters amimetype the mimetype for the add-ons.
...boolean isinstallenabled( in astring amimetype, in
nsiuri areferer ); parameters amimetype the mime type for the add-on to be installed.
imgICache
method overview void clearcache(in boolean chrome); nsiproperties findentryproperties(in
nsiuri uri); void removeentry(in
nsiuri uri); methods clearcache() evict images from the cache.
...nsiproperties findentryproperties( in
nsiuri uri ); parameters uri the uri to look up.
...void removeentry( in
nsiuri uri ); parameters uri the uri to remove.
mozIPlacesAutoComplete
1.0 66 introduced gecko 1.9.2 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview void registeropenpage(in
nsiuri auri); void unregisteropenpage(in
nsiuri auri); constants constant value description match_anywhere 0 match anywhere in each searchable term.
...void registeropenpage( in
nsiuri auri ); parameters auri the uri to register as an open page.
...void unregisteropenpage( in
nsiuri auri ); parameters auri the uri to unregister as an open page.
nsIAboutModule
inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview unsigned long geturiflags(in
nsiuri auri); nsichannel newchannel(in
nsiuri auri); constants constant value description uri_safe_for_untrusted_content (1 << 0) a flag that indicates whether a uri is safe for untrusted content.
...unsigned long geturiflags( in
nsiuri auri ); parameters auri return value a combination of the flags above corresponding to the appropriate flags for this about uri.
...nsichannel newchannel( in
nsiuri auri ); parameters auri the uri of the new channel.
nsIAnnotationObserver
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview void onitemannotationremoved(in long long aitemid, in autf8string aname); void onitemannotationset(in long long aitemid, in autf8string aname); void onpageannotationremoved(in
nsiuri auri, in autf8string aname); void onpageannotationset(in
nsiuri apage, in autf8string aname); methods onitemannotationremoved() this method is called when an annotation is deleted for an item.
...void onpageannotationremoved( in
nsiuri auri, in autf8string aname ); parameters auri the uri whose annotation is to be deleted.
...void onpageannotationset( in
nsiuri apage, in autf8string aname ); parameters apage the uri on which the annotation is to be set.
nsIDownload
referrer
nsiuri the referrer uri of the download.
... source
nsiuri the source uri of the download.
... target
nsiuri the target of the transfer.
nsIFeedResult
stylesheet
nsiuri an xslt stylesheet available to transform the source of the feed.
... uri
nsiuri the address from which the feed was fetched.
... see also nsisupports nsifeedcontainer
nsiuri nsiproperties interwiki link ...
nsIGlobalHistory3
method overview void adddocumentredirect(in nsichannel aoldchannel, in nsichannel anewchannel, in print32 aflags, in boolean atoplevel); unsigned long geturigeckoflags(in
nsiuri auri); void seturigeckoflags(in
nsiuri auri, in unsigned long aflags); methods adddocumentredirect() notifies the history system that the page loading via aoldchannel redirected to anewchannel.
...unsigned long geturigeckoflags( in
nsiuri auri ); parameters auri the
nsiuri to get flags for.
...void seturigeckoflags( in
nsiuri auri, in unsigned long aflags ); parameters auri the
nsiuri to add flags for.
nsIProtocolHandler
inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview boolean allowport(in long port, in string scheme); nsichannel newchannel(in
nsiuri auri);
nsiuri newuri(in autf8string aspec, in string aorigincharset, in
nsiuri abaseuri); attributes attribute type description defaultport long the default port is the port the protocol uses by default.
... nsichannel newchannel( in
nsiuri auri ); parameters auri the uri for which to construct a channel.
...(many servers do not support utf-8 iris at the present time, so we must be careful about tracking the native charset of the origin server.)
nsiuri newuri( in autf8string aspec, in string aorigincharset, in
nsiuri abaseuri ); parameters aspec the uri string in utf-8 encoding.
nsIProtocolProxyCallback
1.0 66 introduced gecko 1.8 inherits from: nsisupports last changed in gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) method overview void onproxyavailable(in nsicancelable arequest, in
nsiuri auri, in nsiproxyinfo aproxyinfo, in nsresult astatus); methods onproxyavailable() this method is called when proxy info is available or when an error in the proxy resolution occurs.
... void onproxyavailable( in nsicancelable arequest, in
nsiuri auri, in nsiproxyinfo aproxyinfo, in nsresult astatus ); parameters arequest the value returned from asyncresolve.
... see also nsicancelable
nsiuri nsiproxyinfo nsiprotocolproxyservice ...
nsIScriptableUnescapeHTML
implemented by: @mozilla.org/feed-unescapehtml;1 as a service: var scriptableunescapehtml = components.classes["@mozilla.org/feed-unescapehtml;1"] .getservice(components.interfaces.nsiscriptableunescapehtml); method overview nsidomdocumentfragment parsefragment(in astring fragment, in prbool isxml, in
nsiuri baseuri, in nsidomelement element); astring unescape(in astring src); methods parsefragment() parses a string of html or xml source into a sanitized documentfragment.
... nsidomdocumentfragment parsefragment( in astring fragment, in prbool isxml, in
nsiuri baseuri, in nsidomelement element ); parameters fragment a string of html or xml source to parse as a fragment.
... see also nsidomdocumentfragment
nsiuri nsidomelement ...
Index - Web APIs
902 document.documenturiobject api, dom, non-standard, property, reference the document.documenturiobject read-only property returns an
nsiuri object representing the uri of the document.
... 2702 node.baseuriobject api, dom, dom 3, dom reference, gecko, node, non-standard, property, read-only, reference the node.baseuriobject property returns the
nsiuri representing the node's (typically a document or an element) base url.
... it's similar to node.baseuri, except it returns an
nsiuri instead of a string.
Node.baseURIObject - Web APIs
the node.baseuriobject property returns the
nsiuri representing the node's (typically a document or an element) base url.
... it's similar to node.baseuri, except it returns an
nsiuri instead of a string.
... syntax uriobj = node.baseuriobject value an
nsiuri.
stylesheet/utils - Archive of obsolete content
parameters window : nsidomwindow uri : string,
nsiuri} type : string the type of the sheet.
... parameters window : nsidomwindow uri : string,
nsiuri} type : string the type of the sheet.
Bookmarks - Archive of obsolete content
the uri for the bookmark needs to be specified using an
nsiuri object.
... var ios = components.classes["@mozilla.org/network/io-service;1"] .getservice(components.interfaces.nsiioservice); var uri = ios.newuri("http://google.com/", null, null); var newbkmkid = bmsvc.insertbookmark(newfolderid, uri, bmsvc.default_index, ""); this example instantiates the nsiioservice and uses it to create an
nsiuri referring to the google web site, then calls nsinavbookmarksservice.insertbookmark() to create a new bookmark to google, placing it at the end of the bookmarks folder referenced by newbkmkid.
Providing Command-Line Options - Archive of obsolete content
firefox.exe -viewapp url opens a chrome window for my application and passes it an
nsiuri object.
... entry: "m-myapp" }], queryinterface: xpcomutils.generateqi([ ci.nsicommandlinehandler ]), /* nsicommandlinehandler */ handle : function clh_handle(cmdline) { try { // changeme: change "viewapp" to your command line flag that takes an argument var uristr = cmdline.handleflagwithparam("viewapp", false); if (uristr) { // convert uristr to an
nsiuri var uri = cmdline.resolveuri(uristr); openwindow(chrome_uri, uri); cmdline.preventdefault = true; } } catch (e) { components.utils.reporterror("incorrect parameter passed to -viewapp on the command line."); } // changeme: change "myapp" to your command line flag (no argument) if (cmdline.handleflag("myapp", false)) { openwindow(chrome...
bootstrap.js - Extensions
function startup(data, reason) { /// bootstrap data structure @see /docs/extensions/bootstrapped_extensions#bootstrap_data /// string id /// string version /// nsifile installpath ///
nsiuri resourceuri /// /// reason types: /// app_startup /// addon_enable /// addon_install /// addon_upgrade /// addon_downgrade } function shutdown(data, reason) { /// bootstrap data structure @see /docs/extensions/bootstrapped_extensions#bootstrap_data /// string id /// string version /// nsifile installpath ///
nsiuri resourceuri ...
... /// /// reason types: /// app_shutdown /// addon_disable /// addon_uninstall /// addon_upgrade /// addon_downgrade } function install(data, reason) { /// bootstrap data structure @see /docs/extensions/bootstrapped_extensions#bootstrap_data /// string id /// string version /// nsifile installpath ///
nsiuri resourceuri /// /// reason types: /// addon_install /// addon_upgrade /// addon_downgrade } function uninstall(data, reason) { /// bootstrap data structure @see /docs/extensions/bootstrapped_extensions#bootstrap_data /// string id /// string version /// nsifile installpath ///
nsiuri resourceuri /// /// reason types: /// addon_uninstall /// addon_upgrade ...
AddonInstall
releasenotesuri
nsiuri the uri of release notes for this install.
... sourceuri
nsiuri the uri that the add-on is being installed from.
Downloads.jsm
alternatively, may be an
nsiuri, a downloadsource object, or an object with the following properties: url: string containing the uri for the download source.
...alternatively, may be an
nsiuri or a downloadsource object.
Manipulating bookmarks using Places
the uri for the bookmark needs to be specified using an
nsiuri object.
... var ios = components.classes["@mozilla.org/network/io-service;1"] .getservice(components.interfaces.nsiioservice); var uri = ios.newuri("http://google.com/", null, null); var newbkmkid = bmsvc.insertbookmark(newfolderid, uri, bmsvc.default_index, ""); this example instantiates the nsiioservice and uses it to create an
nsiuri referring to the google web site, then calls nsinavbookmarksservice.insertbookmark() to create a new bookmark to google, placing it at the end of the bookmarks folder referenced by newbkmkid.
Using the Places annotation service
most methods in the service are duplicated with one method labeled as a 'page annotation' taking an
nsiuri and the others labeled as an 'item annotation' and taking the id of an item in the places database.
...lue, aflags, aexpiration); setitemannotationbinary(aitemid, aname, avalue, adatalen, aflags, aexpiration); from javascript there are two simple function to perform all of these operations: setpageannotation(auri, aname, avalue, aflags, aexpiration); setitemannotation(aitemid, aname, avalue, aflags, aexpiration); these annotations all take similar parameters: uri or itemid: this is the
nsiuri of the page to annotate, or for items in the places database, the id of the item.
Index
1033
nsiuri interfaces, interfaces:scriptable, uris, xpcom, xpcom interface reference see the following rfcs for details: 1034
nsiurifixup interfaces, interfaces:scriptable, uri, xpcom interface reference implemented by: @mozilla.org/docshell/urifixup;1 as a service: 1035
nsiurifixupinfo no summary!
... 1036 nsiurl interfaces, interfaces:scriptable, xpcom, xpcom interface reference you can get a nsiurl from an
nsiuri, using the queryinterface() method: 1037 nsiurlformatter interfaces, interfaces:scriptable, reference, référence(2), xpcom interface reference variable names can contain 'a-z' letters and '_' characters.
amIWebInstallPrompt
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 8.0 (firefox 8.0 / thunderbird 8.0 / seamonkey 2.5) method overview void confirm(in nsidomwindow awindow, in
nsiuri auri, [array, size_is(acount)] in nsivariant ainstalls, [optional] in pruint32 acount); prior to gecko 8.0, all references to nsidomwindow used in this interface were nsidomwindow.
...void confirm( in nsidomwindow awindow, in
nsiuri auri, [array, size_is(acount)] in nsivariant ainstalls, in pruint32 acount optional ); parameters awindow the window that triggered the installs.
imgILoader
inherits from: nsisupports last changed in gecko 8.0 (firefox 8.0 / thunderbird 8.0 / seamonkey 2.5) implemented by @mozilla.org/image/loader;1 as a service: var imgiloader = components.classes["@mozilla.org/image/loader;1"] .getservice(components.interfaces.imgiloader); method overview imgirequest loadimage(in
nsiuri auri, in
nsiuri ainitialdocumenturl, in
nsiuri areferreruri, in nsiprincipal aloadingprincipal, in nsiloadgroup aloadgroup, in imgidecoderobserver aobserver, in nsisupports acx, in nsloadflags aloadflags, in nsisupports cachekey, in imgirequest arequest, in nsichannelpolicy channelpolicy); imgirequest loadimagewithchannel(in nsichannel achannel, in imgidecoderobserver aobserver, in nsisupports ...
...imgirequest loadimage( in
nsiuri auri, in
nsiuri ainitialdocumenturl, in
nsiuri areferreruri, in nsiprincipal aloadingprincipal, in nsiloadgroup aloadgroup, in imgidecoderobserver aobserver, in nsisupports acx, in nsloadflags aloadflags, in nsisupports cachekey, in imgirequest arequest, in nsichannelpolicy channelpolicy ); parameters auri the uri to load.
inIDOMUtils
value state 1 :active 2 :focus 4 :hover 8 :-moz-drag-over 16 :target 1<<29 :-moz-focusring methods getbindingurls() returns an array of
nsiuri objects representing the current xml binding for the specified element.
... return value an array of
nsiuri objects representing the current xbl binding (if any) for the element and its hierarchy of base bindings.
mozIAsyncHistory
0 (firefox 24.0 / thunderbird 24.0 / seamonkey 2.21) implemented by: @mozilla.org/browser/history;1 as a service: var asynchistory = components.classes["@mozilla.org/browser/history;1"] .getservice(components.interfaces.moziasynchistory); method overview void getplacesinfo(in jsval aplaceidentifiers, in mozivisitinfocallback acallback); void isurivisited(in
nsiuri auri, in mozivisitedstatuscallback acallback); void updateplaces(in moziplaceinfo, [optional] in mozivisitinfocallback acallback); methods getplacesinfo() starts an asynchronous request to determine whether or not a given uri has been visited; you must implement a callback to receive the result of the request.
...void isurivisited( in
nsiuri auri, in mozivisitedstatuscallback acallback ); parameters auri the places for which to retrieve information, identified by either a single place guid, a single uri, or a js array of uris and/or guids.
mozIColorAnalyzer
toolkit/components/places/mozicoloranalyzer.idlscriptable provides methods to analyze colors in an image 1.0 66 introduced gecko 17.0 inherits from: nsisupports last changed in gecko 17.0 (firefox 17.0 / thunderbird 17.0 / seamonkey 2.14) method overview void findrepresentativecolor(in
nsiuri imageuri, in mozirepresentativecolorcallback callback); methods findrepresentativecolor() given an image uri, find the most representative color for that image based on the frequency of each color.
...void findrepresentativecolor( in
nsiuri imageuri, in mozirepresentativecolorcallback callback ); parameters imageuri a uri pointing to the image - ideally a data: uri, but any scheme that will load when setting the src attribute of a dom img element should work.
mozIVisitStatusCallback
toolkit/components/places/moziasynchistory.idlscriptable this interface provides callback handling functionality for moziasynchistory.isurivisited 1.0 66 introduced gecko 11.0 inherits from: nsisupports last changed in gecko 11.0 (firefox 11.0 / thunderbird 11.0 / seamonkey 2.8) method overview void isvisited(in
nsiuri auri, in boolean avisitedstatus); methods isvisited() called when the moziasynchistory.isurivisited() method's check to determine whether a given uri has been visited has completed.
...void isvisited( in
nsiuri auri, in boolean avisitedstatus ); parameters auri the uri that was checked to see if it's been visited.
nsIAppShellService
boolean createstartupstate(in long awindowwidth, in long awindowheight); obsolete since gecko 1.8 nsixulwindow createtoplevelwindow(in nsixulwindow aparent, in
nsiuri aurl, in pruint32 achromemask, in long ainitialwidth, in long ainitialheight, in nsiappshell aappshell); nsiwebnav createwindowlessbrowser (in bool aischrome) void destroyhiddenwindow(); void doprofilestartup(in nsicmdlineservice acmdlineservice, in boolean caninteract); obsolete since gecko 1.8 void ensure1window(in nsicmdlineservice acmdlineservice); obsolet...
... nsixulwindow createtoplevelwindow( in nsixulwindow aparent, in
nsiuri aurl, in boolean ashowwindow, in boolean aloaddefaultpage, in pruint32 achromemask, in long ainitialwidth, in long ainitialheight, in nsiappshell aappshell ); parameters aparent the parent window.
nsICRLManager
inherits from: nsisupports last changed in gecko 1.7 method overview wstring computenextautoupdatetime(in nsicrlinfo info, in unsigned long autoupdatetype, in double noofdays); void deletecrl(in unsigned long crlindex); nsiarray getcrls(); void importcrl([array, size_is(length)] in octet data, in unsigned long length, in
nsiuri uri, in unsigned long type, in boolean dosilentdownload, in wstring crlkey); void reschedulecrlautoupdate(); boolean updatecrlfromurl(in wstring url, in wstring key); constants constant value description type_autoupdate_time_based 1 type_autoupdate_freq_based 2 methods computenextautoupdatetime() wstring computenextautoupdatetime( in nsicrlinfo info, in unsigned long auto...
...void importcrl( [array, size_is(length)] in octet data, in unsigned long length, in
nsiuri uri, in unsigned long type, in boolean dosilentdownload, in wstring crlkey ); parameters data length uri type dosilentdownload crlkey reschedulecrlautoupdate() this would reschedule the autoupdate of crls with auto update enable.
nsIChannel
originaluri
nsiuri the original uri used to construct the channel.
... uri
nsiuri the uri corresponding to the channel.
nsICommandLine
method overview long findflag(in astring aflag, in boolean acasesensitive); astring getargument(in long aindex); boolean handleflag(in astring aflag, in boolean acasesensitive); astring handleflagwithparam(in astring aflag, in boolean acasesensitive); void removearguments(in long astart, in long aend); nsifile resolvefile(in astring aargument);
nsiuri resolveuri(in astring aargument); attributes attribute type description length long number of arguments in the command line.
...
nsiuri resolveuri( in astring aargument ); parameters aargument the command-line argument to resolve.
nsIDocumentLoader
] .createinstance(components.interfaces.nsidocumentloader); method overview void clearparentdocloader(); obsolete since gecko 1.8 void createdocumentloader(out nsidocumentloader aninstance); obsolete since gecko 1.8 void destroy(); obsolete since gecko 1.8 void fireonlocationchange(in nsiwebprogress awebprogress, in nsirequest arequest, in
nsiuri auri); obsolete since gecko 1.8 void fireonstatuschange(in nsiwebprogress awebprogress, in nsirequest arequest, in nsresult astatus, in wstring amessage); obsolete since gecko 1.8 void getcontentviewercontainer(in nsisupports adocumentid, out nsicontentviewercontainer aresult); native code only!
... fireonlocationchange() obsolete since gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) void fireonlocationchange( in nsiwebprogress awebprogress, in nsirequest arequest, in
nsiuri auri ); parameters awebprogress arequest auri fireonstatuschange() obsolete since gecko 1.8 (firefox 1.5 / thunderbird 1.5 / seamonkey 1.0) void fireonstatuschange( in nsiwebprogress awebprogress, in nsirequest arequest, in nsresult astatus, in wstring amessage ); parameters awebprogress arequest astatus ...
nsIDownloadHistory
1.0 66 introduced gecko 1.9 inherits from: nsisupports last changed in gecko 1.9 (firefox 3) method overview void adddownload(in
nsiuri asource, [optional] in
nsiuri areferrer, [optional] in prtime astarttime); methods adddownload() adds a download to history.
...void adddownload( in
nsiuri asource, in
nsiuri areferrer, optional in prtime astarttime optional ); parameters asource the source of the download we are adding to history.
nsIDownloadManager
to get the service, use: var downloadmanager = components.classes["@mozilla.org/download-manager;1"] .getservice(components.interfaces.nsidownloadmanager); method overview nsidownload adddownload(in short adownloadtype, in
nsiuri asource, in
nsiuri atarget, in astring adisplayname, in nsimimeinfo amimeinfo, in prtime astarttime, in nsilocalfile atempfile, in nsicancelable acancelable, in boolean aisprivate); void addlistener(in nsidownloadprogresslistener alistener); void canceldownload(in unsigned long aid); void cleanup(); void endbatchupdate(); obsolete since gecko 1.9.1 vo...
... nsidownload adddownload( in short adownloadtype, in
nsiuri asource, in
nsiuri atarget, in astring adisplayname, in nsimimeinfo amimeinfo, in prtime astarttime, in nsilocalfile atempfile, in nsicancelable acancelable, in boolean aisprivate ); parameters adownloadtype the download type for the transfer.
nsIDownloadProgressListener
method overview void ondownloadstatechange(in short astate, in nsidownload adownload); void onlocationchange(in nsiwebprogress awebprogress, in nsirequest arequest, in
nsiuri alocation, in nsidownload adownload); obsolete since gecko 1.9.1 void onprogresschange(in nsiwebprogress awebprogress, in nsirequest arequest, in long long acurselfprogress, in long long amaxselfprogress, in long long acurtotalprogress, in long long amaxtotalprogress, in nsidownload adownload); void onsecuritychange(in nsiwebprogress awebprogress, in nsirequest arequest, in unsi...
... onlocationchange() obsolete since gecko 1.9.1 (firefox 3.5 / thunderbird 3.0 / seamonkey 2.0) void onlocationchange( in nsiwebprogress awebprogress, in nsirequest arequest, in
nsiuri alocation, in nsidownload adownload ); parameters awebprogress the nsiwebprogress instance used by the download manager to monitor downloads.
nsIExternalURLHandlerService
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview nsihandlerinfo geturlhandlerinfofromos(in
nsiuri aurl, out boolean afound); methods geturlhandlerinfofromos() given a url, looks up the handler info from the operating system.
...nsihandlerinfo geturlhandlerinfofromos( in
nsiuri aurl, out boolean afound ); parameters aurl the url we are looking for.
nsIFaviconDataCallback
1.0 66 introduced gecko 2.0 inherits from: nsisupports last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview void oncomplete(in
nsiuri auri, in unsigned long adatalen, [const,array,size_is(adatalen)] in octet adata, in autf8string amimetype); methods oncomplete() called when the required favicon's information is available.
...void oncomplete( in
nsiuri auri, in unsigned long adatalen, [const,array,size_is(adatalen)] in octet adata, in autf8string amimetype ); parameters auri receives the "favicon uri" (not the "favicon link uri") associated to the requested page.
nsIFeedContainer
link
nsiuri a uri containing the primary link for the feed or entry.
...see also
nsiuri nsifeedtextconstruct interwiki link ...
nsIFrameLoader
method overview void activateframeevent(in astring atype, in boolean capture); void activateremoteframe(); void destroy(); void loadframe(); void loaduri(in
nsiuri auri); void sendcrossprocesskeyevent(in astring atype, in long akeycode, in long acharcode, in long amodifiers, [optional] in boolean apreventdefault); void sendcrossprocessmouseevent(in astring atype, in float ax, in float ay, in long abutton, in long aclickcount, in long amodifiers, [optional] in boolean aignorerootscrollframe); void updatepositionandsize(in nsifra...
... void loaduri( in
nsiuri auri ); parameters auri the uri to load into the frame.
nsIMicrosummaryGenerator
localuri
nsiuri for generators installed by the user or bundled with the browser, the local uri points to the location of the local file containing the generator's xml.
... uri
nsiuri the canonical location and unique identifier of the generator.
nsIParserUtils
/parserutils;1 as a service: var parserutils = components.classes["@mozilla.org/parserutils;1"] .getservice(components.interfaces.nsiparserutils); method overview astring converttoplaintext(in astring src, in unsigned long flags, in unsigned long wrapcol); nsidomdocumentfragment parsefragment(in astring fragment, in unsigned long flags, in boolean isxml, in
nsiuri baseuri, in nsidomelement element); astring sanitize(in astring src, in unsigned long flags); constants constant value description sanitizerallowcomments (1 << 0) flag for sanitizer: allow comment nodes.
... nsidomdocumentfragment parsefragment( in astring fragment, in unsigned long flags, in boolean isxml, in
nsiuri baseuri, in nsidomelement element ); parameters fragment the input markup.
nsIPlacesImportExportService
; method overview void backupbookmarksfile(); void exporthtmltofile(in nsilocalfile afile); void importhtmlfromfile(in nsilocalfile afile, in boolean aisinitialimport); obsolete since gecko 14.0 void importhtmlfromfiletofolder(in nsilocalfile afile, in print64 afolder, in boolean aisinitialimport); obsolete since gecko 14.0 void importhtmlfromuri(in
nsiuri auri, in boolean aisinitialimport); obsolete since gecko 14.0 methods backupbookmarksfile() backs up the bookmarks.html file.
... void importhtmlfromuri( in
nsiuri auri, in boolean aisinitialimport ); parameters auri the uri from which to import bookmarks.
nsIProtocolProxyFilter
method overview nsiproxyinfo applyfilter(in nsiprotocolproxyservice aproxyservice, in
nsiuri auri, in nsiproxyinfo aproxy); methods applyfilter() this method is called to apply proxy filter rules for the given uri and proxy object (or list of proxy objects).
... nsiproxyinfo applyfilter( in nsiprotocolproxyservice aproxyservice, in
nsiuri auri, in nsiproxyinfo aproxy ); parameters aproxyservice a reference to the protocol proxy service.
nsISpeculativeConnect
method overview void speculativeconnect(in
nsiuri auri, in nsiinterfacerequestor acallbacks, in nsieventtarget atarget); methods speculativeconnect() call this method to hint to the networking layer that a new transaction for the specified uri is likely to happen soon.
...void speculativeconnect( in
nsiuri auri, in nsiinterfacerequestor acallbacks, in nsieventtarget atarget ); parameters auri the uri of the hinted transaction.
nsIStandardURL
to create an instance, use: var standardurl = components.classes["@mozilla.org/network/standard-url;1"] .createinstance(components.interfaces.nsistandardurl); method overview void init(in unsigned long aurltype, in long adefaultport, in autf8string aspec, in string aorigincharset, in
nsiuri abaseuri); attributes attribute type description mutable boolean control whether or not this url can be modified.
...void init( in unsigned long aurltype, in long adefaultport, in autf8string aspec, in string aorigincharset, in
nsiuri abaseuri ); parameters aurltype one of the constants listed above.
nsIWebBrowser
parenturicontentlistener
nsiuricontentlistener uri content listener parent.
... see also nsibasewindow nsicontextmenulistener nsidomwindow nsiembeddingsitewindow nsiinterfacerequestor nsishistorylistener nsitooltiplistener
nsiuricontentlistener nsiweakreference nsiwebbrowserchrome nsiwebbrowserchromefocus nsiwebprogresslistener ...
nsIWebBrowserChrome3
1.0 66 introduced gecko 2.0 inherits from: nsiwebbrowserchrome2 last changed in gecko 2.0 (firefox 4 / thunderbird 3.3 / seamonkey 2.1) method overview astring onbeforelinktraversal(in astring originaltarget, in
nsiuri linkuri, in nsidomnode linknode, in prbool isapptab); methods onbeforelinktraversal() determines the appropriate target for a link.
... astring onbeforelinktraversal( in astring originaltarget, in
nsiuri linkuri, in nsidomnode linknode, in prbool isapptab ); parameters originaltarget the original link target.
nsIWebProgressListener
method overview void onlocationchange(in nsiwebprogress awebprogress, in nsirequest arequest, in
nsiuri alocation, [optional] in unsigned long aflags); void onprogresschange(in nsiwebprogress awebprogress, in nsirequest arequest, in long acurselfprogress, in long amaxselfprogress, in long acurtotalprogress, in long amaxtotalprogress); void onsecuritychange(in nsiwebprogress awebprogress, in nsirequest arequest, in unsigned long astate); void onstatechange(in nsiwebprogres...
... void onlocationchange( in nsiwebprogress awebprogress, in nsirequest arequest, in
nsiuri alocation, [optional] in unsigned long aflags ); parameters awebprogress the nsiwebprogress instance that fired the notification.
nsIWebProgressListener2
last changed in gecko 1.9 (firefox 3) inherits from: nsiwebprogresslistener method overview void onprogresschange64(in nsiwebprogress awebprogress, in nsirequest arequest, in long long acurselfprogress, in long long amaxselfprogress, in long long acurtotalprogress, in long long amaxtotalprogress); boolean onrefreshattempted(in nsiwebprogress awebprogress, in
nsiuri arefreshuri, in long amillis, in boolean asameuri); methods onprogresschange64() notification that the progress has changed for one of the requests associated with awebprogress.
...boolean onrefreshattempted( in nsiwebprogress awebprogress, in
nsiuri arefreshuri, in long amillis, in boolean asameuri ); parameters awebprogress the nsiwebprogress instance that fired the notification.
nsIXULBrowserWindow
method overview astring onbeforelinktraversal(in astring originaltarget, in
nsiuri linkuri, in nsidomnode linknode, in prbool isapptab); void setjsdefaultstatus(in astring status); void setjsstatus(in astring status); void setoverlink(in astring link, in nsidomelement element); methods onbeforelinktraversal() called before traversing a link to determine the appropriate target into which to load the link.
...astring onbeforelinktraversal( in astring originaltarget, in
nsiuri linkuri, in nsidomnode linknode, in prbool isapptab ); parameters originaltarget the specified target for the link.
nsIXULTemplateQueryProcessor
this list is processed by the builder and supplied to the query processor in the adatasources array as a list of
nsiuri objects or nsidomnode objects.
...nsisupports getdatasource( in nsiarray adatasources, in nsidomnode arootnode, in boolean aistrusted, in nsixultemplatebuilder abuilder, out boolean ashoulddelaybuilding ); parameters adatasources the list of
nsiuri objects and/or nsidomnode objects.
File I/O - Archive of obsolete content
to get a url of a file, use nsiioservice.newfileuri(): // file is nsifile components.utils.import("resource://gre/modules/services.jsm"); var url = services.io.newfileuri(file); // url is a
nsiuri; to get the string "file://...", see url.spec to get an nsifile from the 'file://' url, use nsifileurl: // url is a
nsiuri; see nsiioservice::newuri for getting a string into a
nsiuri.