Getting Started

Instalasi

Anda dapat menggunakan Pengaturan Bantuan AI kami untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

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

Lalu gunakan prompt berikut:

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

Jika Anda lebih suka Pengaturan Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

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

Impor

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

API Ringkasan

startActivityAsync

Mengaktifkan aktivitas Android untuk aksi yang diberikan.

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

Membuka layar pengaturan iOS.

Catatan: Hanya opsi yang didukung secara resmi oleh Apple adalah App yang membuka halaman pengaturan aplikasi Anda. Opsi lain mungkin berfungsi tetapi tidak dijamin dan mungkin akan gagal di versi iOS masa depan atau menyebabkan penolakan App Store.

Perlu diingat bahwa Simulator iOS akan terkadang hanya membuka aplikasi Pengaturan, sebaliknya dari opsi yang ditentukan.

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

Membuka aplikasi dengan nama paketnya.

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

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

getApplicationIconAsync

Mengambil ikon aplikasi sebagai string PNG 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;
}

Referensi Tipe

IntentLauncherParams

Pilihan untuk memulai suatu kegiatan.

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

Hasil dari memulai suatu kegiatan.

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

Pilihan untuk membuka pengaturan iOS.

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

IOSSettingsResult

Hasil dari membuka pengaturan iOS.

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

OpenApplicationOptions

Opsi untuk membuka aplikasi.

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

GetApplicationIconOptions

Opsi untuk mendapatkan ikon aplikasi.

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

GetApplicationIconResult

Hasil dari mendapatkan ikon aplikasi.

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

Kode hasil yang dikembalikan oleh aktivitas.

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

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s src/definitions.ts. Jalankan ulang sinkronisasi ketika publik API berubah di atas

Teruskan dari Getting Started

Jika Anda menggunakan Getting Started untuk merencanakan dashboard dan API operasi, hubungkannya dengan Menggunakan @capgo/capacitor-intent-launcher untuk kemampuan asli dalam Menggunakan @capgo/capacitor-intent-launcher, API Ringkasan untuk detail implementasi di API Ringkasan, Pendahuluan untuk detail implementasi di Pendahuluan, API Kunci untuk detail implementasi di API Kunci, dan Perangkat untuk detail implementasi di Perangkat.