属性

sogouExplorer.runtime.id

  1.   扩展id

方法

connect

Port sogouExplorer.runtime.connect(Object connectInfo)

  1. 尝试连接到扩展内的其他监听器(例如本扩展的background page)。本方法经常使用于content scripts连接到扩展进程的时候。反之，如果扩展想要连接到content scripts，那么使用sogouExplorer.tabs.connect()。
  2.  
  3. 参数
  4.  
  5. connectInfo( 可选 object )
  6.   name( 可选 string )
  7.     这个参数将会被传递到扩展进程的onConnect方法中。
  8.  
  9. 返回值
  10. ( Port )
  11.   通过这个Port，信息可以被传递和接收。如果在连接的时候扩展没有找到，那么port的onDisconnect事件将会被触发。

getBackgroundPage

Object sogouExplorer.runtime.getBackgroundPage()

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

getManifest

Object sogouExplorer.runtime.getManifest()

  1. 返回该扩展Manifest文件的相关信息。
  2.  
  3. 返回值
  4. appInfo  （Object）
  5.      background  (Object) 
  6.           扩展的background页
  7.      id  (String) 
  8.           扩展id
  9.      name  (String) 
  10.           扩展名
  11.      option  (String) 
  12.           扩展option页
  13.      plugins  (Array) 
  14.           扩展用到的插件
  15.      request_api_version  (String) 
  16.           request_api_version
  17.      version  (String) 
  18.           扩展版本号

getPackageDirectoryEntry（暂未实现）

Object sogouExplorer.runtime.getPackageDirectoryEntry(Function callback)

  1. 返回包目录的目录入口。
  2.  参数
  3.    callback  (function)
  4.  
  5. Callback
  6.    如果指定了callback中的参数，那么它应该是如下的形式：
  7.      function(Object directoryEntry) {...};
  8. directoryEntry  （Object）

getPlatformInfo

Object sogouExplorer.runtime.getPlatformInfo(Function callback)

  1. 返回当前系统相关信息。
  2.  参数
  3.    callback  (function)
  4.  
  5. Callback
  6.    如果指定了callback中的参数，那么它应该是如下的形式：
  7.      function(Object platformInfo) {...};
  8. platformInfo  （Object）
  9.      os  (String) 
  10.           操作系统类型
  11.      arch  (String) 
  12.           机器的处理器体系结构
  13.      nacl_arch  (String) 
  14.           本地的客户端体系结构，在有些平台上，和arch是不同的

getURL

String sogouExplorer.runtime.getURL(String path)

  1.  将针对于扩展目录的相对URL地址转换为一个标准的URL地址。
  2.  
  3. 参数
  4. path( string )
  5.   将要被转换的相对URL地址。
  6.  
  7. 返回
  8. ( string )
  9.   一个标准严格的URL地址。

reload

sogouExplorer.runtime.reload()

  1. 重新加载扩展。

requestUpdateCheck

sogouExplorer.runtime.requestUpdateCheck(Function callback)

  1. 检查扩展是否有更新。
  2. 参数
  3.    callback  (function)
  4.  
  5. Callback
  6.    如果指定了callback中的参数，那么它应该是如下的形式：
  7.      function(String updateInfo) {...};
  8.      updateInfo 可能是"no_update"

setUninstallUrl

sogouExplorer.runtime.setUninstallUrl(String url)

  1. 设置扩展卸载时打开的url。
  2. 参数
  3.    url  (String)
  4.    字符串类型，最多容纳255字符

sendMessage

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

  1. 向有OnMessage监听器的页面发消息，与sogouExplorer.runtime.connect类似，但只发一条消息。但是这个方法不能用来给contentscript发消息，给contentscript发消息用sogouExplorer.tabs.sendMessage。
  2. 参数
  3.    responseCallback  (function)
  4.  
  5. Callback
  6.    如果指定了callback中的参数，那么它应该是如下的形式：
  7.      function(any response) {...};
  8.      response  (any)
  9.      消息接收方返回的JSON格式信息。如果连接过程中出现错误，callback被调起，无返回参数，并且lastError属性将设置成错误信息。

事件

onConnect

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

  1.   每当从扩展进程或者content script得到连接的时候，这个事件将会被触发。
  2.  
  3. 参数
  4. port ( Port )
  5.   详见Port。

onInstalled

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

  1. 当扩展第一次安装时，扩展升级时，以及浏览器升级时触发。
  2. 参数
  3.    callback  (function)
  4.  
  5. Callback
  6.    如果指定了callback中的参数，那么它应该是如下的形式：
  7.      function(Object details) {...};
  8.      details  (Object) 
  9.         reason(enum of "install", "update", or "chrome_update" )
  10.         触发事件的原因
  11.         previousVersion ( 可选 string )
  12.         表示更新前扩展的版本号，只有当reason为update时，才有该参数

onMessage

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

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

onStartup

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

  1. 浏览器启动时触发。
  2. 参数
  3.    callback  (function)
  4.  
  5. Callback
  6.    如果指定了callback中的参数，那么它应该是如下的形式：
  7.      function() {...};

onSuspend

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

  1. 扩展停用时触发，但是不保证脚本能全部执行完毕。
  2. 参数
  3.    callback  (function)
  4.  
  5. Callback
  6.    如果指定了callback中的参数，那么它应该是如下的形式：
  7.      function() {...};