#Facebook SDK for Cocos2d-JS API Reference
##Getting started
在开始使用Facebook SDK之前，你需要对Cocos2d-JS工程有一点了解，并且学会如何整合Facebook SDK到你的工程中。首先，请阅读Cross native / browser game with Cocos Console 文档。这会帮助你对Cocos2d-JS的架构和工作流有一个基本的认识。
然后你可以阅读下面的文档来整合Facebook SDＫ到你的Cocos2d-JS工程中去。
- Integrate the Facebook SDK for Cocos2d-JS on Android
- Integrate the Facebook SDK for Cocos2d-JS on iOS
- Integrate the Facebook SDK for Cocos2d-JS on Web
接下来你可以查看我们的测试用例，里面包括了Facebook SDK的所有功能展示。请阅读这篇文档来运行测试用例。
我们也邀请你阅读更多的Cocos2d-JS文档。
##API list
###FacebookAgent class
plugin.FacebookAgent 是一个单例类，封装了Facebook SDK for Cocos2d-JS的方法。在你开始做任何事之前，应该先初始化它的实例。
###Core Methods
| Name | Description |
|---|---|
| getInstance | 初始化SDK，返回plugin.FacebookAgent的实例. 在做其他事之前应该首先被调用。 |
| destroyInstance | 销毁plugin.FacebookAgent的实例。 |
| api | 调用Facebook Graph API。 |
| dialog | 唤起不同形式的Facebook对话框，例如在Facebook上进行分享的对话框，或者向好友发送消息的对话框。 |
| canPresentDialog | 检查当前用户的设备是否可以唤起某个Facebook的对话框。 |
| appRequest | 在游戏中唤起Request对话框向一个或多个好友发送邀请。 |
###Auth and Session Methods
| Name | Description |
|---|---|
| login | 请求用户授权你的app，或者用于获得附加权限。 |
| logout | 登出Facebook。 |
| isLoggedIn | 检查用户是否已经登陆，并且授权了你的app。 |
| getUserId | 获得当前登陆用户的Facebook用户ID。 |
| getAccessToken | 获得当前用户在你的app的access token。 |
###Auxiliary Methods
| Name | Description |
|---|---|
| canvas.pay | 让用户使用 Facebook Payments来进行支付。只可以在桌面使用。 |
| activateApp | 报告用户启动app，用来整合Facebook广告。更多详情 App Events。 |
| logEvent | 报告一个app event，用来整合Facebook广告。更多详情 App Events。 |
| logPurchase | 报告一个purchase event，用来整合Facebook广告。更多详情 App Events。 |
##Facebook SDK Features
| Methods | iOS | Android | Web |
|---|---|---|---|
| api | √ | √ | √ |
| dialog - shareLink | √ | √ | √ |
| dialog - shareOpenGraph | √ | √ | √ |
| dialog - sharePhoto | √ | √ | × |
| dialog - messageLink | √ | √ | √ |
| dialog - messageOpenGraph | √ | √ | × |
| dialog - messagePhoto | √ | √ | × |
| dialog - feedDialog | √ | √ | √ |
| appRequest | √ | √ | √ |
| login | √ | √ | √ |
| logout | √ | √ | √ |
| isLoggedIn | √ | √ | √ |
| getUserId | √ | √ | √ |
| getAccessToken | √ | √ | √ |
| canvas.pay | × | × | √ |
| activateApp | √ | √ | √ |
| logEvent | √ | √ | √ |
| logPurchase | √ | √ | √ |