{"id":357,"date":"2009-05-21T22:32:25","date_gmt":"2009-05-22T03:32:25","guid":{"rendered":"http:\/\/eligrey.com\/?p=357"},"modified":"2009-05-21T22:32:25","modified_gmt":"2009-05-22T03:32:25","slug":"jetpack-api","status":"publish","type":"post","link":"https:\/\/eligrey.com\/blog\/jetpack-api\/","title":{"rendered":"Jetpack API"},"content":{"rendered":"

Mozilla Labs’ latest creation, Jetpack<\/a>, is a great way to extend Firefox. It currently has a poorly documented API<\/abbr><\/a> that doesn’t mention all of the public methods and fields. Due to Mozilla Labs’ decision of not putting the API documentation on MDC<\/a> or the MozillaWiki<\/a>, I cannot update the documentation myself. Therefore, I will list all of Jetpack’s documented and undocumented features as of version 0.1.2 in this blog post.<\/p>\n

(Not) Assigning Properties<\/h2>\n

You can’t do things like jetpack.tabs.focused.contentWindow.foo = \"bar\"<\/code>. I find this much too restrictive, as it hinders a developer’s ability to make an API for a webpage to communicate with a jetpack to do things that need more privileges. Ironically, it seems that jetpacks have full access to Firefox’s XPCOM<\/a> (Components.*<\/code>, ect.) which means, with a little hacking, it may be possible to bypass this restriction. The follow code shows an example of getting an nsIAlertsService<\/code> and using it instead of jetpack.notifications.show<\/code>.<\/p>\n

var body = \"Some text\",\ntitle = \"Notification\",\nicon = \"http:\/\/code.eligrey.com\/favicon.ico\",\n\nclassObj = Components.classes['@mozilla.org\/alerts-service;1'],\nalertService = classObj.getService(Components.interfaces.nsIAlertsService);\n\nalertService.showAlertNotification(icon, title, body);<\/pre>\n
<\/p>\n
Every Field & Method<\/h2>\n
The following is every enumerable field and method that I found in the jetpack API. You can see what arguments a function takes and how it works by just converting it to a string as these functions will show their code bodies and not just [native code]<\/code>.<\/p>\n
    \n
  • location<\/code><\/li>\n
  • console<\/code>\n
      \n
    • info<\/code><\/li>\n
    • log<\/code><\/li>\n
    • arn<\/code><\/li>\n
    • error<\/code><\/li>\n
    • exception<\/code><\/li>\n
    • logFromCaller<\/code><\/li>\n<\/ul>\n<\/li>\n
    • $<\/code> and jQuery<\/code>\n
        \n
      • All of the standard jQuery methods.<\/li>\n<\/ul>\n<\/li>\n
      • jetpack<\/code> and Jetpack<\/code>\n
          \n
        • tabs<\/code> (the listed array methods are defined just to throw errors stating that they are unsupported)\n
            \n
          • focused<\/code>\n
              \n
            • onReady<\/code><\/li>\n
            • isClosed<\/code><\/li>\n
            • url<\/code><\/li>\n
            • contentWindow<\/code><\/li>\n
            • contentDocument<\/code><\/li>\n
            • raw<\/code> (the XUL <tab\/><\/code> element)<\/li>\n
            • focus<\/code><\/li>\n
            • close<\/code><\/li>\n
            • toString<\/code><\/li>\n
            • _unload<\/code><\/li>\n<\/ul>\n<\/li>\n
            • open<\/code><\/li>\n
            • toString<\/code><\/li>\n
            • onReady<\/code>\n
                \n
              • unbind<\/code><\/li>\n<\/ul>\n<\/li>\n
              • pop<\/code><\/li>\n
              • push<\/code><\/li>\n
              • reverse<\/code><\/li>\n
              • shift<\/code><\/li>\n
              • sort<\/code><\/li>\n
              • splice<\/code><\/li>\n
              • unshift<\/code><\/li>\n
              • tab indices (0, 1, 2, 3…) that follow the same structure as jetpack.tabs.focused<\/code>.<\/li>\n<\/ul>\n<\/li>\n
              • unload<\/code><\/li>\n
              • notifications<\/code>\n
                  \n
                • show<\/code><\/li>\n<\/ul>\n<\/li>\n
                • lib<\/code>\n
                    \n
                  • twitter<\/code>\n
                      \n
                    • Twit<\/code><\/li>\n
                    • getStatus<\/code><\/li>\n
                    • getTwitFriends<\/code><\/li>\n
                    • getTwitInfo<\/code><\/li>\n
                    • getTwitLatestStatus<\/code><\/li>\n
                    • getTwitTimeline<\/code><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n
                    • statusBar<\/code>\n
                        \n
                      • append<\/code><\/li>\n<\/ul>\n<\/li>\n
                      • track<\/code> (has to do with memory tracking)<\/li>\n
                      • json<\/code> (No idea why this doesn’t follow Firefox 3.5’s JSON implementation naming at all)\n
                          \n
                        • encode<\/code><\/li>\n
                        • decode<\/code><\/li>\n<\/ul>\n<\/li>\n
                        • sessionStorage<\/code><\/li>\n<\/ul>\n<\/li>\n
                        • setInterval<\/code><\/li>\n
                        • clearInterval<\/code><\/li>\n
                        • setTimeout<\/code><\/li>\n
                        • clearTimeout<\/code><\/li>\n
                        • addStatusBarPanel<\/code> (throws “addStatusBarPanel() has been moved to Jetpack.statusBar.append()”)<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"
                          Mozilla Labs’ latest creation, Jetpack, is a great way to extend Firefox. It currently has a poorly documented API that doesn’t mention all of the public methods and fields. Due to Mozilla Labs’ decision of not putting the API documentation on MDC or the MozillaWiki, I cannot update the documentation myself. Therefore, I will list […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[1],"tags":[15,48,90,96,111],"class_list":["post-357","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-browsers","tag-firefox","tag-javascript","tag-jetpack","tag-mozilla-labs"],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/pfpUD-5L","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/posts\/357","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/comments?post=357"}],"version-history":[{"count":0,"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/posts\/357\/revisions"}],"wp:attachment":[{"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/media?parent=357"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/categories?post=357"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/eligrey.com\/blog\/wp-json\/wp\/v2\/tags?post=357"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}