一、简介

1.1 用户模块

提供 UI界面 和 接口调用 两种方式，满足用户不同需求。

1.1.1 登录弹窗

内置登录UI弹窗，内含所有已经集成的登录方式，无需编写界面，一键集成登录功能

1.1.2 匿名登录

WINGSDK匿名登录无需账户密码，根据设备信息新建用户或登录已存在的用户，可以快速登录游戏。

1.1.3 第三方平台登录

第三方平台登录接口可以通过第三方平台账户登录，返回WINGSDK账号信息，使用没有绑定任何WINGSDK账号的第三方平台账号登录，会自动新建一个WINGSDK账号，并且与该平台账号绑定。支持Facebook登录、Google登录、VK登录。

1.1.4 内置账户管理界面

内置账户管理UI界面，无需编写界面和逻辑，即可对账户进行管理，平台账户绑定情况一目了然，绑定、解绑平台账户，新建账号，切换账号，轻松搞定。

1.1.5 账号绑定与解绑

• 账号绑定接口，可以将WINGSDK账号跟第三方平台的账号绑定，绑定成功后可以使用绑定的平台账号登录，在同一应用中一个平台账号只能绑定一个WINGSDK账号。

• 账号解绑接口，可以将第三方平台账号与其绑定的WINGSDK账号解绑，解绑成功后，平台账号可以与WINGSDK账号再次绑定。

• 绑定账号查询接口，能够查询此时登录的账号（WINGSDK）已经绑定的第三方平台账号列表。

1.1.6 账号切换

一键切换账号，迅速切换WINGSDK账号或者第三方账号。

1.2 支付模块

支付模块提供支付充值接口，集成简单，无需理会复杂的支付流程，轻松完成商品的购买（充值）。

1.3 数据收集模块

数据收集模块提供了数据收集的接口，多渠道灵活调用。数据收集包含了丰富的应用内的事件类型，还支持用户自定义事件类型。

1.4 社交模块

社交模块，为游戏提供社交功能支持，一键集成，功能丰富。社交模块包含以下功能：
1、分享接口，支持分享链接、文字、图片、视频、Facebook OpenGraph；
2、游戏邀请，邀请还没有玩过该游戏的好友跟自己一起玩这款游戏，邀请好友一起玩游戏，还有丰富的邀请奖励；
3、礼物接口，可以向正在和自己玩同一款游戏的好友赠送礼物或者索要礼物，加强玩家的互动；
4、Game Service，游戏互动更简单；
5、社区，提高玩家的积极性和互动。

1.5 应用墙模块

应用墙模块，提供应用、游戏的推广下载，引导用户安装。

注意：此模块会对苹果应用商店上架造成一定的风险，请酌情使用。

1.6消息推送

WINGSDK推送功能是基于苹果APNS，可以向客户端推送消息，通过简单几步配置即可使用。

1.7 广告

WINGSDK广告功能，可以向玩家展示视频广告，并且可以实现奖励机制。

二、快速集成

2.1 环境配置要求

1、系统：Mac OS
2、开发工具：Xcode（8.0及以上）
3、Deployment Target:iOS7.0及以上版本
4、BaseSDK iOS 10.1及以上

2.2 集成SDK到项目

集成SDK需要引用抽象层和实现层。抽象层对接口进行抽象，使用反射机制调用到实现层中具体的代码逻辑。
抽象层主要包括WASdkIntf.framework，以及配置文件wa_sdk_track_config.plist，wa_sdk.plist，如下图。

关于wa_sdk_track_config.plist详见2.6.1 配置 (wa_sdk_track_config.plist)，关于wa_sdk.plist详见2.2.2 WINGSDK基本配置(wa_sdk.plist)。
当调用抽象层接口时候，请导入头文件：
#import <WASdkIntf/WASdkIntf.h>

SDK集成的第三方SDK如下表：

2.2.1 库的引用

SDK的抽象层和实现层以framework的形式提供，CP可以使用cocoapods的方式或者自行下载framework拖进xcode项目的方式进行引用。

方式一：使用cocoapods进行引用

CP可以使用Cocospods进行引用更新。

这部分脚本请使用WINGSDK打包配置页面生成，CP可以将生成的脚本代码复制到自己的Podfile中。
WINGSDK打包配置页面地址：https://admin.wingsdk.com/developers/pack_config.do

目前SDK提供的库包括：
抽象层：

• WASdkIntf——必接

实现层：

• WASdkImpl（WingSdk）——必接

其它可选：

• WAAdImpl(Ad)——可选

• WAAfImpl(Appsflyer)——可选

• WAApImpl(Apple)——可选

• WACbImpl(Chartboost)——可选

• WAFbImpl(Facebook) ——可选

• WAPushImpl(Push)——可选

• WAVkImpl(VK)——可选

• WATwitterImpl(Twitter)——可选

• WAInstagramImpl(Instagram)——可选

• WAWebPayImpl(WebPay)——可选,如果需要第三方支付则需添加此模块

提示:使用CocoaPod引用的项目打开项目时需要点击’xcworkspace’而不是’ xcodeproj’

方式二：手动引用

如果手动引用，可以使用WINGSDK打包配置页面https://admin.wingsdk.com/developers/pack_config.do进行各个包的下载，并添加到xcode项目中。

下载完成后解压，把解压后的文件拖入xcode工程，其中WASdkIntf和WASdkImpl是必接库，其它可选。
注意：需要加入系统库libsqlite3.tbd(libsqlite3.dylib)、libz.tbd(libz.dylib)

2.2.2 WINGSDK基本配置(wa_sdk.plist)

参数说明：
WaSdkServerUrl：WINGSDK后台url（生产环境：https://api.wingsdk.com/sdkapi/）
appKey：WINGSDK后台appKey
appId：WINGSDK后台appId
os：手机操作系统
channel：发布渠道

2.2.3 工程构建配置

在项目Build Settings中搜索Other Linker Flags 修改值为-ObjC
如下图

2.3 SDK初始化

1、请在AppDelegate的didFinishLaunchingWithOptions 调用下面代码:

2、在AppDelegate的applicationDidEnterBackground调用下面代码：

3、在AppDelegate的applicationWillEnterForeground调用下面代码：

4、在AppDelegate的applicationDidBecomeActive调用下面代码：

2.4 登录

登录过程中如果涉及到应用间跳转，需要在AppDelegate中实现以下方法

2.4.1 登录对话框

SDK内置了一个包含所有支持的登录方式的一个对话框，通过调用以下接口打开对话框：

2.4.1.1 实现协议 WALoginViewDelegate

3.4.1.2 调用方法

+(void)login:(id<WALoginViewDelegate>)delegate cacheEnabled:(BOOL)cacheEnabled;
cacheEnabled是否缓存登录方式。如果缓存登录方式，第二次调用的时候直接按照上次的登录方式进行登录，不会弹出登录选择框。如果想弹出登录选择框,请调用clearLoginCache方法,清除缓存
代码示例：

2.4.1.3 清除登录方式的缓存(重新弹出登录选择框)

+(void)clearLoginCache;
代码示例：

2.4.1.4 隐藏登录选择框

+(void)hide;
代码示例：

2.4.2 用户登录接口

如果CP有自己的登录窗口，可以使用WINGSDK登录接口：

2.4.2.1登录接口

(1)选择登录方式

+(void)loginWithPlatform:(NSString *const)platform extInfo:(NSString*)extInfo delegate:(id<WALoginDelegate>)delegate;
注：extInfo目前主要用于应用内登录等高级登录设置，请参考3.3.2 应用内登录相关章节
代码示例：facebook登录

登录平台请参考5.1.2 平台取值

2.4.2.2 实现协议WALoginDelegate中定义的方法

说明：关于APPLE登录，用户每次进入APP进行登录操作，Game Center只进行一次授权。假如用户在第一次登录的时候取消了，以后每次进行登录，程序都会执行登录取消的协议方法，除非用户结束应用重新打开。同样的，第一次登录的时候，出现Game Center授权错误，之后程序都会执行登录失败的协议方法，除非用户结束应用重新打开。

2.4.3 用户登出

退出游戏的时候，必须登出操作。用户登出调用以下接口：
[WAUserProxy logout];
注意：调用logout接口后，serverId、gameUseId、level字段值会被重置，如果需要保持相应字段的值不重置，需要重新设置相应字段的值，参考3.1 公共参数设置

2.5 支付

WINGSDK支付流程如下：

2.5.1 初始化

使用对应平台的支付服务前必须对其进行初始化，请在AppDelegate的didFinishLaunchingWithOptions方法调用以下方法。
+(void)init4Iap;
代码示例：

2.5.2 查询商品

2.5.2.1 实现协议 WAInventoryDelegate

2.5.2.2 调用方法
查寻库存商品，调用以下接口：
+(void)queryInventoryWithDelegate:(id<WAInventoryDelegate>)delegate;
代码示例：

2.5.3 购买商品

2.5.3.1 实现协议 WAPaymentDelegate

支付结果说明 WAIapResult

2.5.3.2 调用方法

购买指定平台的商品，调用以下接口：
+(void)payWithProductId:(NSString*)productId extInfo:(NSString*)extInfo delegate:(id<WAPaymentDelegate>)delegate;
代码示例：

参数说明：

2.5.4支付服务是否可用

通过以下接口可以获取支付服务是否可用，返回boolean类型结果，true为可用，false为不可用，只要有一个支付渠道可用即为true：
+(BOOL)isPayServiceAvailableWithPlatform;
代码示例：

2.6 数据收集

使用WINGSDK数据收集接口配合大数据平台，可以轻松统计玩家习惯以及充值等行为，为游戏的市场营销提供数据依据。WINGSDK数据收集使用在游戏的过程中打点的方式，如图所示：

以上流程图中涉及到的几个接口：setServerId、setGameUserId、setLevel、ghw_user_import事件、ghw_user_create事件是有时序要求的，其它的事件如ghw_initiated_purchase、ghw_purchase、ghw_level_achieved、ghw_user_info_update、ghw_gold_update和ghw_task_update事件则需要在事件发生的对应时机调用接口发送。

2.6.1 配置 (wa_sdk_track_config.plist)

对各个平台进行相应的配置（修改wa_sdk_track_config.plist）。注：文件名以及key值不可修改。

其中，AppleAppID可以在iTunes Connect(https://itunesconnect.apple.com)中新建应用之后获取，具体可以参考iOS-第三方后台配置文档“Apple基础配置”章节。

每个数据收集平台都有相应的开关，可以进行配置。下图的Enable就是开关，Enable： YES-开，NO-关。

WINGSDK URL正式环境的地址： https://api.wingsdk.com/data/

2.6.2 调用

2.6.2.1 导入头文件

#import <WASdkIntf/WASdkIntf.h>

2.6.2.2 工程启动时初始化

您需要在第一次启动在应用程序上进行SDK初始化。请保证在发送下面的跟踪事件之前进行SDK初始化。请在AppDelegate中的didFinishLaunchingWithOptions方法中添加以下代码：
[WACoreProxy initAppEventTracker];

2.6.2.3 调用事件进行追踪

安装和打开游戏事件是内部触发的，另外关于充值事件(WAEventPayment)和点击充值(WAEventInitiatedPayment)的跟踪已经在WINGSDK中自动调用，用户不用自己调用。若不想启用这两个事件的自动跟踪，可在didFinishLaunchingWithOptions进行如下操作：
[WATrackProxy autoTriggerAfterPayment:NO];
调用方法有两种。方法一调用方法简单，但是发送到各个渠道的事件名称（eventName）、参数（params）、累加值（value）是一样的。如果需要自己设置事件名称、参数、累加值，请使用方法二。

2.6.2.3.1 方法一

注：当使用带有小数点的数值时，使用NSDecimalNumber类型，如[NSDecimalNumber decimalNumberWithString:@"8.88"];
调用事件的用法如下：
+(void)trackWithEventName:(NSString *)eventName valueToSum: (double)value params:(NSDictionary *)params;
-eventName:事件名称可在附表中查询
-valueToSum:传入一个double值作为累加值，没有累加值可以传0。
-params:参数字典参数可在附表中查询
例如：

调用购买事件WAEventPayment，
参数：WAEventParameterNameContentType道具类型，
WAEventParameterNameContentID内容ID,
WAEventParameterNameItemAmount购买数量，
WAEventParameterNameCurrencyType货币类型,
WAEventParameterNameCurrencyAmount现金额
…

2.6.2.3.2 方法二

注：当使用带有小数点的数值时，使用NSDecimalNumber类型，如[NSDecimalNumber decimalNumberWithString:@"8.88"];

2.6.2.3.2.1 调用示例

步骤一 构建WAEvent实例

步骤二 发送数据：

2.6.2.3.2.2 关于WAEvent 实例的构建

（1）设置默认的事件名称

设置该事件的事件名称，请参考5.2.1 SDK 预定义事件名
event.defaultEventName = WAEventLevelAchieved;

（2）设置渠道自定义事件名称

注：
1）eventNameDict的key参考附表 2.6.2 渠道名称表
2）AppsFlyer和facebook的应用内事件和WINGSDK的应用内事件已经做了映射（例如: ghw_login <-> af_login，ghw_login<->fb_login，参考下图），用户无需再手动自定义。
3）如果不进行设置，所有的渠道将采用设置的默认值(defaultEventName)。

各渠道事件映射对应表

（3）设置默认累加值

设置累加值用于统计数字，比如购买的金额等
event.defaultValue = 1;

（4）设置渠道自定义累加值

1）valueDict的key值参考 附表2.6.2 渠道名称表
2）如果不进行设置，所有的渠道将采用设置的默认值（defaultValue）。

（5）设置事件默认的参数/值

注：
1）参数名称参考5.2.2 SDK 预定义参数名

（6）设置事件渠道自定义的参数/值

注：
1）渠道名称参考：附表 2.6.2 渠道名称表
2）参数名称参考：5.2.2 SDK 预定义参数名
3）如果不进行设置，所有的渠道将采用设置的默认值（defaultParamValues）

（7）渠道开关设置

注：以上代码会关闭Appsflyer对该事件的收集，而Facebook、WINGSDK、Chartboost是打开的。默认情况下，WINGSDK和Appsflyer是打开的，而Facebook和Chartboost是关闭的。

2.6.3 预定义事件

建议参数属性：（参数对应的静态变量名请看5.2.2 SDK 预定义参数名）

2.6.3.1 WAEventUserImport

说明：导入用户事件，用户每次进服事件–通过用户id在后台查找

注意：发送WAEventUserImport事件前需要调用3.1.1 设置服务器ID 接口更新服务器id

2.6.3.2 WAEventInitiatedPurchase

说明:点击购买的时候调用（用于游戏内部虚拟交易统计）
无参数

2.6.3.3 WAEventPurchase

说明:点击购买的时候调用（用于游戏内部虚拟交易统计）。
注：valueToSum（或者defaultValue）的值要传，而且值要和price一样。

2.6.3.4 WAEventLevelAchieved

说明:统计玩家等级增长事件，达到等级时调用。

注意：发送事件前WAEventLevelAchieved需调用3.1.3 设置用户等级level 接口更新用户等级信息。

2.6.3.5 WAEventUserCreate

说明:创建游戏角色

2.6.3.6 WAEventUserInfoUpdate

说明:更新用户资料

2.6.3.7 WAEventGoldUpdate

说明:玩家货币状况变更统计

2.6.3.8 WAEventTaskUpdate

说明:玩家任务信息统计

2.6.4 自定义事件

事件描述：自定义事件
事件名称：自定义
参数：自定义
有无累计值：自定义
说明:支持自定义事件的统计
自定义

自定义事件目前只支持事件名和累加值，见示例。
例如：

附表 2.6.1 货币标识

详见：https://en.wikipedia.org/wiki/ISO_4217

附表 2.6.2 渠道名称表

三、高级功能

3.1 公共参数设置

WINGSDK包括serverId等公共参数，这些参数主要用于数据跟踪和统计。公共参数必须严格按照文档进行配置，在后续的接口中会使用到这些公共的参数，没有按照要求配置会导致部分接口调用失败。

3.1.1 设置服务器ID

当用户的服务器ID发生改变时，需要调用设置服务器ID接口设置新的服务器ID，例如每次进入服务器：
[WACoreProxy setServerId: @"127.0.0.1"];
注意：设置服务器ID的操作在每次选服后都需要进行，必须在调用其他接口前设置。

3.1.2 设置用户gameUserId

用户在选择服务器并且登录之后将用户gameUserId设置到SDK中以便于跟踪。
[WACoreProxy setGameUserId:@"12345"];

3.1.3 设置用户等级level

设置游戏玩家的角色等级，调用接口：
[WACoreProxy setLevel:10];
注意：第一次进服获取玩家等级或玩家等级变更后，需要及时调用这个接口设置玩家等级，必须在调用其他接口前设置。

3.2 调试模式

WINGSDK具备调试模式并提供了Log悬浮按钮调试工具，打开调试模式就会显示Log悬浮按钮，使用这个工具测试人员不需要IDE环境就可以在工具窗口中查看调试信息。开启/关闭调试模式调用以下接口（WINGSDK默认是关闭调试模式的）。
[WACoreProxy setDebugMode:YES];
关闭调试模式：
[WACoreProxy setDebugMode:NO];

3.3 登录高级设置

3.3.1 设置登录流程接口

使用该接口需注意以下两点：
1)一般来说，如果应用登录的时候有登录方式选择界面，就不需要使用此接口，此接口默认是这种方式（取值为1）。

2)这个接口主要是用来满足以下需求：用户第一次登录是以游客方式进行登录，进到应用里面可以切换其它登录方式，下次登录会直接以切换后的账户进行登录（取值为2）。

+(void)setLoginFlowType:(int)flowType;
代码示例：
[WAUserProxy setLoginFlowType:WA_LOGIN_FLOW_TYPE_DEFAULT];
登录流程有两种模式，在WAConstants类中定义，取值如下表：

3.3.2 应用内登录

SDK平台应用内登录，是指CP本身有自己登录系统，先登录CP后台拿到用户信息后登录SDK后台，应用内登录调用接口2.4.2 用户登录接口 ，登录平台取值WINGA（CHANNEL_WA），将CP后台返回的用户信息按照规定格式（JSON字符串）通过extInfo字段传入。

应用内登录extInfo格式（标准JSON格式字符串）

实例：

字段说明：

3.4 账户管理

3.4.1 使用账户管理页面

SDK内置了账户管理页面，打开这个内置的页面之前必须先登录，通过这个页面可以对账户进行管理操作，包括账号绑定、解绑、切换账户、新建账户。

3.4.1.1 实现协议 WAAcctManagerDelegate

3.4.1.2 调用方法

+(void)openAccountManager:(id<WAAcctManagerDelegate>)delegate;

代码示例：

3.4.1.3 关于绑定解绑的通知

账户管理界面没有返回绑定和解绑结果，但是会以通知的方式将结果回调给CP。当绑定有结果之后（无论成功失败），将回传一个WABindingResult实例。当解绑有结果（无论成功失败），将回传一个WAAccount实例。有四个通知，分别是绑定成功、绑定失败、解绑成功、解绑失败，通知的名称分别是以下常量：
WABindDidSucceedNotification;//绑定成功
WABindDidFailNotification;//绑定失败
WAUnbindDidSucceedNotification;//解绑成功
WAUnbindDidFailNotification;//解绑失败

注：关于绑定facebook成功之后，请注意触发邀请奖励。代码如下：

3.4.2 绑定第三方平台账户

3.4.2.1 实现协议WAAccountBindingDelegate

说明：关于APPLE账号的绑定，请参考2.4.2.2 实现协议WALoginDelegate中定义的方法的说明。

3.4.2.2 调用方法

+(void)bindingAccountWithPlatform:(NSString *const)platform extInfo:(NSString*)extInfo delegate:(id<WAAccountBindingDelegate>)delegate;
绑定平台取值：

示例代码：

3.4.3 查询已经绑定的第三方平台账户

通过以下接口，可以查询当前的账户已经绑定的第三方平台账户：
+(void)queryBoundAccountWithCompleteBlock:(void(^)(NSError* error,NSArray<WAAccount *>* accounts))block;

示例代码：

3.4.4 解绑第三方平台账户

通过以下接口，可以解绑已经绑定的第三方平台账户：
+(void)unBindAccountWithPlatform:(NSString *const)platform platformUserId:(NSString*)pUserId completeBlock:(void(^)(NSError* error))completeBlock;
有以下情况之一者，不可解绑：
1．解绑的账户为WINGSDK平台的；
2．用户没有绑定第三方平台账户的；
3．用户只绑定一个第三方平台账户，且用户没有与当前设备绑定的。
示例代码：

3.4.5 切换账户

使用以下接口可以快速切换登录的账户
+(void)switchAccountWithPlatform:(NSString *const)platform completeBlock:(void(^)(NSError* error,WALoginResult* result))completeBlock;

3.4.6 新建账户

+(void)createNewAccountWithCompleteBlock:(void(^)(NSError* error,WALoginResult* result))completeBlock;

新建账户后，新的账户会跟当前设备绑定，如果之前的账户没有绑定第三方平台账户，数据将会丢失。
代码示例：

3.4.7获取账户信息

SDK提供了获取指定平台的账户信息，可以通过以下接口获取：

+(WAAppUser*)getAccountInfoWithPlatform:(NSString *const)platform;

示例代码：

3.5 应用墙模块功能

注意：此模块会对苹果应用商店上架造成一定的风险，请酌情使用。

3.5.1 应用墙使用

WINGSDK应用墙包含了应用推荐等功能。

3.5.2显示应用墙入口悬浮按钮

[WAApwProxy showEntryFlowIcon];

3.5.3隐藏应用墙入口悬浮按钮

[WAApwProxy hideEntryFlowIcon];

3.6 社交

3.6.1 分享

3.6.1.1 实现协议 WASharingDelegate

3.6.1.2 调用方法

分享调用以下接口，支持分享链接、图片、视频、Facebook OpenGraph：
+(void)shareWithPlatform:( NSString *const)platform shareContent:(NSObject<WASharingContent>*)shareContent shareWithUI:(BOOL)shareWithUI delegate:(NSObject<WASharingDelegate>*)delegate;
示例代码：

参数说明:

3.6.1.3 实体说明

3.6.1.3.1 分享链接内容实体WAShareLinkContent

WAShareLinkContent字段说明

3.6.1.3.2 分享图片内容实体WASharePhotoContent

WASharePhotoContent字段说明

WASharePhoto字段说明

3.6.1.3.3 分享视频内容实体WAShareVideoContent

WAShareVideoContent字段说明

WAShareVideo字段说明

3.6.2 发送请求接口

发送请求接口向平台好友发送请求，请求包括普通请求、游戏邀请（详见3.6.3 游戏邀请）、赠送礼物、索要礼物（礼物详见3.6.4 礼物）等，发送请求调用以下接口：

参数说明:

示例代码：

3.6.3 游戏邀请

3.6.3.1 查询可邀请好友列表

游戏邀请只能邀请没有玩过当前游戏的好友，称为可邀请好友，查询可邀请的好友调用以下接口：
+(void)queryInvitableFriendsWithDuration:(float)duration completeBlock:(void(^)(NSArray* friends,NSError *error))block;

代码示例：

参数说明：

3.6.3.2 游戏邀请（@since v3.5.2 使用发送请求接口代替）

3.6.3.2.1 实现协议 WAGameRequestDialogDelegate

3.6.3.2.2 调用方法

发送游戏邀请请求调用以下接口(注：VK平台一次只能发一次邀请给一个好友)：
+(void)gameInviteWithPlatform:(NSString *const)platform Content:(WAGameRequestContent*)content delegate:(NSObject<WAGameRequestDialogDelegate>*)delegate;
代码示例：

注：如果是VK平台 actionType必须赋值(gameRequestContent.actionType = WAGameRequestActionRequest) VK平台有两个actionType: WAGameRequestActionInvite, WAGameRequestActionRequest。在游戏的测试阶段，请用WAGameRequestActionRequest进行测试。正式上线的时候修改为WAGameRequestActionInvite，参照下图。

3.6.3.3 邀请成功记录

成功邀请好友后，在协议方法-gameRequestDialog:platform:didCompleteWithResults:中调用以下接口向服务器记录邀请信息：
+(void)createInviteInfoWithPlatform:(NSString *const)platform results:(NSDictionary*)results handler:(void (^)(NSUInteger code,NSString* msg, NSError* error)) handler;
示例代码：

3.6.3.4 邀请安装奖励

通过邀请安装使用的用户，安装后需要通知服务器对邀请人进行奖励，必须在玩家进行登录成功或者绑定成功之后时候调用。
+(void)inviteInstallRewardPlatform:(NSString *const)platform TokenString:(NSString*)tokenString handler:(void (^)(NSUInteger code,NSString* msg, NSError* error)) handler;
示例代码：

3.6.3.5 邀请事件奖励

通过邀请安装使用的用户，在触发定义的特定事件，需要通知服务器奖励邀请人，比如等级达成、充值等，调用以下接口：
+(void)inviteEventRewardWithPlatform:(NSString *const)platform eventName:(NSString*)eventName handler:(void (^)(NSUInteger code,NSString* msg, NSError* error)) handler;

代码示例：

3.6.4 礼物

3.6.4.1 查询好友

查询指定平台正在玩游戏的好友列表，调用以下接口：
+(void)queryFriendsWithCompleteBlock:(void(^)(NSArray<WAAppUser *>* friends,NSError *error))block;

示例代码：

3.6.4.2 查询Facebook Graph Object

Facebook的礼物就是在Facebook控制台创建的Graph Object，查询礼物列表的时候调用这个接口，这个接口只针对Facebook平台。

+(void)queryFBGraphObjectsWithObjectType:(NSString*)objectType completeBlock:(void(^)(NSArray<WAFBObject*>* objects,NSError *error))block;

代码示例：
objectType 必须赋值 请参考第三方后台配置—iOS版 2.4 Facebook后台新建礼物

3.6.4.3 Facebook赠送礼物（@since v3.5.2 使用发送请求接口 代替）

使用facebook礼物功能，请先在facebook后台配置相关信息，详情请参考第三方后台配置—iOS版2.4 Facebook后台新建礼物
Facebook用户向游戏内的好友赠送礼物。

3.6.4.3.1 实现协议 WAGameRequestDialogDelegate

同3.6.3.2.1 实现协议 WAGameRequestDialogDelegate

3.6.4.3.2 调用方法

+(void)fbSendGiftWithContent:(WAGameRequestContent*)content delegate:(NSObject<WAGameRequestDialogDelegate>*)delegate;
示例代码：

3.6.4.4 Facebook索要礼物（@since v3.5.2 使用发送请求接口 代替）

Facebook用户向游戏内的好友发出索要礼物的请求。

3.6.4.4.1 实现协议 WAGameRequestDialogDelegate

同3.6.3.2.1 实现协议 WAGameRequestDialogDelegate

3.6.4.4.2 调用方法

+(void)fbAskForGiftWithContent:(WAGameRequestContent*)content delegate:(NSObject<WAGameRequestDialogDelegate>*)delegate;
示例代码：

3.6.4.5 Facebook查询收到的礼物

Facebook用户查询好友赠送给自己的礼物，调用以下接口：

+(void)fbQueryReceivedGiftsWithCompleteBlock:(void(^)(NSArray<WAFBAppRequest *>* gifts,NSError *error))block;

示例代码：

3.6.4.6 Facebook查询向自己索要礼物的请求

Facebook用户查询好友向自己索要礼物的请求，调用以下接口：
+(void)fbQueryAskForGiftRequestsWithCompleteBlock:(void(^)(NSArray<WAFBAppRequest *>* requests,NSError *error))block;
示例代码：

3.6.4.7 删除请求

Facebook中用户收到的礼物，好友向自己索要礼物的请求都是一个Facebook的请求，收取礼物和拒绝赠送礼物的时候，需要删除掉对应的请求。删除请求调用以下接口：

+(void)fbDeleteRequestWithRequestId:(NSString*)requestId completeBlock:(void(^)(id result,NSError *error))block;

示例代码：

3.6.5 社区

3.6.5.1 通过Group id查询Group详情

通过Group id查询Group详情，调用以下接口：
+(void)getGroupWithPlatform:(NSString *const)platform groupIds:(NSArray*)groupIds extInfo:(NSString*)extInfo completeBlock:(void(^)(NSArray* groups,NSError* error))block;

示例代码：

WAGroup实体说明

3.6.5.2 查询当前应用关联的Group

一个应用只能关联一个Group，通过以下接口可以查询当前应用关联的Group详细信息：
+(void)getCurrentAppLinkedGroupWithPlatfrom:(NSString *const)platform extInfo:(NSString*)extInfo completeBlock:(void(^)(NSArray* groups,NSError* error))block;

示例代码：

3.6.5.3 查询当前用户已加入的Group

查询当前用户加入的Group详细信息调用以下接口：
+(void)getCurrentUserGroupWithPlatfrom:(NSString *const)platform extInfo:(NSString*)extInfo completeBlock:(void(^)(NSArray* groups,NSError* error))block;

示例代码：

3.6.5.4 查询当前应用推荐的所有Group

这是3.6.5.2 查询当前应用关联的Group和 3.6.5.3 查询当前用户已加入的Group查询到的Group的汇总，调用以下接口：

+(void)getGroupsWithPlatform:(NSString *const)platform extInfo:(NSString*)extInfo completeBlock:(void(^)(NSArray* groups,NSError* error))block;

示例代码：

3.6.5.5 加入Group

加入指定的某个Group，调用以下接口：

+(void)joinGroupWithPlatform:(NSString *const)platform groupId:(NSString*)groupId extInfo:(NSString *const)extInfo completeBlock:(void(^)(NSError* error))block;

示例代码：

3.6.5.6 进入Group详情页

进入Group的详情页面，调用以下接口：

+(void)openGroupPageWithPlatform:(NSString *const)platform groupUri:(NSString *const)groupUri extInfo:(NSString*)extInfo

如果客户端已经安装platform指定平台的app客户端，将会进入到app客户端详情页面，如果没有安装，则打开网页详情页。
参数说明：

示例代码：

3.7消息推送

WINGSDK推送功能是基于苹果APNS，可以给客户端发送推送通知，通过简单几步配置即可使用。

3.7.1苹果相关配置

导出App推送证书为p12，并上传到WINGSDK后台。
注意：
1、苹果消息推送证书配置请参考Apple官方文档
http://help.apple.com/xcode/mac/current/#/dev11b059073

3.7.2推送集成配置

添加推送模块依赖方法参考2.2 集成SDK到项目
注：Appsflyer卸载检测某些配置与消息推送一样，但如果是用于Appsflyer，此步骤可忽略

3.7.3 Xcode配置

1)开启推送功能

在 Xcode 8.x 以上，必须开启Push Notification能力。找到应用Target设置中的Capabilities -> Push Notifications，确认开关已经设为ON状态。如果没有开启该开关，在 Xcode 8.x 上编译后的应用将获取不到DeviceToken。

2)APNs静默推送权限设置

为了更好支持消息推送，提高消息到达率，需要配置APNs静默推送权限

3.7.4 编写集成代码

1、导入文件头，在AppDelegate中导入:
#import <UserNotifications/UserNotifications.h>

2、初始化消息推送，在AppDelegate的application:initPushWithDelegate:调用下面代码:

注：Appsflyer卸载检测某些配置与消息推送一样，但如果是用于Appsflyer，此步骤可忽略

3、监控用户对推送消息的设置
在AppDelegate的application:didRegisterUserNotificationSettings:调用下面代码:

4、注册DeviceToken
在AppDelegate的application:didRegisterForRemoteNotificationsWithDeviceToken:调用下面代码:

5、监控APNs推送错误
在AppDelegate的application:didFailToRegisterForRemoteNotificationsWithError:调用下面代码:

6、为更好统计用户在不同场景下和不同iOS系统中收到的消息，需在AppDelegate的application:didReceiveLocalNotification:调用下面代码:

7、在iOS 10 以前，为统计 APNs 消息接收事件，需在AppDelegate里的application:didReceiveRemoteNotification:fetchCompletionHandler:回调方法中调用以下接口

对于iOS 10 及以后版本，为统计 APNs 消息接收事件,需要AppDelegate实现协议 UNUserNotificationCenterDelegate，然后在AppDelegate的 userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler:回调方法中调用以下接口：

8、iOS10中，App可以在前台获取通知，为统计这种消息的接收情况，需在AppDelegate的userNotificationCenter:willPresentNotification:withCompletionHandler:调用下面代码:

3.8 越狱检测

WINGSDK具备调试模式并提供了检测设备是否越狱接口

3.9 广告

3.9.1 检测可播放广告数量

+ (NSInteger) checkRewardedVideo;
大于0为可用

示例代码：

3.9.2 显示广告

+ (void) displayRewardedVideoWithExtInfo:(NSString *)extInfo delegate:(id<WAAdRewardedVideoDelegate>)delegate;

示例代码：

3.9.3 广告视频代理

在调用3.9.2显示广告代码，需要实现WAAdRewardedVideoDelegate代理

3.9.3.1 显示视频前页面成功时回调

- (void) adPreDisplayRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId rewarded:(NSString *)rewarded rewardedCount:(NSInteger)rewardedCount extInfo:(NSString *)extInfo;

3.9.3.2 点击叉按钮后回调

- (void) adDidCancelRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId process:(WAAdCancelType)process extInfo:(NSString *)extInfo;

3.9.3.3 加载视频失败回调

- (void) adDidFailToLoadRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId extInfo:(NSString *)extInfo;

3.9.3.4 播放视频结束回调

- (void) adDidDisplayRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId rewarded:(NSString *)rewarded rewardedCount:(NSInteger)rewardedCount extInfo:(NSString *)extInfo;

3.9.3.5 播放完视频点击回调

- (void) adDidClickRewardedVideoWithCampaignId:(NSString *)campaignId adSetId:(NSString *)adSetId rewarded:(NSString *)rewarded rewardedCount:(NSInteger)rewardedCount extInfo:(NSString *)extInfo;

3.9.4 设置视频广告缓存完代理

+ (void)setWAAdRewardedVideoCachedDelegate:(id<WAAdRewardedVideoCachedDelegate>)delegate;

示例代码：

3.9.5 视频广告缓存完代理

在调用3.9.4设置视频广告缓存回调代码，需要实现WAAdRewardedVideoCachedDelegate代理

视频广告缓存完成回调
- (void)adDidRewardedVideoCachedWithCacheCount:(NSInteger)cacheCount;

四、第三方配置

4.1 Facebook相关配置

4.1.1 Facebook基本配置

游戏如需使用Facebook相关登录、社交、数据收集功能，需要进行以下配置。如果不需要相关功能，请忽略此章节
具体配置请参考第三方后台配置—iOS版 二、Facebook第三方登录后台配置。
1、在facebook开发者平台创建一个Facebook应用，创建完之后会生成App ID和App Secret
这里的App ID要配置在项目当中，作为客户端与后台服务器连接的标识


2、在Xcode中配置相应的信息，主要是在info.plist文件中配置URL Schemes、FacebookAppID、FacebookDisplayName。注意一定要对应到facebook后台该App的App ID和Display Name。参考步骤1的截图。

3、针对iOS9做的一些配置
(1)Whitelist Facebook Servers for Network Requests
在info.plist增加下面配置

(2)Whitelist Facebook Apps

4.1.2 Facebook登录权限对照表

4.1.3 Facebook后台新建Graph Object

具体配置请参考第三方后台配置—iOS版2.4 Facebook后台新建礼物。

WAFBGraphObject 中的字段与新建Object字段对照（“-”标识系统自动生成）

4.2 APPLE相关配置

游戏如需使用APPLE账号进行登录、APPLE商店进行支付，需要进行以下配置。 如果不需要使用APPLE相关功能，请忽略此章节
具体配置请参考第三方后台配置—iOS版 一、Apple后台应用配置。

4.3 Appsflyers 相关配置

游戏如需使用Appsflyer相关数据收集功能，需要进行以下配置。如果不需要相关功能，请忽略此章节

4.3.1 数据收集配置

详见2.6.1 配置 (wa_sdk_track_config.plist)

4.3.2卸载检测

a)官方说明：https://support.appsflyer.com/hc/en-us/articles/211211963-iOS-Uninstall-Tracking

b)对接WINGSDK代码同3.7消息推送

4.4 Chartboost 相关配置

游戏如需使用Chartboost相关数据收集功能，需要进行以下配置。如果不需要相关功能，请忽略此章节
1.数据收集配置：详见2.6.1 配置 (wa_sdk_track_config.plist)

4.5 VK相关配置

游戏如需使用VK相关登录、社交功能，需要进行以下配置。如果不需要相关功能，请忽略此章节
在xcode配置URL Schemes:
在VKapp管理后台https://vk.com/apps?act=manage找到对应App的配置信息。将下图中Application ID(标注1)填到Xcode中的URL Schemes(标注2)。注意加上前缀vk。

4.6 Twitter相关配置

游戏如需使用Twitter账号登录游戏，需要进行以下配置。如果不需要相关功能，请忽略此章节
Twitter需要iOS 9.0以上编译，如果使用9.0以下版本编译，会导致应用闪退。具体配置请参考第三方后台配置—iOS 四、Twitter后台应用配置
1、在twitter开发者平台创建一个twitter应用，创建完之后会生成Consumer Key和Consumer Secret

这里的Consumer Key和Consumer Secret要配置在项目info.plist中，作为客户端与后台服务器连接的标识。

可复制下面代码到info.plist中在修改为对应Consumer Key和Consumer Secret。

2、配置URL Scheme

URL Scheme格式：twitterkit-
例如: twitterkit-SPRwO9pH5p9bJCAbUHaiV8oQY

4.7 Instagram相关配置

游戏如需使用Instagram账号登录游戏，需要进行以下配置。如果不需要相关功能，请忽略此章节
具体配置请参考第三方后台配置—iOS 五、Instagram后台应用配置
在instagram开发者平台创建一个instagram应用，创建完之后会生成Client ID、Client Secret和Website URL
这里的Client ID、Client Secret和Website URL要配置在项目info.plist中clientId、clientSecret和redirectUri，作为客户端与后台服务器连接的标识。

可复制下面代码到info.plist中在修改为对应clientId、clientSecret和redirectUri

五、附录

5.1 代码说明

5.1.1 状态码说明

SDK所有的状态码都定义在枚举WACode中，详见下表：

5.1.2 平台取值

5.1.3 请求类型说明

注：vk平台测试游戏邀请功能需要申请权限，可以把请求类型设置成WA_REQUEST_TYPE_REQUEST来测试普通邀请，带申请权限通过后改成WA_REQUEST_TYPE_INVITE来测试。关于vk邀请功能的业务流程图如下：

5.2 事件说明

5.2.1 SDK 预定义事件名

5.2.2 SDK 预定义参数名