Guida rapida

Installazione

Puoi usare il nostro Setup assistito dall'AI per installare il plugin. Aggiungi le skill Capgo al tuo tool AI con il comando seguente:

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

Poi usa questo prompt:

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

Se preferisci il Setup manuale, installa il plugin eseguendo i comandi seguenti e segui le istruzioni specifiche per piattaforma qui sotto:

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

Importa

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

Avvio rapido

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

Esempio: openIOSSettings

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

Esempio: openApplication

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

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

Errori comuni

• Sync nativo: esegui bunx cap sync dopo gli aggiornamenti dei plugin.
• Fonte di verità: fidati src/definitions.ts nel repo GitHub.

API Panoramica

startActivityAsync

Avvia un'activity Android per l'azione specificata.

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

openIOSSettings

Apre la schermata delle impostazioni di iOS.

Nota: l'unica opzione ufficialmente supportata da Apple è App che apre la pagina delle impostazioni della tua app. Altre opzioni potrebbero funzionare, ma non sono garantite e potrebbero rompersi nelle versioni future di iOS o causare il rifiuto da parte dell'App Store.

Nota anche che il simulatore iOS a volte aprirà solo l'app Impostazioni, invece dell'opzione specificata.

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

openApplication

Apre un'applicazione tramite il suo package name.

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

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

getApplicationIconAsync

Ottiene l'icona dell'applicazione come stringa PNG codificata in 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;
}

Riferimento ai tipi

IntentLauncherParams

Opzioni per avviare un'activity.

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

Risultato dell'avvio di un'activity.

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

Opzioni per aprire le impostazioni iOS.

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

IOSSettingsResult

Risultato dell'apertura delle impostazioni iOS.

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

OpenApplicationOptions

Opzioni per l'apertura di un'applicazione.

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

GetApplicationIconOptions

Opzioni per ottenere l'icona di un'app.

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

GetApplicationIconResult

Risultato dell'ottenimento dell'icona di un'app.

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

Codici di risultato restituiti dalle activity.

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

Fonte di verità

Questa pagina è generata dal src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Guida rapida per pianificare dashboard e operazioni API, collegalo a Utilizzo di @capgo/capacitor-intent-launcher per la funzionalità nativa in Using @capgo/capacitor-intent-launcher, API Panoramica per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli implementativi nell'Introduzione, Chiavi API per i dettagli implementativi in API Keys, e Dispositivi per i dettagli implementativi in Dispositivi.