title: App

title: App

App 是 Wilddog SDK 的核心，它维护着应用的全局上下文数据，不同模块之间需要通过它来进行交互。同时 App 也是我们访问 Wilddog 各个功能模块的入口，所以初始化 App 是我们使用其他任何 API 接口的前提。 要使用 Wilddog 实时通信引擎服务，你的初始化参数中必须包含 syncURL，websocketOnly 为可选参数，代码如下：

var config = {
  syncURL: "https://<SyncAppID>.wilddogio.com",
  // 连接方式可选项，如不设置该参数，则默认为 false，连接 WilddogSync 服务器时采用 polling 和 websocket 两种模式
  websocketOnly: false,
  // 若同时使用 Auth SDK ，应设置 authDomain
  authDomain: "<SyncAppID>.wilddog.com"
};
wilddog.initializeApp(config);

注意：

syncURL 的域名为：*.wilddogio.com

authDomain 的域名为：*.wilddog.com

示例

初始化多个 App ：

// 上面的代码相当于如下初始化动作
var wilddog = wilddog.initializeApp(config);
// 我们还可以使用不同配置声明多个不同的 App 实例
var anotherConfig = {
  synURL: "https://<SyncAppID-a>.wilddogio.com",
  authDomain: "<SyncAppID-a>.wilddog.com"，
  websocketOnly: false
};
var anotherApp = wilddog.initializeApp(anotherConfig, "ANOTHER_APP");
// 通过 anotherApp 或 wilddog.ANOTHER_APP 来获取已有的 wilddog.App 实例

属性

name

类型

String

说明

当前 app 的名字（只读）。在初始化 wilddog.App 的时候定义，缺省的 app 的名字为 "DEFAULT"。

示例

// 缺省的 app 的名字为 "DEFAULT".
wilddog.initializeApp(defaultAppConfig);
console.log(wilddog.app().name);  // "DEFAULT"

// 当前 app 名字是在初始化时定义的
var otherApp = wilddog.initializeApp(otherAppConfig, "other");
console.log(otherApp.name);  // "other"

options

类型

non-null Object

说明

当前 app 配置所的信息（只读）。调用 wilddog.initializeApp() 时传入的参数，用于初始化 wilddog.App 。

示例

var app = wilddog.initializeApp(config);
console.log(app.options.authDomain === config.authDomain);  // true
console.log(app.options.synURL === config.synURL);  // true

方法

auth

定义

auth()

说明

获取 wilddog.Auth 实例，wilddog.Auth 实例只能通过此方法获取。

返回值

wilddog.Auth

示例

var auth = app.auth();

sync

定义

sync()

说明

获取 wilddog.Sync 实例，wilddog.Sync 实例只能通过此方法获取。

返回值

wilddog.Sync

示例

var sync = app.sync();