始めてみる

Install

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

Import

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

API の概要

startActivityAsync

Android アクティビティを起動するために与えられたアクションを開始します。

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

iOS設定画面を開きます。

注意: Appleが公式にサポートしている唯一のオプションは App アプリの設定画面を開きます。 他のオプションは機能するかもしれませんが、将来のiOSバージョンで機能しなくなったり、App Storeの拒否を起こしたりする可能性があります。

iOSシミュレータでは、指定されたオプションではなく、設定アプリを開くことがあります。

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

パッケージ名でアプリを開きます。

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

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

getApplicationIconAsync

アプリのアイコンをbase64エンコードされたPNG形式の文字列として取得します。

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

型式リファレンス

IntentLauncherParams

アクティビティを起動するためのオプション

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

アクティビティを起動した結果

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

iOS設定を開くためのオプション

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

IOSSettingsResult

iOS設定を開いた結果です。

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

OpenApplicationOptions

アプリケーションを開くためのオプションです。

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

GetApplicationIconOptions

アプリケーションアイコンを取得するためのオプションです。

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

GetApplicationIconResult

アプリケーションアイコンを取得した結果です。

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

アクティビティによって返される結果コード。

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

真実の源

このページはプラグインから生成されています。 src/definitions.ts. upstream の公開 API が変更された場合、再度 Sync を実行してください。

Getting Started から続けてください

Capacitor を使用している場合 Getting Started ダッシュボードと API の作業を計画する場合、接続してください Using @capgo/capacitor-intent-launcher for the native capability in Using @capgo/capacitor-intent-launcher API アシェス for the implementation detail in API アシェス アシェストエク for the implementation detail in アシェストエク API カムイン for the implementation detail in API カムイン アシェストエクプログ for the implementation detail in アシェストエクプログ