Skip to content

Latest commit

 

History

History
306 lines (243 loc) · 8.35 KB

README.md

File metadata and controls

306 lines (243 loc) · 8.35 KB
Raw

NBus

CI Status Version License Platform

Introduction

NBus is a sharing and signin library for Chinese Social Application, such as WeChat, QQ and Weibo. NBus also supports system's sharing and Sign in with Apple.

Feature

Share

Handler Text Image Audio Video WebPage File MiniProgram
QQHandler ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
QQSDKHandler ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
WechatHandler ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
WechatSDKHandler ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
WeiboHandler ✔️ ✔️ ✔️ ✔️ ✔️ ❌ ❌
WeiboSDKHandler ✔️ ✔️ ✔️ ✔️ ✔️ ❌ ❌
SystemHandler ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ❌

Oauth

Handler Oauth
QQHandler ✔️
QQSDKHandler ✔️
WechatHandler ✔️
WechatSDKHandler ✔️
WeiboHandler ✔️
WeiboSDKHandler ✔️
SystemHandler ✔️

Launch

Handler MiniProgram
QQHandler ✔️
QQSDKHandler ✔️
WechatHandler ✔️
WechatSDKHandler ✔️
WeiboHandler ❌
WeiboSDKHandler ❌
SystemHandler ❌
  • ✔️ - Support
  • ⭕ - Experimental support
  • ❌ - NOT support

Requirements

Usage

  1. Edit LSApplicationQueriesSchemes in Info.plist.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<array>
    <string>mqq</string>
    <string>mqqopensdkapiV2</string>
    <string>mqqopensdklaunchminiapp</string>
    <string>mqqopensdkminiapp</string>
    <string>mqqopensdknopasteboard</string>
    <string>weixin</string>
    <string>weixinULAPI</string>
    <string>sinaweibo</string>
    <string>weibosdk</string>
    <string>weibosdk3.3</string>
</array>
</plist>
  1. Edit CFBundleURLTypes in Info.plist.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<array>
    <dict>
        <key>CFBundleTypeRole</key>
        <string>Editor</string>
        <key>CFBundleURLName</key>
        <string>QQ</string>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>tencent123456</string>
        </array>
    </dict>
    <dict>
        <key>CFBundleTypeRole</key>
        <string>Editor</string>
        <key>CFBundleURLName</key>
        <string>Wechat</string>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>wx123456</string>
        </array>
    </dict>
    <dict>
        <key>CFBundleTypeRole</key>
        <string>Editor</string>
        <key>CFBundleURLName</key>
        <string>Weibo</string>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>wb123456</string>
        </array>
    </dict>
</array>
</plist>
  1. Edit com.apple.developer.associated-domains in TARGET.entitlements.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<array>
    <string>applinks:www.example.com</string>
</array>
</plist>
  1. Register handler(s) before using NBus.
func application(
    _ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
    let qqHandler = QQHandler(
        appID: "tencent123456",
        universalLink: URL(string: "https://www.example.com/qq_conn/123456/")!
    )

    Bus.shared.handlers = [qqHandler]
}
func application(
    _ app: UIApplication,
    open url: URL,
    options: [UIApplication.OpenURLOptionsKey: Any] = [:]
) -> Bool {
    Bus.shared.openURL(url)
}
func application(
    _ application: UIApplication,
    continue userActivity: NSUserActivity,
    restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void
) -> Bool {
    Bus.shared.openUserActivity(userActivity)
}
  1. Share message using NBus.
let message = Messages.text(text: "NBus")
let endpoint = Endpoints.QQ.friend

Bus.shared.share(message: message, to: endpoint) { result in
    switch result {
    case .success:
        print("Success")
    case let .failure(error):
        print(error)
    }
}
  1. Oauth using NBus.
let platform = Platforms.qq

Bus.shared.oauth(with: platform) { result in
    switch result {
    case let .success(parameters):
        let accessToken = parameters[Bus.OauthInfoKeys.QQ.accessToken]
        let expirationDate = parameters[Bus.OauthInfoKeys.QQ.expirationDate]
        let openID = = parameters[Bus.OauthInfoKeys.QQ.openID]

        print(accessToken, expirationDate, openID)
    case let .failure(error):
        print(error)
    }
}
  1. Launch Mini Program using NBus.
let program = Messages.miniProgram(
    miniProgramID: "123456",
    path: "/example",
    link: URL(string: "https://www.example.com")!,
    miniProgramType: .release,
    title: "NBus",
    description: "NBus",
    thumbnail: UIImage(named: "example")?.jpegData(compressionQuality: 1)
)

let platform = Platforms.qq

Bus.shared.launch(program: program, with: platform) { result in
    switch result {
    case .success:
        print("Success") // Never happen
    case let .failure(error):
        print(error)
    }
}

Example

To run the example project, clone the repo, edit the Example/NBus/Config.xcconfig file, and run bundle install && bundle exec fastlane setup && open Example/NBus.xcworkspace from the Example directory first.

Installation

CocoaPods

You can use NBus directly which is including all SDK bridging handlers.

pod "NBus" # default subspecs "SDKHandlers"

or all open source handlers.

pod "NBus/BusHandlers"

or what you like.

pod "NBus/QQSDKHandler"
pod "NBus/QQHandler"

pod "NBus/WechatSDKHandler"
pod "NBus/WechatHandler"

pod "NBus/WeiboSDKHandler"
pod "NBus/WeiboHandler"

pod "NBus/SystemHandler"

even those SDKs.

pod "NBusQQSDK"

pod "NBusWechatSDK"

pod "NBusWeiboSDK"

WARNING

  1. WeiboSDK.bundle must saved in App's root path.

Author

nuomi1, [email protected]

Related articles

Thanks

License

NBus is available under the MIT license. See the LICENSE file for more info.