开始使用

安装

bun add @capgo/capacitor-wechat
bunx cap sync

导入

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

API概述

initialize

使用您的应用凭证初始化微信 SDK。

您还可以在这里设置这些值 capacitor.config.ts 在插件配置中 CapacitorWechat 在运行时覆盖任何捆绑的配置。

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

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

isInstalled

检查设备上是否安装了微信应用。

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

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

auth

使用微信 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

将内容分享到微信。

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

向微信支付发送支付请求。

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

打开微信小程序。

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
});

chooseInvoice

从微信中选择发票。

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

const { cards } = await CapacitorWechat.chooseInvoice({
  appId: 'your_app_id',
  signType: 'SHA1',
  cardSign: 'signature',
  timeStamp: '1234567890',
  nonceStr: 'random_string'
});
console.log('Selected cards:', cards);

类型参考

WechatInitializationOptions

微信初始化选项。

export interface WechatInitializationOptions {
  /**
   * Required WeChat application ID.
   */
  appId: string;

  /**
   * iOS universal link that is associated with your WeChat application.
   */
  universalLink?: string;
}

WechatAuthOptions

微信认证选项。

export interface WechatAuthOptions {
  /**
   * OAuth scope. Use 'snsapi_userinfo' for user info or 'snsapi_login' for login only.
   */
  scope: string;

  /**
   * Optional state parameter for CSRF protection.
   */
  state?: string;
}

WechatAuthResponse

微信认证响应。

export interface WechatAuthResponse {
  /**
   * Authorization code to exchange for access token.
   */
  code: string;

  /**
   * State parameter if provided in request.
   */
  state?: string;
}

WechatShareOptions

微信分享选项。

export interface WechatShareOptions {
  /**
   * Share scene: 0 = Session (chat), 1 = Timeline (moments), 2 = Favorite.
   */
  scene: number;

  /**
   * Share type: 'text', 'image', 'link', 'music', 'video', 'miniprogram'.
   */
  type: 'text' | 'image' | 'link' | 'music' | 'video' | 'miniprogram';

  /**
   * Text content (for type 'text').
   */
  text?: string;

  /**
   * Title (for type 'link', 'music', 'video', 'miniprogram').
   */
  title?: string;

  /**
   * Description (for type 'link', 'music', 'video', 'miniprogram').
   */
  description?: string;

  /**
   * Link URL (for type 'link').
   */
  link?: string;

  /**
   * Image URL or base64 data.
   */
  imageUrl?: string;

  /**
   * Thumbnail URL or base64 data (for type 'link', 'music', 'video').
   */
  thumbUrl?: string;

  /**
   * Music or video URL (for type 'music', 'video').
   */
  mediaUrl?: string;

  /**
   * Mini-program username (for type 'miniprogram').
   */
  miniProgramUsername?: string;

  /**
   * Mini-program path (for type 'miniprogram').
   */
  miniProgramPath?: string;

  /**
   * Mini-program type: 0 = Release, 1 = Test, 2 = Preview (for type 'miniprogram').
   */
  miniProgramType?: number;

  /**
   * Mini-program web page URL fallback (for type 'miniprogram').
   */
  miniProgramWebPageUrl?: string;
}

WechatPaymentOptions

微信支付选项。

export interface WechatPaymentOptions {
  /**
   * Partner ID (merchant ID).
   */
  partnerId: string;

  /**
   * Prepay ID from unified order API.
   */
  prepayId: string;

  /**
   * Random string.
   */
  nonceStr: string;

  /**
   * Timestamp.
   */
  timeStamp: string;

  /**
   * Package value, typically 'Sign=WXPay'.
   */
  package: string;

  /**
   * Signature.
   */
  sign: string;
}

WechatMiniProgramOptions

微信小程序选项。

export interface WechatMiniProgramOptions {
  /**
   * Mini-program username (original ID).
   */
  username: string;

  /**
   * Path to open in mini-program.
   */
  path?: string;

  /**
   * Mini-program type: 0 = Release, 1 = Test, 2 = Preview.
   */
  type?: number;
}

WechatInvoiceOptions

微信发票选项。

export interface WechatInvoiceOptions {
  /**
   * App ID.
   */
  appId: string;

  /**
   * Signature type.
   */
  signType: string;

  /**
   * Card signature.
   */
  cardSign: string;

  /**
   * Timestamp.
   */
  timeStamp: string;

  /**
   * Random string.
   */
  nonceStr: string;
}

WechatInvoiceResponse

微信发票响应。

export interface WechatInvoiceResponse {
  /**
   * Array of selected card IDs.
   */
  cards: WechatInvoiceCard[];
}

WechatInvoiceCard

微信发票卡片项。

export interface WechatInvoiceCard {
  /**
   * The selected card identifier.
   */
  cardId: string;

  /**
   * Encrypted code returned by WeChat.
   */
  encryptCode?: string;
}

真实数据来源

本页面由插件生成。 src/definitions.ts当公共API上游发生变化时，请重新运行同步。