开发者文档
runtime

属性

sogouExplorer.runtime.id

  扩展id

方法

connect

Port sogouExplorer.runtime.connect(Object connectInfo)

尝试连接到扩展内的其他监听器(例如本扩展的background page)。本方法经常使用于content scripts连接到扩展进程的时候。反之,如果扩展想要连接到content scripts,那么使用sogouExplorer.tabs.connect()。

参数

connectInfo( 可选 object )
  name( 可选 string )
    这个参数将会被传递到扩展进程的onConnect方法中。

返回值
( Port )
  通过这个Port,信息可以被传递和接收。如果在连接的时候扩展没有找到,那么port的onDisconnect事件将会被触发。

getBackgroundPage

Object sogouExplorer.runtime.getBackgroundPage()

获取background页面的window对象,如果没有background则返回null。文

getManifest

Object sogouExplorer.runtime.getManifest()

返回该扩展Manifest文件的相关信息。

返回值
appInfo  (Object)
     background  (Object) 
          扩展的background页
     id  (String) 
          扩展id
     name  (String) 
          扩展名
     option  (String) 
          扩展option页
     plugins  (Array) 
          扩展用到的插件
     request_api_version  (String) 
          request_api_version
     version  (String) 
          扩展版本号

getPackageDirectoryEntry(暂未实现)

Object sogouExplorer.runtime.getPackageDirectoryEntry(Function callback)

返回包目录的目录入口。
 参数
   callback  (function)

Callback
   如果指定了callback中的参数,那么它应该是如下的形式:
     function(Object directoryEntry) {...};
directoryEntry  (Object)

getPlatformInfo

Object sogouExplorer.runtime.getPlatformInfo(Function callback)

返回当前系统相关信息。
 参数
   callback  (function)

Callback
   如果指定了callback中的参数,那么它应该是如下的形式:
     function(Object platformInfo) {...};
platformInfo  (Object)
     os  (String) 
          操作系统类型
     arch  (String) 
          机器的处理器体系结构
     nacl_arch  (String) 
          本地的客户端体系结构,在有些平台上,和arch是不同的

getURL

String sogouExplorer.runtime.getURL(String path)

 将针对于扩展目录的相对URL地址转换为一个标准的URL地址。

参数
path( string )
  将要被转换的相对URL地址。

返回
( string )
  一个标准严格的URL地址。

reload

sogouExplorer.runtime.reload()

重新加载扩展。

requestUpdateCheck

sogouExplorer.runtime.requestUpdateCheck(Function callback)

检查扩展是否有更新。
参数
   callback  (function)

Callback
   如果指定了callback中的参数,那么它应该是如下的形式:
     function(String updateInfo) {...};
     updateInfo 可能是"no_update"

setUninstallUrl

sogouExplorer.runtime.setUninstallUrl(String url)

设置扩展卸载时打开的url。
参数
   url  (String)
   字符串类型,最多容纳255字符

sendMessage

sogouExplorer.runtime.sendMessage(any message, Object options, Function responseCallback)

向有OnMessage监听器的页面发消息,与sogouExplorer.runtime.connect类似,但只发一条消息。但是这个方法不能用来给contentscript发消息,给contentscript发消息用sogouExplorer.tabs.sendMessage。
参数
   responseCallback  (function)

Callback
   如果指定了callback中的参数,那么它应该是如下的形式:
     function(any response) {...};
     response  (any)
     消息接收方返回的JSON格式信息。如果连接过程中出现错误,callback被调起,无返回参数,并且lastError属性将设置成错误信息。

事件

onConnect

sogouExplorer.runtime.onConnect.addListener(fucntion (Port port) {...});

  每当从扩展进程或者content script得到连接的时候,这个事件将会被触发。

参数
port ( Port )
  详见Port。

onInstalled

sogouExplorer.runtime.onInstalled.addListener(fucntion (Object details) {...});

当扩展第一次安装时,扩展升级时,以及浏览器升级时触发。
参数
   callback  (function)

Callback
   如果指定了callback中的参数,那么它应该是如下的形式:
     function(Object details) {...};
     details  (Object) 
        reason(enum of "install", "update", or "chrome_update" )
        触发事件的原因
        previousVersion ( 可选 string )
        表示更新前扩展的版本号,只有当reason为update时,才有该参数

onMessage

sogouExplorer.runtime.onMessage.addListener(fucntion callback);

收到消息时触发。
参数
   callback  (function)

Callback
   如果指定了callback中的参数,那么它应该是如下的形式:
     function(any message, MessageSender sender, function sendResponse) {...};
     message  (可选 any) 
        收到的消息
     sender (MessageSender)
     sendresponse (Function)
        有response时调用,可是任何能够转换成JSON的对象。如果文档中有不止一个onMessageListener,只有一个会发response。

onStartup

sogouExplorer.runtime.onStartup.addListener(fucntion callback);

浏览器启动时触发。
参数
   callback  (function)

Callback
   如果指定了callback中的参数,那么它应该是如下的形式:
     function() {...};

onSuspend

sogouExplorer.runtime.onSuspend.addListener(fucntion callback);

扩展停用时触发,但是不保证脚本能全部执行完毕。
参数
   callback  (function)

Callback
   如果指定了callback中的参数,那么它应该是如下的形式:
     function() {...};