Iniziare

Installa

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Poi utilizza il seguente prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-wechat` plugin in my project.

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche del tuo sistema operativo riportate di seguito:

bun add @capgo/capacitor-wechat
bunx cap sync

Importa

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

API Panoramica

initialize

Inizia il tuo SDK WeChat con le tue credenziali di applicazione.

Puoi anche impostare questi valori in capacitor.config.ts Sotto la CapacitorWechat La configurazione del plugin. Chiamare questo metodo sovrascrive qualsiasi configurazione integrata in esecuzione.

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

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

isInstalled

Controlla se l'app WeChat è installata sul dispositivo.

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

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

auth

Autentica l'utente con OAuth WeChat.

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

Condividi contenuto su 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

Inviare richiesta di pagamento a 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

Apre il mini-programma di 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
});

chooseInvoice

Scegliere fattura da WeChat.

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

Tipo di Riferimento

WechatInitializationOptions

Opzioni di inizializzazione di WeChat.

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

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

WechatAuthOptions

Opzioni di autenticazione di WeChat.

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

Risposta di autenticazione di WeChat.

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

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

WechatShareOptions

Opzioni di condivisione di WeChat.

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

Opzioni di pagamento WeChat.

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

Opzioni del programma mini WeChat.

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

Opzioni della fattura WeChat.

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

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

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

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

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

WechatInvoiceResponse

Risposta della fattura WeChat.

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

WechatInvoiceCard

Elemento della carta di fattura WeChat.

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

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

Fonte di verità

Questa pagina è generata dal plugin’s src/definitions.tsRiavvia la sincronizzazione quando il pubblico API cambia in modo upstream.

Continua da qui: Inizia

Se stai utilizzando Inizia per pianificare dashboard e API operazioni, connettilo con Utilizza @capgo/capacitor-wechat per la capacità nativa in Utilizzo di @capgo/capacitor-wechat, API Panoramica per il dettaglio di implementazione in API Panoramica, Introduzione per il dettaglio di implementazione in Introduzione, API Chiavi per il dettaglio di implementazione in API Chiavi, e Dispositivi per il dettaglio di implementazione in Dispositivi.