Memulai

1. Instal paket

   npm

   npm i @capgo/capacitor-appinsights

   pnpm

   pnpm add @capgo/capacitor-appinsights

   yarn

   yarn add @capgo/capacitor-appinsights

   bun

   bun add @capgo/capacitor-appinsights

2. Sinkronkan dengan proyek native

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

Penggunaan

Impor plugin dan inisialisasi dengan kredensial AppInsights Anda:

import { CapacitorAppinsights } from '@capgo/capacitor-appinsights';

// Initialize the SDK
const initializeAnalytics = async () => {
  await CapacitorAppinsights.init({
    partnerId: 'your-partner-id',
    partnerKey: 'your-partner-key'
  });
};

// Set user ID for tracking
const setUser = async (userId: string) => {
  await CapacitorAppinsights.setUserId({ userId });
};

// Get SDK state
const checkSDKState = async () => {
  const state = await CapacitorAppinsights.getState();
  console.log('SDK State:', state);
};

// Get plugin version
const checkVersion = async () => {
  const { version } = await CapacitorAppinsights.getPluginVersion();
  console.log('Plugin version:', version);
};

Referensi API

init(options)

Inisialisasi AppInsights SDK dengan kredensial Anda.

await CapacitorAppinsights.init({
  partnerId: 'your-partner-id',
  partnerKey: 'your-partner-key'
});

Parameter:

• partnerId (string): ID partner AppInsights Anda
• partnerKey (string): Kunci partner AppInsights Anda

setUserId(options)

Atur atau perbarui ID pengguna setelah inisialisasi.

await CapacitorAppinsights.setUserId({
  userId: 'user-123'
});

Parameter:

• userId (string): ID pengguna yang akan diatur untuk pelacakan

getState()

Dapatkan status SDK saat ini.

const state = await CapacitorAppinsights.getState();
console.log(state);
// {
//   initCompleted: true,
//   jobScheduled: true,
//   permissionAcquired: true
// }

Mengembalikan:

• initCompleted (boolean): Apakah inisialisasi SDK selesai
• jobScheduled (boolean): Apakah pekerjaan pengumpulan data dijadwalkan
• permissionAcquired (boolean): Apakah izin yang diperlukan diperoleh

getPluginVersion()

Dapatkan versi plugin Capacitor native.

const { version } = await CapacitorAppinsights.getPluginVersion();
console.log('Version:', version);

Contoh Lengkap

import { CapacitorAppinsights } from '@capgo/capacitor-appinsights';

export class AnalyticsService {
  private initialized = false;

  async initialize(partnerId: string, partnerKey: string) {
    try {
      await CapacitorAppinsights.init({
        partnerId,
        partnerKey
      });

      const state = await CapacitorAppinsights.getState();
      this.initialized = state.initCompleted;

      console.log('AppInsights initialized:', state);
    } catch (error) {
      console.error('Failed to initialize AppInsights:', error);
    }
  }

  async identifyUser(userId: string) {
    if (!this.initialized) {
      throw new Error('AppInsights not initialized');
    }

    await CapacitorAppinsights.setUserId({ userId });
    console.log('User identified:', userId);
  }

  async getSDKStatus() {
    const state = await CapacitorAppinsights.getState();
    return {
      ready: state.initCompleted && state.permissionAcquired,
      tracking: state.jobScheduled,
      state
    };
  }
}

Praktik Terbaik

1. Inisialisasi lebih awal Inisialisasi SDK segera setelah aplikasi Anda dimulai untuk memastikan pelacakan yang akurat:

   // In your app initialization
   await CapacitorAppinsights.init({
     partnerId: process.env.APPINSIGHTS_PARTNER_ID,
     partnerKey: process.env.APPINSIGHTS_PARTNER_KEY
   });

2. Atur ID pengguna saat login Identifikasi pengguna setelah otentikasi:

   async function onUserLogin(user) {
     await CapacitorAppinsights.setUserId({
       userId: user.id
     });
   }

3. Periksa status SDK Verifikasi SDK siap sebelum operasi kritis:

   const state = await CapacitorAppinsights.getState();
   if (!state.initCompleted) {
     console.warn('AppInsights not ready');
   }

4. Tangani error dengan baik

   try {
     await CapacitorAppinsights.init(config);
   } catch (error) {
     console.error('Analytics initialization failed:', error);
     // Continue app operation even if analytics fails
   }

Catatan Platform

iOS

• Memerlukan iOS 10.0+
• Pastikan Anda memiliki izin yang diperlukan di Info.plist untuk pelacakan

Android

• Memerlukan Android 5.0 (API 21)+
• Mungkin memerlukan izin statistik penggunaan tergantung pada fitur pelacakan

Web

• Tidak didukung di platform web