除了Chrome浏览器支持的chrome.* API之外,Chrome浏览器扩展还可以使用Chrome浏览器为Web页面或Chrome app提供的APIs。对于Chrome浏览器2支持的API,还可以绑定第三方API库到Chrome浏览器扩展程序。

Chrome浏览器扩展程序可以使用的API包括:

  • 标准JavaScript API,即Web应用中常用的JavaScript核心API和DOM API
  • XMLHttpRequest API
  • HTML5 API
  • WebKit API,特别是WebKit的CSS特性,如过滤器、动画和变换
  • Chrome V8 API,如JSON
  • 其他第三方类库API,如jQuery,可以绑定这些API到Chrome浏览器扩展程序,就如同在Web页面中使用这些API

本系列将首先介绍一些常用的Chrome浏览器API。

1. Chrome sessions API

Chrome浏览器扩展程序通过chrome.sessions API,可以从浏览器的会话中存取windows窗口和tab页。

chrome.sessions.Session对象的属性如下:

属性名

类型

必选/可选

注释

lastModified

整型

必选

窗口或tab页被关闭或修改的时间,ms

tab

chrome.tabs.Tab

与window两者必选其一

tab页

window

chrome.windows.Window

与tab两者必选其一

窗口

chrome.sessions API中的常用方法:

  • 获得最近被关闭的windows窗口或tab页的列表

chrome.sessions.getRecentlyClosed(Filter filter, function(array of Session))

  • 获得同步会话中的所有设备

chrome.sessions.getDevices(Filter filter, function(array of Session))

  • 恢复打开指定会话中的窗口或tab页

chrome.sessions.restore(string sessionId, function(Session session))

2. Chrome windows API

Chrome浏览器扩展程序通过chrome.windows API,可以与浏览器的窗口系统交互,如创建浏览器窗口、修改浏览器窗口和重新编排浏览器窗口。

chrome.windows API本身无需声明任何授权。但是一个chrome.windows.Window对象包含一个chrome.tabs.Tab类型的数组,如果要操作数组中的tabs的url、title、favIconUrl属性,则需要在manifest.json文件中声明tabs授权如下:

 {
...
"permissions": [
"tabs"
],
...
}

当前窗口是包含正在运行的JavaScript代码的窗口。这与当前拥有焦点的窗口可能不是同一个窗口。

chrome.windows.Window对象的属性如下:

属性名

类型

必选/可选

注释

id

整型

可选

窗口的ID,在浏览器会话范围内唯一。有些情况下的窗口没有ID

focused

布尔型

可选

窗口是否拥有焦点

top

整型

可选

窗口离屏幕顶部边缘偏移的像素值。有些情况下的窗口没有top

left

整型

可选

窗口离屏幕左部边缘偏移的像素值。有些情况下的窗口没有left

width

整型

可选

窗口的宽度像素值,包括边框。有些情况下的窗口没有width

height

整型

可选

窗口的高度像素值,包括边框。有些情况下的窗口没有height

tabs

chrome.tabs.Tab的数组

可选

窗口中拥有的tabs

incognito

布尔型

可选

窗口是否运行在隐身模式下

type

WindowType

可选

浏览器窗口的类型。

枚举值"normal""popup""panel""app""devtools"

state

WindowState

可选

浏览器窗口的状态。枚举值"normal""minimized""maximized""fullscreen""docked"

alwaysOnTop

布尔型

必选

窗口是否总是位于顶层(模式窗口)

sessionId

字符串

可选

从Chrome.sessions API获取的会话ID,用以唯一标识一个窗口

chrome.tabs API中的常用方法:

  • 创建一个新的浏览器窗口

chrome.windows.create(object createData, function(Window window){…})

createData对象是可选的,表示采用默认值创建窗口。createData对象的属性同chrome.windows.Window对象。

  • 关闭一个指定的浏览器窗口

chrome.windows.remove(integer windowId, function(){…})

  • 修改一个指定的浏览器窗口的参数

chrome.windows.update(integer windowId, object updateInfo, function(Window window){…})

updateInfo对象是必选的,其中未涉及的Window属性则保持不变。

  • 获取指定ID的窗口对象

chrome.windows.get(integer windowId, object getInfo, function(Window window){…})

getInfo对象是可选的,其有两个参数。一个是名为populate的布尔型参数,true表示该方法得到的chrome.windows.Window对象里包含chrome.tabs.Tab类型的数组。另一个名为windowTypes的WindowType型参数,表示通过windowTypes进行筛选窗口。

  • 获取所有的窗口对象

chrome.windows.getAll(object getInfo, function(array of Window){…})

getInfo对象是可选的,其有两个参数。一个是名为populate的布尔型参数,true表示该方法得到的chrome.windows.Window对象里包含chrome.tabs.Tab类型的数组。另一个名为windowTypes的WindowType型参数,表示通过windowTypes进行筛选窗口。

3. Chrome tabs API

Chrome浏览器扩展程序通过chrome.tabs API,可以与浏览器的tab系统交互,如创建浏览器tab、修改浏览器tab和重新编排浏览器tabs。

大多数chrome.tabs API无需声明任何授权,但是如果要操作tab的url、title、favIconUrl属性,则需要在manifest.json文件中声明tabs授权如下:

 {
...
"permissions": [
"tabs"
],
...
}

chrome.tabs.Tab对象的属性如下:

属性名

类型

必须/可选

注释

id

整型

可选

tab的ID,在浏览器会话中唯一。有些情况下的tab没有ID

index

整型

可选

从0开始的tab在窗口中的位置序号

windowId

整型

可选

tab所依托的窗口

openerTabId

整型

可选

tab的id,该tab打开当前tab。两个tabs都应该位于同一个窗口中

selected

布尔型

可选

已过期。tab是否被选中

highlighted

布尔型

可选

tab是否高亮显示

active

布尔型

可选

tab是否成为窗口中的激活tab,无论窗口是否拥有焦点

pinned

布尔型

可选

tab是否订住

audible

布尔型

可选

tab是否在刚刚过去的几秒钟里发出过声音(当未必被听见,因为可能被静音)

mutedInfo

MutedInfo类型

可选

tab的静音状态

url

字符串

可选

tab显示的url,需要拥有tabs权限

title

字符串

可选

tab显示的title,需要拥有tabs权限

favIconUrl

字符串

可选

tab的favicon的url,需要拥有tabs权限。tab加载过程中为空

status

字符串

可选

tab的状态,枚举值"loading", "complete"

incognito

布尔型

可选

tab所在窗口是否为隐身窗口

width

整型

可选

tab的宽度像素值

height

整型

可选

tab的高度像素值

sessionId

字符串

可选

从Chrome.sessions API获取的会话ID,用以唯一标识一个tab

chrome.tabs API中的常用方法:

  • 创建一个新tab

chrome.tabs.create(object createProperties, function(Tab tab){…})

createProperties对象的属性如下:

属性名

类型

必须/可选

注释

windowId

整型

可选

创建tab所依托的窗口,默认为当前窗口

index

整型

可选

被创建的tab在窗口中的位置序号,0~tab数量

url

字符串

可选

被创建的tab的初始url。完整的URL类似于http://www.yourdomain.com,相对的URL可以是相对于扩展中的当前页面。

active

布尔型

可选

被创建的tab是否成为激活tab,无论窗口是否拥有焦点。默认为true

selected

布尔型

可选

已过期。被创建的tab是否成为被选中tab,默认true

pinned

布尔型

可选

被创建的tab是否订住,默认false

openerTabId

整型

可选

tab的id,该tab打开新创建的tab。两个tabs都应该位于同一个窗口中

  • 复制一个新tab

chrome.tabs.duplicate(integer tabId, function(Tab tab){…})

  • 关闭tabs

chrome.tabs.remove(integer or array of integer tabIds, function(){…})

  • 修改tab的属性

chrome.tabs.update(integer tabId, object updateProperties, function(Tab tab){…})

updateProperties对象是必选的,其中未涉及的tab属性则保持不变。

  • 获取指定id的tab

chrome.tabs.get(integer tabId, function(Tab tab){…})

  • 根据指定的若干属性查找tabs

chrome.tabs.query(object queryInfo, function(array of Tab){…})

queryInfo对象的属性如下:

属性名

类型

必须/可选

注释

active

布尔型

可选

tab是否成为窗口中的激活tab

pinned

布尔型

可选

tab是否订住

audible

布尔型

可选

tab是否在刚刚过去的几秒钟里发出过声音(当未必被听见,因为可能被静音)

muted

布尔型

可选

tab是否处于静音状态

highlighted

布尔型

可选

tab是否高亮显示

currentWindow

布尔型

可选

tab是否位于当前窗口

lastFocusedWindow

布尔型

可选

tab是否位于最近拥有焦点的窗口中

status

TabStatus类型

可选

tab的状态,枚举值"loading", "complete"

title

字符串

可选

tab显示的title,需要拥有tabs权限

url

字符串

可选

tab显示的url,需要拥有tabs权限

windowId

整型

可选

tab所依托的窗口

windowType

WindowType类型

可选

tab所在窗口的类型

枚举值"normal""popup""panel""app", "devtools"

index

整型

可选

从0开始的tab在窗口中的位置序号

  • 注入JavaScript代码到页面中

chrome.tabs.executeScript(integer tabId, object details, function(array of any){…})

details对象的属性如下:

属性名

类型

必须/可选

注释

code

字符串

与file两者必选其一

要注入的JavaScript代码或CSS代码

file

字符串

与code两者必选其一

要注入的JavaScript代码或CSS文件路径

allFrames

布尔型

可选

true表示CSS将注入到当前页面的所有frames。默认false,表示CSS只注入到顶层frame

matchAboutBlank

布尔型

可选

true表示CSS将注入about:blank和about:srcdoc,当不好注入到about:-frames。默认false

runAt

枚举型

"document_start","document_end", "document_idle"

可选

CSS最早注入的时机

  • 注入CSS文件到页面中

chrome.tabs.insertCSS(integer tabId, object details, function(){…})

details对象的属性同executeScript()。

Chrome浏览器扩展开发系列之十六:扩展中可用的Chrome浏览器API的更多相关文章

  1. Chrome浏览器扩展开发系列之十四

    Chrome浏览器扩展开发系列之十四:本地消息机制Native messaging 时间:2015-10-08 16:17:59      阅读:1361      评论:0      收藏:0    ...

  2. Chrome浏览器扩展开发系列之十四:本地消息机制Native messagin

    Chrome浏览器扩展开发系列之十四:本地消息机制Native messaging 2016-11-24 09:36 114人阅读 评论(0) 收藏 举报  分类: PPAPI(27)  通过将浏览器 ...

  3. Chrome浏览器扩展开发系列之十八:扩展的软件国际化chrome.i18n API

    i18n是internationalization 的简写,这里将讨论软件国际化的问题.熟悉软件国际化的朋友应该知道,软件国际化要求,页面中所有用户可见的字符串都必须置于资源属性文件中.资源属性文件中 ...

  4. Chrome浏览器扩展开发系列之十五:跨域访问的XMLHttpRequest对象

    XMLHttpRequest对象是W3C的标准API,用于访问服务器资源.XMLHttpRequest对象支持多种文本格式,如XML和JSON等.XMLHttpRequest对象可以通过HTTP和HT ...

  5. Chrome浏览器扩展开发系列之十四:本地消息机制Native messaging

    通过将浏览器所在客户端的本地应用注册为Chrome浏览器扩展的“本地消息主机(native messaging host)”,Chrome浏览器扩展还可以与客户端本地应用之间收发消息. 客户端的本地应 ...

  6. Chrome浏览器扩展开发系列之十二:Content Scripts

    Content Scripts是运行在Web页面的上下文的JavaScript文件.通过标准的DOM,Content Scripts 可以操作(读取并修改)浏览器当前访问的Web页面的内容. Cont ...

  7. Chrome浏览器扩展开发系列之十九:扩展开发示例

    翻译总结了这么多的官网内容,下面以一款博主开发的“沪深股票价格变化实时追踪提醒”软件为例,介绍Chrome浏览器扩展程序的开发,开发环境为Eclipse IDE+Chrome Browser. “沪深 ...

  8. Chrome浏览器扩展开发系列之十:桌面通知Notification

    Desktop Notification也称为Web Notification,是在Web页面之外,以弹出桌面对话框的形式通知用户发生了某事件.Web Notification于2015.9.10成为 ...

  9. Chrome浏览器扩展开发系列之十七:扩展中可用的chrome.events API

    chrome.events中定义了一些常见的事件类型,可以供Chrome浏览器扩展程序发出对应的事件对象. 对于关注的事件,首先要通过addListener()在对应的事件上注册监听器,示例如下: c ...

随机推荐

  1. php原生curl接口的请求

    /** * @desc 接口请求处理 * @date 2017/5/19 11:39 * @param [$url请求的接口地址,$way为false为get请求,true为post请求] * @au ...

  2. 对RabbitMQ.Client进行一下小小的包装,绝对实用方便

    RabbitMQ是一个老牌的非微软的消息队列组件,一般来说应该能满足中小型公司对消息队列生产的需求,平时我们在.NET开发环境下运用它是可能会需要RabbitMQ.Client的SDK库,此库是官网提 ...

  3. 详解Centos默认磁盘分区

    对于有经验的Linux系统管理员,在安装系统之前都会对系统的分区进行规划:针对这一需求,下面就通过默认的Centos分区与大家分享一些关于Linux系统的知识.Linux系统的磁盘命名规范:硬盘类型标 ...

  4. JMeter-MyEclipse编译运行问题(Could not read JMeter properties file)

    JMeter-MyEclipse编译运行问题按照 此贴 http://phoenix0529.iteye.com/blog/1530728 进行配置,然后用Ant编译Build.xml 是可以的. 但 ...

  5. .NET框架及C#语言基础

    1.Microsoft.NET框架结构是一个面向网络,支持各种用户终端的开发平台. 2..NET框架的主要内容有CLR,FCL,ADO.NET,XML,ASP.NET,WinForms和WebSeri ...

  6. Promise (1) 初步接触

    总想着王者荣耀排位赛再提升个等级就弃掉游戏好好学习,然而打了两个周也没升上去,看来是应该换个方向发挥了. 最近看了<javascript Promise迷离书>,对Promise的理解颇有 ...

  7. Java中IO流的总结

    有关Java中IO流总结图 流分类 按方向分 输入流 输出流 按单位分 字节流 字符流 按功能分 节点流 处理流(过滤流) 其他 所有的流继承与这四类流:InputSteam.OutputStream ...

  8. maven 修改默认的JDK版本

    maven jdk 版本配置 maven 默认使用的 jdk 版本 新建一个 maven 项目,如下 : 项目左下方出现一个感叹号,JRE 显示的是 1.5 版本.解决方式有两种,一种是配置 pom. ...

  9. 解析PHP面向对象的三大特征

    class BenHang extends Card{ /*构造函数与及构造的继承*/ function __construct($cardno,$pwd, $name,$money){ parent ...

  10. js的for循环闭包问题

    一个简单的例子,如果想循环输出数组中的每一个数值我们可以利用for循环来输出例如: <script type="text/javascript"> var arr=[& ...