iosswiftwechat

How to add the WeChat API to a Swift project?

I'm trying to add WeChat sharing functionality to my project. However the SDK files, documentation, development guides, and sample project are all in Objective-C. I am writing my project in Swift.

What I've tried

I added the following following SDK files to my project

libWeChatSDK.a
WechatAuthSDK.h
WXApi.h
WXApiObject.h

I tried following the advice on this answer for using a bridging header.

MyProject-Bridging-Header.h

#import "WXApi.h"

Errors

However, I'm still not able to use the WeChat API in my code. I'm getting the following errors:

WXApiObject.h

- (void) setThumbImage:(UIImage *)image;    // Expected a type

WXApi.h

+(BOOL) sendAuthReq:(SendAuthReq*) req viewController : (UIViewController*) viewController delegate:(id<WXApiDelegate>) delegate;
// Expected a type

And

<unknown>:0: error: failed to import bridging header '[my path]/MyProject-Bridging-Header.h'

Question

Has anyone been successful in using the WeChat API with a Swift Project? I would love to see a brief list of steps or some sample code. I don't mind if any supplemental links are to Chinese resources.

Solution

  • See @chengsam's answer for newer updates to this process.

    How to use the WeChat SDK in your Swift project

    The official WeChat developer English instructions seem to be out of date and incomplete. The Chinese instructions are better but only deal with Objective-C. The steps below show how to add the WeChat (weixin 微信) SDK to your project.

    Apply for a WeChat App ID

    The English site is dev.wechat.com. I was never able to successfully register on the English site, though. I ended up using the Chinese site: open.weixin.qq.com. How to do that is beyond the scope of this answer, but if you don't know Chinese, Google translate can help. Note that you will probably also need a phone number in China.

    After your app is approved (you only have to describe your app, no need to provide a binary or source code), you will get an App ID, which you will use in your code.

    Download the WeChat SDK

    You can try to use the SDK from the English site, but since things seem to be more current at the time of this writing on the Chinese site, that is where I downloaded the SDK for these instructions.

    I downloaded the SDK from this page and the link for WeChat SDK version 1.6.2 is here. You will probably want to use the most recent version, though, whatever that may be in the future.

    Copy the SDK files into your Xcode project

    For organization sake, I put all the files in the same group in my project navigator. (The actual files are still in the project's root folder.)

    enter image description here

    Bug fix:

    In SDK 1.6.2 the issue described in the question appears and is solved by @Anbu.Karthik's answer. Simply add #import <UIKit/UIKit.h> to WXApiObject.h. (You can actually replace #import <Foundation/Foundation.h> with it.) If you are using some SDK version after 1.6.2 this may no longer be an issue, so you may want to just complete the other steps before modifying the SDK files.

    Add a Bridging Header

    Note that several of the SDK files are Objective-C header (.h) files. In order to use them in your Swift project, you need to add a Bridging Header file to your project. Add a new file (File > New > File... > iOS > Source > Header File ) and call it YourProjectName-Bridging-Header.h.

    Add the following line to this file.

    #import "WXApi.h"

    In my project this is the only line in my bridging header file because it's the only line you need for the WeChat SDK. (There were some other auto generated lines of code when I created the header file, but I just commented them out because I didn't know what they did. I will come back and edit this answer later if I find out they are useful.)

    See here, here, and here for more help with adding a bridging header.

    There is no need to import any of the WeChat SDK files in your Swift code files now.

    Add the required frameworks and libraries

    Go to the General tab of your project and scroll down to Linked Frameworks and Libraries. Click the plus (+) button to add the following required frameworks and libraries.

    It should now look like this:

    enter image description here

    The CoreTelephony was mentioned in the readme and the libc++ was mentioned in the online SDK installation instructions but not vice versa. I just added them both to be safe. Feel free to leave a comment if either of these is not actually required.

    Add URL Scheme

    Go to the Info tab of your project and expand the URL Types item.

    Add a type where the identifier is weixin and the URL Schemes is the AppID that you should have gotten after you successfully registered your app with WeChat.

    enter image description here

    Edit AppDelegate

    Edit your AppDelegate.swift file to contain the following functions. Be sure to use your AppID rather than the example one. Other than that you can pretty much copy and paste.

    import UIKit

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, WXApiDelegate {

    var window: UIWindow?


    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
        
        // WeChat: replace with your AppID
        WXApi.registerApp("wx68aa08d12b601234")
        
        return true
    }
    
    func application(application: UIApplication, handleOpenURL url: NSURL) -> Bool {
        return WXApi.handleOpenURL(url, delegate: self)
    }
    
    func application(application: UIApplication, openURL url: NSURL, sourceApplication: String?, annotation: AnyObject) -> Bool {
        return WXApi.handleOpenURL(url, delegate: self)
    }
    
    func onReq(req: BaseReq!) {
        // do optional stuff
    }
    
    func onResp(resp: BaseResp!) {
        // do optional stuff
    }

    // ...
    
}

    See the sample demo app for the optional stuff you can do in onReq and onResp. (The current link is here but if that link is broken, then look for the Sample Demo in the official WeChat developer docs.)

    Edit Info.plist

    Right click on Info.plist and choose Open As > Source Code. Then add the following two keys before the final </dict>:

    <key>LSApplicationQueriesSchemes</key>
<array>
    <string>weixin</string>
</array>
<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <true/>
</dict>

    According to the readme included with the SDK, this is necessary because iOS 9 limits http access.

    Use the WeChat API

    At this point you should be able to start using the WeChat API within your Swift code. I may add a couple more API examples later, but the following is a proof of concept.

    Send a text message

    let message = SendMessageToWXReq()
message.text = "Hello WeChat"
message.bText = true
message.scene = Int32(WXSceneSession.rawValue) // WXSceneSession
WXApi.sendReq(message)

    I was not able to use the Objective-C defined enum WXSceneSession, so I just used its integer value. There is probably a better solution, but this works for now.

    This solution above was tested with Xcode 7.2 and iOS 9.2.