‹ Facebook Doc Home

Facebook 集成指南

For the Javascript version of cocos2d-x v3.x - (all other versions)

集成

用如下命令来集成 SDKBOX Facebook 插件,请确保您可以正常执行的 SDKBOX 安装器.

sdkbox import facebook

~~从 China 服务器下载~~ 服务器已停止

如果你在中国, 并且下载插件的速度比较慢, 可以尝试使用位于中国的服务器来下载, 查询插件, 使用方法为在你的 sdkbox import 后加 --server china 及可, 比如:

sdkbox import xxx  --server china

xxx 为你的插件名字

重点注意事项

如果您升级到了 Xcode7, 则需要以下额外步骤来确保插件工作正常:

禁用应用程序安全传输策略

添加以下项到 plist:

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

添加后的文件内容看起来就像这样:

禁止 Bitcode 支持

您必须禁止 Bitcode 的支持,否则将会编译失败。

游戏全屏配置

如果您的游戏不同时支持横竖屏,则必须在 Xcode 中选中 Requires full screen,否则将不会通过 Apple 的审核。

canOpenURL 白名单

取决于您使用哪些插件。需要在 info.plistLSApplicationQueriesSchemes 下添加名单。

FAQ

  1. 切换 Facebook 登录方式,使用应用、浏览器方式登录, 清理 Safari Cookie
  2. 切换 Facebook 登录账号, 清理 Safari Cookie

额外的步骤

下面的步骤假定您已经注册为 Facbbook 开发者,并创建了一个 APP

iOS的步骤

- (void)applicationDidBecomeActive:(UIApplication *)application {
  [FBSDKAppEvents activateApp];
}

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
  // ...

  //
  // **************************
  // !! 非常重要,非常重要,非常重要 !!
  // **************************
  //
  // 在 app->run() 前调用
  // [[FBSDKApplicationDelegate sharedInstance] application:didFinishLaunchingWithOptions

  [[FBSDKApplicationDelegate sharedInstance] application:application
                                      didFinishLaunchingWithOptions:launchOptions];
  app->run();
  return YES;
}

- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
            options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {

  BOOL handled = [[FBSDKApplicationDelegate sharedInstance] application:application
    openURL:url
    sourceApplication:options[UIApplicationOpenURLOptionsSourceApplicationKey]
    annotation:options[UIApplicationOpenURLOptionsAnnotationKey]
  ];
  // Add any custom logic here.
  return handled;
}

- (BOOL)application:(UIApplication *)application
            openURL:(NSURL *)url
  sourceApplication:(NSString *)sourceApplication
         annotation:(id)annotation {

  BOOL handled = [[FBSDKApplicationDelegate sharedInstance] application:application
    openURL:url
    sourceApplication:sourceApplication
    annotation:annotation
  ];
  // Add any custom logic here.
  return handled;
}

在 Xcode8 iOS10 模拟器上,不能登录:

Go to the `Project Target` and then `Capabilities` and switch `Keychain Sharing ON`.

http://stackoverflow.com/a/39788102/5443510

Android的步骤

JSON 配置

SDKBOX 安装器会为您自动生成一个 sdkbox_config.json 配置文件

下面给出一个例子,您可以打开/关闭Facebook的调试模式

"Facebook":
{
    "debug":true
}

~~邀请朋友~~

https://developers.facebook.com/docs/ios/change-log-4x/

The App Invites feature has been deprecated. (4.28.0 - November 7, 2017)

使用

注册 javascript 函数

在使用 Fackbook JS 函数之前,您要把它们注册到 cocos2d-x中.

这样做: * 修改 ./frameworks/runtime-src/Classes/AppDelegate.cpp 包含如下头文件:

#include "PluginFacebookJS.hpp"
#include "PluginFacebookJSHelper.h"
sc->addRegisterCallback(register_all_PluginFacebookJS);
sc->addRegisterCallback(register_all_PluginFacebookJS_helper);

初始化 Facebook

sdkbox.PluginFacebook.init();

使用 Facebook

登录

用户在使用前需要登录到 Facebook.

sdkbox.PluginFacebook.login();

用户不想使用 Facebook 时,可以注销

sdkbox.PluginFacebook.logout();

您可以检查用户是否已经登录

sdkbox.PluginFacebook.isLoggedIn();

注意: 用户只需要登录一次, 除非他们注销

权限

Facebook 要求您在使用前去询问用户要相应的权限,比如 posting 相关的权益 就有两类权限, read and publish 您也可以通过这里得到完整的信息

要获取权限,您可以指定您想要权限,比如:

sdkbox.PluginFacebook.requestReadPermissions(["public_profile", "email"]);
sdkbox.PluginFacebook.requestPublishPermissions(["publish_actions"]);

分享

提供了两个分享功能

var info = new Object();
info.type  = "link";
info.link  = "http://www.cocos2d-x.org";
info.title = "cocos2d-x";
info.text  = "Best Game Engine";
info.image = "http://cocos2d-x.org/images/logo.png";
sdkbox.PluginFacebook.share(info);

分享图片:

var info = new Object();
info.type  = "photo";
info.title = "My Photo";
info.image = __path to image__;
sdkbox.PluginFacebook.share(info);

显示一个对话框:

var info = new Object();
info.type  = "link";
info.link  = "http://www.cocos2d-x.org";
info.title = "cocos2d-x";
info.text  = "Best Game Engine";
info.image = "http://cocos2d-x.org/images/logo.png";
sdkbox.PluginFacebook.dialog(info);

分享带有文字注解的图片:

var info = new Object();
info.type  = "photo";
info.title = "My Photo";
info.image = __path to image__;
sdkbox.PluginFacebook.dialog(info);

注意: 分享带有文字注解的图片需要用户的手机上已安装了 Facebook 应用.

图谱API

您可以通过 api 函数 执行图谱API

比如,取好友列表:

var params = new Object();
sdkbox.PluginFacebook.api("/me/friendlists", "GET", params, "/me/friendlists");

Facebook 事件

您可以接收 Facebook 事件, 然后对不同事件做相应的处理.

sdkbox.PluginFacebook.setListener({
    onLogin: function(isLogin, msg) {},
    onAPI: function(tag, data) {},
    onSharedSuccess: function(data) {},
    onSharedFailed: function(data) {},
    onSharedCancel: function() {},
    onPermission: function(isLogin, msg) {}
});

API Reference

Methods

sdkbox.PluginFacebook.init();

initialize the plugin instance.

sdkbox.PluginFacebook.login();

log in

sdkbox.PluginFacebook.login(permissions);
sdkbox.PluginFacebook.requestReadPermissions(permissions);

log in with specific read permissions, conflict with publish permissions https://developers.facebook.com/docs/facebook-login/permissions

sdkbox.PluginFacebook.requestPublishPermissions(permissions);

log in with specific public permissions https://developers.facebook.com/docs/facebook-login/permissions

sdkbox.PluginFacebook.logout();

log out

sdkbox.PluginFacebook.isLoggedIn();

Check whether the user logined or not

sdkbox.PluginFacebook.getUserID();

get UserID

sdkbox.PluginFacebook.getAccessToken();

get AccessToken

sdkbox.PluginFacebook.getPermissionList();

get permissoin list

sdkbox.PluginFacebook.share(info);

share

sdkbox.PluginFacebook.dialog(info);

open a dialog of Facebook app or WebDialog (dialog with photo only avaible with native Facebook app)

sdkbox.PluginFacebook.getSDKVersion();

return the version of Facebook SDK

sdkbox.PluginFacebook.fetchFriends();

fetch friends data from Facebook

sdkbox.PluginFacebook.canPresentWithFBApp(info);

check whether can present Facebook App

sdkbox.PluginFacebook.inviteFriends(app_link_url, preview_image_url);

Use the default FB dialog to invite friends.

sdkbox.PluginFacebook.setAppId(appId);

Set the Facebook App ID to be used by the FB SDK.

sdkbox.PluginFacebook.setAppURLSchemeSuffix(appURLSchemeSuffix);

Set the app url scheme suffix used by the FB SDK.

Listeners

onLogin(isLogin, msg);
onSharedSuccess(message);
onSharedFailed(message);
onSharedCancel();
onAPI(key, jsonData);
onPermission(isLogin, msg);
onFetchFriends(ok, msg);
onRequestInvitableFriends(friends);
onInviteFriendsWithInviteIdsResult(result, msg);
onInviteFriendsResult(result, msg);
onGetUserInfo(userInfo);

手动集成

如果 SDKBOX 安装器 安装插件失败了,那么需要手动集成插件.如果安装器安装插件成功了,那么不需要,也没必要,按文档再手动集成一次.

下面列出的的步骤一般很少用到.如果你按下面的步骤完成了集成,请在完成集成后,再按步骤检查一次.

iOS 平台手动集成

拖拽下列 framework 从 Facebook 插件包的 plugins/ios 目录到您的 Xcode 工程中,在添加 frameworks 的时候,请勾选 Copy items if needed

sdkbox.framework

PluginFacebook.framework

上面的 frameworks 依赖于大量其他 frameworks。如果您没有添加它们,您也需要添加下列这些 frameworks:

Security.framework

plugin/jsbindings 文件夹中所有的头文件和源文件都拷贝到你的工程的 Classes 文件夹中.

把刚刚拷贝的文件拖动到 Xcode 中或使用 File -> Add files to... 来添加.

Android 平台手动集成

拷贝文件

从插件安装包中的 plugin/android/libs 目录拷贝下列 jar 文件到您的工程的 proj.android/libs 目录。

PluginFacebook.jar

sdkbox.jar

plugin/android/jni 目录拷贝 pluginfacebook 以及 sdkbox 目录到您的工程的 proj.android/jni 目录。如果 sdkbox 目录在工程中已经存在,请覆盖它。

plugin/android/libs 拷贝 facebook_lib 目录到您的 proj.android/libs/ 目录。

编辑 AndroidManifest.xml

在标签 application tag 上添加下列权限:

  <uses-permission android:name="android.permission.INTERNET" />

还有一些必要的元数据标签需要添加:

<meta-data android:name="com.facebook.sdk.ApplicationId" android:value="@string/facebook_app_id"/>
<activity android:name="com.facebook.FacebookActivity"
  android:configChanges=
         "keyboard|keyboardHidden|screenLayout|screenSize|orientation"
  android:theme="@android:style/Theme.Translucent.NoTitleBar"
  android:label="@string/app_name" />

  <provider android:authorities="com.facebook.app.FacebookContentProvider__replace_with_your_app_id__"
  android:name="com.facebook.FacebookContentProvider"
  android:exported="true" />

编辑 strings.xml

打开 res/values/strings.xml,添加一个新的名为 facebook_app_id 的字串,其值是您的 Facebook App ID。比如:

xml <?xml version="1.0" encoding="utf-8"?> <resources> <string name="app_name">facebook</string> <string name="facebook_app_id">280194012150923</string> </resources>

编辑 Android.mk

编辑 proj.android/jni/Android.mk

LOCAL_STATIC_LIBRARIES 添加额外的库:

LOCAL_STATIC_LIBRARIES += PluginFacebook
LOCAL_STATIC_LIBRARIES += sdkbox

在所有 import-module 语句之前添加一条 call 语句:

$(call import-add-path,$(LOCAL_PATH))

在最后添加额外的 import-module 语句:

$(call import-module, ./sdkbox)
$(call import-module, ./pluginfacebook)

这意味着您的语句顺序看起来像是这样:

$(call import-add-path,$(LOCAL_PATH))
$(call import-module, ./sdkbox)
$(call import-module, ./pluginfacebook)

Note: 如果您使用的是 cocos2d-x 预编译库,那么保证这些语句在已有的 $(call import-module,./prebuilt-mk) 语句之上非常重要。

编辑 Application.mk (只限 Cocos2d-x v3.0 到 v3.2 版本)

编辑 proj.android/jni/Application.mk 保证 APP_STL 的定义正确。如果 Application.mk 包含了 APP_STL := c++_static 语句,那么这条语句应该被改为:

APP_STL := gnustl_static

plugin/jsbindings 文件夹中所有的头文件和源文件都拷贝到你的工程的 Classes 文件夹中.

把你刚刚拷贝的 .cpp 文件添加到 Android.mk 文件的的 LOCAL_SRC_FILES 项.比如

LOCAL_SRC_FILES := hellocpp/main.cpp \
                  ../../Classes/AppDelegate.cpp \
                  ../../Classes/HelloWorldScene.cpp \
                                    ../../Classes/NewSourceFile.cpp

修改 AppActivity.java

插件版本 >= 2.4.0.3

  1. 找到 AppActivity.java 文件
find . -name "AppActivity.java"
  1. extends Cocos2dxActivity 替换为 extends com.sdkbox.plugin.SDKBoxActivity

以下是 AppActivity.java 不同版本的引擎所在的目录:

cpp
  - proj.android/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android-studio/app/src/org/cocos2dx/cpp/AppActivity.java
  - proj.android/app/src/org/cocos2dx/cpp/AppActivity.java ( from cocos2d-x 3.17)

lua
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android-studio/app/src/org/cocos2dx/lua/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/lua/AppActivity.java (from cocos2d-x 3.17)

js
  - frameworks/runtime-src/proj.android/src/org/cocos2dx/javascript/AppActivity.java
  - frameworks/runtime-src/proj.android/app/src/org/cocos2dx/javascript/AppActivity.java ( from cocos2d-x 3.17)

插件版本 < 2.4.0.3

Note: 当你使用 cocos2d-x 源代码时,不同的版本中 Cocos2dxActivity.java 文件的位置也不同。一个确定该文件位置的方法是查看 proj.android/project.properties 。比如:

android.library.reference.1=../../cocos2d-x/cocos/platform/android/java

在这个例子中, Cocos2dxActivity.java 文件应该在如下位置:

../../cocos2d-x/cocos/platform/android/java/src/org/cocos2dx/lib/Cocos2dxActivity.java
import android.content.Intent;
import com.sdkbox.plugin.SDKBox;
onLoadNativeLibraries();
SDKBox.init(this);
    @Override
    protected void onActivityResult(int requestCode, int resultCode, Intent data) {
          if(!SDKBox.onActivityResult(requestCode, resultCode, data)) {
            super.onActivityResult(requestCode, resultCode, data);
          }
    }
    @Override
    protected void onStart() {
          super.onStart();
          SDKBox.onStart();
    }
    @Override
    protected void onStop() {
          super.onStop();
          SDKBox.onStop();
    }
    @Override
    protected void onResume() {
          super.onResume();
          SDKBox.onResume();
    }
    @Override
    protected void onPause() {
          super.onPause();
          SDKBox.onPause();
    }
    @Override
    public void onBackPressed() {
          if(!SDKBox.onBackPressed()) {
            super.onBackPressed();
          }
    }

混淆 (release模式下可选)

proguard.config=proguard.cfg
-libraryjars libs/facebook_lib/libs/android-support-v4.jar

-keep class * extends java.util.ListResourceBundle {
    protected Object[][] getContents();
}

注意: 混淆只在 Release 模式下有效 (比如 cocos run -m release), 在 debug 模式下,不会调到混淆规则.