WDGApp 编辑文档

WDGApp 是野狗各个功能模块的入口。用于初始化时的必要参数配置。
一个 WDGApp 实例对应一个野狗应用,在 SDK 内以应用名字区分。

属性

name

定义

Swift
var name: String { get }

Objective-C
@property (readonly, copy, nonatomic) NSString *name;

说明

获取这个 WDGApp 实例的名字。



options

定义

Swift
var options: WDGOptions { get }

Objective-C
@property (readonly, nonatomic) WDGOptions *options;

说明

初始化 SDK 的配置参数。



方法

+ configureWithOptions:

定义

Swift
class func configure(with options: WDGOptions)

Objective-C
+ (void)configureWithOptions:(WDGOptions *)options;

说明

初始化默认的 Wilddog app。默认的 app 名字是 __WDGAPP_DEFAULT。如果配置失败,会抛出异常。
这个方法是线程安全的。

参数
参数名 说明
options 配置 Wilddog 应用所需的 WDGOptions 实例。



+ configureWithName:options:

定义

Swift
class func configure(withName name: String, options: WDGOptions)

Objective-C
+ (void)configureWithName:(NSString *)name options:(WDGOptions *)options;

说明

用 options 和 name 配置一个 Wilddog app。如果配置失败,会抛出异常。
这个方法是线程安全的。

参数
参数名 说明
name 开发者自己起名的应用名字。这个名字只能包含字母、数字和下划线。
options 配置 Wilddog 应用所需的 WDGOptions 实例。



+ defaultApp

定义

Swift
class func defaultApp() -> WDGApp?

Objective-C
+ (nullable WDGApp *)defaultApp;

说明

返回默认的 WDGApp 实例,即通过 configureWithOptions: 配置的实例。如果默认 app 不存在,则返回 nil。
这个方法是线程安全的。

返回值

WDGApp 实例。



+ appNamed:

定义

Swift
/*not inherited*/ init?(named name: String)

Objective-C
+ (nullable WDGApp *)appNamed:(NSString *)name;

说明

返回一个之前通过 configureWithName:options: 配置的 WDGApp 实例。如果这个 app 不存在, 则返回 nil。
这个方法是线程安全的。

返回值

WDGApp 实例。



+ allApps

定义

Swift
class func allApps() -> [AnyHashable : Any]?

Objective-C
+ (nullable NSDictionary *)allApps;

说明

返回所有现存的 WDGApp 实例。如果没有 WDGApp 实例,则返回 nil。
这个方法是线程安全的。

返回值

包含所有 WDGApp 实例的字典,key 为 WDGApp 实例对应的名字。



- deleteApp:

定义

Swift
func delete(_ completion: @escaping WDGAppVoidBoolCallback)

Objective-C
- (void)deleteApp:(WDGAppVoidBoolCallback)completion;

说明

清除当前的 WDGApp,释放相关的数据,并回收它的名字以便将来使用。
这个方法是线程安全的。

参数
参数名 说明
completion 删除成功后,会调用这个回调函数。
野狗新手?
立即注册,为你提供安全可靠的实时通信云服务。
没找到需要的文档?
你可以提交工单反馈 或 阅读常见问题
期待收到你的反馈,帮助我们改进文档。
参与调研