Skip to content
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.

Getting Started Guide

Step1: Download the cocos2d-x components of the ShareSDK

Open Github download the C2DXShareSDKSample projects. The project C2DXShareSDK folder copy to your project.

Step2: Modify AppDelegate file

Open the "AppDelegate.cpp" file, import the header file "C2DXShareSDK.h". Such as:

#include "C2DXShareSDK.h"

In AppDelegate :: applicationDidFinishLaunching method, add the following code to initialize ShareSDK and configure the social platform information.

bool AppDelegate::applicationDidFinishLaunching() {

        C2DXShareSDK::open(CCString::create("api20"), false);
        CCDictionary *sinaConfigDict = CCDictionary::create();
        sinaConfigDict -> setObject(CCString::create("568898243"), "app_key");
        sinaConfigDict -> setObject(CCString::create("38a4f8204cc784f81f9f0daaf31e02e3"), "app_secret");
        sinaConfigDict -> setObject(CCString::create(""), "redirect_uri");
        C2DXShareSDK::setPlatformConfig(C2DXPlatTypeSinaWeibo, sinaConfigDict);


Note: where the configuration items in social platform configuration information, refer to "Social Platform Configuration Item Description" document.


First, create a structure to share content, as follows:

CCDictionary *content = CCDictionary::create();
content -> setObject(CCString::create("This is a test content"), "content");
content -> setObject(CCString::create(""), "image");
content -> setObject(CCString::create("Test title"), "title");
content -> setObject(CCString::create("Test description"), "description");
content -> setObject(CCString::create(""), "url");
content -> setObject(CCInteger::create(C2DXContentTypeNews), "type");

Then the content object incoming share interfaces. such as:

C2DXShareSDK::showShareMenu(NULL, content, shareResultHandler);

shareResultHandler is callback method, which is defined as follows:

void shareResultHandler(C2DXResponseState state, C2DXPlatType platType, CCDictionary *shareInfo, CCDictionary *error)
    switch (state) {
        case C2DXResponseStateSuccess:
            CCLog("share success!");
        case C2DXResponseStateFail:
            CCLog("share fail!");

User Authorization

To get the authorized users information by call the C2DXShareSDK::geUserInfo method . Code is as follows:

C2DXShareSDK::getUserInfo(C2DXPlatTypeSinaWeibo, getUserResultHandler);

getUserResultHandler is callback method, which is defined as follows:

void getUserResultHandler(C2DXResponseState state, C2DXPlatType platType, CCDictionary *userInfo, CCDictionary *error)
    if (state == C2DXResponseStateSuccess)
        //Output user information
        CCArray *allKeys = userInfo -> allKeys();
        for (int i = 0; i < allKeys -> count(); i++)
            CCString *key = (CCString *)allKeys -> objectAtIndex(i);
            CCObject *obj = userInfo -> objectForKey(key -> getCString());
            CCLog("key = %s", key -> getCString());
            if (dynamic_cast<CCString *>(obj))
                CCLog("value = %s", dynamic_cast<CCString *>(obj) -> getCString());
            else if (dynamic_cast<CCInteger *>(obj))
                CCLog("value = %d", dynamic_cast<CCInteger *>(obj) -> getValue());
            else if (dynamic_cast<CCDouble *>(obj))
                CCLog("value = %f", dynamic_cast<CCDouble *>(obj) -> getValue());

Integration for iOS (Not released iOS version of the application can skip this section)

Step1: The iOS version of ShareSDK into the project:

Login ShareSDK official website to download and extract the latest version of the SDK. If you have not downloaded yet, please click here to download or access After extracting the following diagram:


The ShareSDK_vX.XX (XXX represents SDK version number) directory are copied to your cocos2d-x project. Figure:


The ShareSDK into the project, and add the appropriate dependencies. This step can refer to: "iOS Quick Integration Guide" in the first, the second step. After execution, as shown below:


Step2: Modify AppController file

Open the "" file, add ShareSDK.h header file:

#import <ShareSDK/ShareSDK.h>

Add handleOpenURL method, as follows:

@implementation AppController


- (BOOL)application:(UIApplication *)application handleOpenURL:(NSURL *)url
    return [ShareSDK handleOpenURL:url sourceApplication:nil annotation:nil wxDelegate:nil];

- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation
    return [ShareSDK handleOpenURL:url sourceApplication:sourceApplication annotation:annotation wxDelegate:nil];

In the integrated WeChat, QQ, Google+, Pinterest, RenRen platform, you need to import the relevant type. Code is shown below:

#import "WXApi.h"      //WeChat
#import "WBApi.h"      //Tencent Weibo
#import <TencentOpenAPI/QQApiInterface.h>     //QQ Connect
#import <TencentOpenAPI/TencentOAuth.h>      //QQ Connect
#import <RennSDK/RennSDK.h>     //人人网
#import <Pinterest/Pinterest.h>     //Pinterest
#import <GoogleOpenSource/GoogleOpenSource.h>    //Google+
#import <GooglePlus/GooglePlus.h>     //Google+

@implementation AppController


- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {    
    //Import WeChat Class
    [ShareSDK importWeChatClass:[WXApi class]];
    //Import Tencent Weibo Class
    [ShareSDK importTencentWeiboClass:[WBApi class]];
    //Import QQ Class
    [ShareSDK importQQClass:[QQApiInterface class] tencentOAuthCls:[TencentOAuth class]];
    //Import RenRen Class
    [ShareSDK importRenRenClass:[RennClient class]];
    //Import Pinterest Class
    [ShareSDK importPinterestClass:[Pinterest class]];
    //Import Google+ Class
    [ShareSDK importGooglePlusClass:[GPPSignIn class] shareClass:[GPPShare class]];


Integration for Android (Not released Android version of the application can skip this section)

Note This section describes how to integrate ShareSDK into coco2d-x with custom JNI codes, if you want to find ”how to integrate ShareSDK with pure Java codes”, please click HERE. And if you want to find ”how to integrate ShareSDK with plugin-x”, please click HERE.

Integration Steps

1 Download the latest version of ShareSDK from our official website and extract it.

2 Refer to the "Five Steps to Integrate ShareSDK" chapter, use “copy jars and resources into your project” way to import ShareSDK to your project. After these two steps, your project should include the followings: (1) Java source codes of OnekeyShare. (2) If you integrate Wechat or Yixin, your project should include the package wxapi or yxapi. (3) Resources of ShareSDK and OnekeyShare must have been added into your “res” directory. (4) Jars of ShareSDK must have been copied into your “libs” directory. (5) Besides resources of cocos2d-x, there is a SahreSDK.xml file in your “assets” directory.

3 Refer to the "Five Steps to Integrate ShareSDK" chapter, modify the “AndroidManifest.xml” file.

4 Applications information in "ShareSDK.xml" are public keys for demonstration. Please change the information of each platform in this file to your application’s refering to the "Five Steps to Integrate ShareSDK" chapter.

5 Pull the source codes on Github, and copy the followings into your project: (1) Copy “cn.sharesdk.ShareSDKUtils” into your “src”. (2) Copy “libs/armeabi” to your “libs”.

6 Open the class you extend from Cocos2dxActivity, add the following line into its onCreate method:


## Explanation of Java Codes

Basically there is only a ShareSDKUtils Java class, and what you have to do in Java codes is adding the **prepare** in your subclass of Cocos2dxActivity. However, if you want to add more parameters of sharing (the example on github only provides very few parameters to share), you may have to modify the following methods:

```` java
nativeMapToJavaMap(HashMap<String, String>)
This method is to transfer the name of the parameters to share from the JNI type to the Java types. If you add the share parameter in native codes, you need to modify this method, add a new rule to translate the name of this parameter to ShareSDK. [HERE]( is the table lists the name of the share parameters in ShareSDK.

```` java
onekeyShare(HashMap<String, String>)
This method calls OnekeyShare module of ShareSDK, like the method above, if you want to modify the share parameters in native codes, you may need to modify this method.

It is important to note that ShareSDKUtils.prepare() must be called in the **main thread**, and before any operation of ShareSDK. Otherwise it will result in an error in ShareSDKUtils initializing.

## Explanation of Native Codes

**Using custom JNI codes is not an encouraged way of Android platform to integrating ShareSDK**, since you have to add a ton of native-java reflection code which is inefficient and prone to errors. But this method can shield the differences between the platforms by c/c++ codes, and also be complementary to the plugin-x.

Native codes are basically the reflection between native and java codes. However, like Java codes, if you want to modify the native codes, you may need to be carefully with the following methods:

```` c
These three methods are java to native action callbacks, don’t change their names.

```` c
These two methods process the transform between HashMap and CCDictionary.

```` c
This is not a necessary method in Android, since we have a more convenient way to configure your applications information in the file “ShareSDK.xml”.

**View Chinese Integration Guide, please click [here](**

You can’t perform that action at this time.