メインコンテンツへスキップ
@capgo/capacitor-wechat コミュニケーション オープンソース

WeChat Capacitor プラグイン

WeChat SDK for Capacitor — 認証、シェア、決済、ミニプログラムを可能にします

インストール

bun add @capgo/capacitor-wechat bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-wechat
  • pnpm add @capgo/capacitor-wechat
  • yarn add @capgo/capacitor-wechat

ガイド

Capacitor で WeChat を使用する方法

@capgo/capacitor-wechat の使い方

Capacitor WeChat Plugin - 認証、シェア、決済、ミニプログラム向けの WeChat SDK 統合

インストール

bun add @capgo/capacitor-wechat
bunx cap sync

bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

import { CapacitorWechat } from '@capgo/capacitor-wechat';

API の概要

メソッド 説明
initialize アプリケーションの認証情報を使用して、WeChat SDK を初期化します。
isInstalled デバイスに WeChat アプリがインストールされているか確認します。
auth WeChat OAuth でユーザーを認証します。
share WeChat にコンテンツをシェアします。
sendPaymentRequest WeChat Pay に決済リクエストを送信します。
openMiniProgram WeChat ミニプログラムを開きます。
chooseInvoice WeChat から請求書を選択します。

例

initialize()

アプリケーションの認証情報を使用して、WeChat SDK を初期化します。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

await CapacitorWechat.initialize({
  appId: 'wx1234567890',
  universalLink: 'https://example.com/app/'
});

isInstalled()

デバイスに WeChat アプリがインストールされているか確認します。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

const { installed } = await CapacitorWechat.isInstalled();
if (installed) {
  console.log('WeChat is installed');
}

auth()

WeChat OAuth でユーザーを認証します。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

const { code, state } = await CapacitorWechat.auth({
  scope: 'snsapi_userinfo',
  state: 'my_state'
});
// Use code to get access token from your server

share()

WeChat にコンテンツをシェアします。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

// Share text
await CapacitorWechat.share({
  scene: 0, // 0 = Session, 1 = Timeline, 2 = Favorite
  type: 'text',
  text: 'Hello WeChat!'
});

// Share link
await CapacitorWechat.share({
  scene: 1,
  type: 'link',
  title: 'My Website',
  description: 'Check out my website',
  link: 'https://example.com',
  imageUrl: 'https://example.com/image.jpg'
});

sendPaymentRequest()

WeChat Pay に決済リクエストを送信します。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

// Get payment params from your server first
const paymentParams = await fetchPaymentParamsFromServer();

await CapacitorWechat.sendPaymentRequest({
  partnerId: paymentParams.partnerId,
  prepayId: paymentParams.prepayId,
  nonceStr: paymentParams.nonceStr,
  timeStamp: paymentParams.timeStamp,
  package: paymentParams.package,
  sign: paymentParams.sign
});

openMiniProgram()

WeChat ミニプログラムを開きます。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

const { extMsg } = await CapacitorWechat.openMiniProgram({
  username: 'gh_xxxxxxxxxxxxx',
  path: 'pages/index/index',
  type: 0 // 0 = Release, 1 = Test, 2 = Preview
});

上記の表には7つのコアメソッドが記載されています。Listenerやversionヘルパー、および各メソッドの完全な仕様については、 GitHub リポジトリ.

完全なリファレンス

@capgo/capacitor-wechat の使用方法から続けてください

使用している場合 @capgo/capacitor-wechat の使い方 認証とアカウントフローを計画するには、これを次と連携させてください @capgo/capacitor-wechat @capgo/capacitor-wechat の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 @capgo/capacitor-social-login @capgo/capacitor-social-login の実装の詳細については、 @capgo/capacitor-passkey @capgo/capacitor-passkey の実装詳細については、 @capgo/capacitor-native-biometric @capgo/capacitor-native-biometric. の実装詳細についてはこちら

よくある質問

WeChat plugin よくある質問

Capacitor アプリに WeChat plugin をインストールするには?

"bun add @capgo/capacitor-wechat"(または "npm install @capgo/capacitor-wechat")を実行し、その後 "bunx cap sync" を実行して、iOS および Android プロジェクトにネイティブの code を反映させます。アプリの code から "@capgo/capacitor-wechat" をインポートしてください。

@capgo/capacitor-wechat は React、Vue、Angular で動作しますか?

はい。WeChat は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、素の JavaScript など、Capacitor 内で動作するあらゆる Web フレームワークで使えます。

@capgo/capacitor-wechat はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-wechat は無料でオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capacitor-wechat/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストをお待ちしています。

App Store の審査なしで、WeChat を使用している code をアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずにWeChatの変更を配信

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める