Démarrage

Installer

Vous pouvez utiliser notre configuration assistée par l'IA pour installer le plugin. Ajoutez les Capgo compétences à votre outil IA en utilisant la commande suivante :

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

Ensuite, utilisez la prompt suivante :

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

Si vous préférez la configuration manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques au plateforme ci-dessous :

bun add @capgo/capacitor-intent-launcher
bunx cap sync

Importer

import { IntentLauncher } from '@capgo/capacitor-intent-launcher';

API Vue d'ensemble

startActivityAsync

Démarre une activité Android pour l'action spécifiée.

import { IntentLauncher } from '@capgo/capacitor-intent-launcher';

// Open location settings
const result = await IntentLauncher.startActivityAsync({
  action: ActivityAction.LOCATION_SOURCE_SETTINGS
});

// Open a specific app settings
const result = await IntentLauncher.startActivityAsync({
  action: ActivityAction.APPLICATION_DETAILS_SETTINGS,
  data: 'package:com.example.app'
});

openIOSSettings

Ouvre l'écran de paramètres iOS.

Note : L'option officiellement prise en charge par Apple est App qui ouvre la page de paramètres de votre application. D'autres options peuvent fonctionner mais ne sont pas garanties et pourraient ne pas fonctionner dans les futures versions d'iOS ou entraîner un refus de l'App Store.

Notez également que le simulateur d'iOS ouvrira parfois uniquement l'application Paramètres, au lieu de l'option spécifiée.

import { IntentLauncher } from '@capgo/capacitor-intent-launcher';

// Open app settings (recommended - officially supported by Apple)
await IntentLauncher.openIOSSettings({ option: IOSSettings.App });

// Open WiFi settings (may not work in all iOS versions)
await IntentLauncher.openIOSSettings({ option: IOSSettings.WiFi });

openApplication

Ouvre une application en fonction de son nom de package.

import { IntentLauncher } from '@capgo/capacitor-intent-launcher';

// Open Gmail app
await IntentLauncher.openApplication({ packageName: 'com.google.android.gm' });

getApplicationIconAsync

Récupère l'icône de l'application sous forme de chaîne de base64 PNG encodée.

import { IntentLauncher } from '@capgo/capacitor-intent-launcher';

const { icon } = await IntentLauncher.getApplicationIconAsync({
  packageName: 'com.google.android.gm'
});
if (icon) {
  const img = document.createElement('img');
  img.src = icon;
}

Référence de type

IntentLauncherParams

Options pour lancer une activité.

export interface IntentLauncherParams {
  /**
   * The action to perform. Use values from `ActivityAction` enum.
   *
   * @since 1.0.0
   */
  action: string;

  /**
   * Optional category to add to the intent.
   *
   * @since 1.0.0
   */
  category?: string;

  /**
   * Optional class name for the component to launch.
   *
   * @since 1.0.0
   */
  className?: string;

  /**
   * Optional URI data for the intent. Must be a valid URI.
   *
   * @since 1.0.0
   */
  data?: string;

  /**
   * Optional extra data to pass to the intent as key-value pairs.
   *
   * @since 1.0.0
   */
  extra?: Record<string, unknown>;

  /**
   * Optional intent flags as a bitmask.
   *
   * @since 1.0.0
   */
  flags?: number;

  /**
   * Optional package name for the component.
   *
   * @since 1.0.0
   */
  packageName?: string;

  /**
   * Optional MIME type for the intent data.
   *
   * @since 1.0.0
   */
  type?: string;
}

IntentLauncherResult

Résultat de lancement d'une activité.

export interface IntentLauncherResult {
  /**
   * The result code returned by the activity.
   *
   * @since 1.0.0
   */
  resultCode: ResultCode;

  /**
   * Optional data URI returned by the activity.
   *
   * @since 1.0.0
   */
  data?: string;

  /**
   * Optional extra data returned by the activity.
   *
   * @since 1.0.0
   */
  extra?: Record<string, unknown>;
}

IOSSettingsParams

Options pour ouvrir les paramètres iOS.

export interface IOSSettingsParams {
  /**
   * The iOS settings screen to open. Use values from `IOSSettings` enum.
   *
   * @since 8.2.0
   */
  option: string;
}

IOSSettingsResult

Résultat de l'ouverture des paramètres iOS.

export interface IOSSettingsResult {
  /**
   * Whether the settings screen was successfully opened.
   *
   * @since 8.2.0
   */
  success: boolean;
}

OpenApplicationOptions

Options pour ouvrir une application.

export interface OpenApplicationOptions {
  /**
   * The package name of the application to open.
   *
   * @since 1.0.0
   */
  packageName: string;
}

GetApplicationIconOptions

Options pour récupérer l’icône d’une application.

export interface GetApplicationIconOptions {
  /**
   * The package name of the application.
   *
   * @since 1.0.0
   */
  packageName: string;
}

GetApplicationIconResult

Résultat de la récupération d’une icône d’application.

export interface GetApplicationIconResult {
  /**
   * The application icon as a base64-encoded PNG string prefixed with 'data:image/.png;base64,'.
   * Empty string if the icon is not available.
   *
   * @since 1.0.0
   */
  icon: string;
}

ResultCode

Codes de résultat retournés par les activités.

export enum ResultCode {
  /**
   * The activity completed successfully.
   */
  Success = -1,

  /**
   * The activity was canceled by the user.
   */
  Canceled = 0,

  /**
   * First custom user-defined result code.
   */
  FirstUser = 1,
}

Source Of Truth

Cette page est générée à partir du plugin’s src/definitions.tsRe-run the sync when the public API changes upstream.

Continuez de Getting Started

Si vous utilisez Getting Started pour planifier le tableau de bord et les opérations API, connectez-le avec Utilisez @capgo/capacitor-intent-launcher pour la capacité native dans Utilisez @capgo/capacitor-intent-launcher, API Overview pour les détails d'implémentation dans API Vue d'ensemble Introduction pour les détails d'implémentation dans Introduction API Clés pour les détails d'implémentation dans API Clés, et Appareils pour les détails d'implémentation dans Appareils.