Getting Started

Install

bun add @capgo/capacitor-appinsights
bunx cap sync

Import

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

API Overview

init

Initialize the AppInsights SDK

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

await CapacitorAppInsights.init({} as {
    partnerId: string; // Provided by our business unit
    partnerKey: string; // Provided by our business unit
  });

setUserId

Set or update the user ID after initialization

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

await CapacitorAppInsights.setUserId({} as { userId: string });

getState

Get the current state of the SDK

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

await CapacitorAppInsights.getState();

Type Reference

PanelSDKState

export interface PanelSDKState {
  initCompleted: boolean; // SDK initialization status
  jobScheduled: boolean; // Background job scheduling status
  permissionAcquired: boolean; // Required permissions status
}

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.