Aller au contenu

Prise en main

GitHub

Vous pouvez utiliser notre configuration assistée par IA pour installer le plugin. Ajoutez les skills Capgo à votre outil d'IA avec la commande suivante :

Fenêtre de terminal
bunx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Utilisez ensuite le prompt suivant :

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 une installation manuelle, installez le plugin en exécutant les commandes suivantes et suivez les instructions spécifiques à chaque plateforme ci-dessous :

Fenêtre de terminal
bun add @capgo/capacitor-intent-launcher
bunx cap sync
import { IntentLauncher } from '@capgo/capacitor-intent-launcher';
import { IntentLauncher, ActivityAction } 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'
});
import { IntentLauncher, IOSSettings } 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 });
import { IntentLauncher } from '@capgo/capacitor-intent-launcher';
// Open Gmail app
await IntentLauncher.openApplication({ packageName: 'com.google.android.gm' });
  • Sync native : exécuter bunx cap sync après les mises à jour du plugin.
  • Source de vérité : fiez-vous src/definitions.ts au repo GitHub.

Lance une activité Android pour l'action donnée.

import { IntentLauncher, ActivityAction } 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'
});

Ouvre l'écran des réglages iOS.

Remarque : la seule 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 rien n’est garanti et elles pourraient cesser de fonctionner dans de futures versions d’iOS ou entraîner un rejet par l’App Store.

Notez également que le simulateur iOS n’ouvre parfois que l’application Réglages, au lieu de l’option spécifiée.

import { IntentLauncher, IOSSettings } 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 });

Ouvre une application à partir de son nom de package.

import { IntentLauncher } from '@capgo/capacitor-intent-launcher';
// Open Gmail app
await IntentLauncher.openApplication({ packageName: 'com.google.android.gm' });

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

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

Options pour démarrer 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;
}

Résultat du démarrage 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>;
}

Options pour ouvrir les réglages iOS.

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

Résultat de l'ouverture des réglages iOS.

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

Options pour ouvrir une application.

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

Options pour obtenir l’icône d’une application.

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

Résultat de l’obtention de l’icône d’une 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;
}

Codes de résultat renvoyé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,
}

Cette page est générée à partir de src/definitions.ts. Relancez la synchronisation lorsque l’API public change en amont.

Si vous utilisez Prise en main pour planifier les opérations du dashboard et de API, connectez-l’avec Utilisation de @capgo/capacitor-intent-launcher pour la capacité native dans « Utilisation de @capgo/capacitor-intent-launcher », Aperçu de API pour les détails d'implémentation dans « Vue d'ensemble de API », Introduction pour les détails d'implémentation dans l'introduction, Clés API pour les détails d'implémentation dans « Clés API », et Appareils pour les détails d'implémentation dans Devices.