An open API service indexing awesome lists of open source software.

https://github.com/Cap-go/capacitor-appinsights

Capacitor plugin to allow interact with App insights SDK
https://github.com/Cap-go/capacitor-appinsights

appinsihgts capacitor ionic plugin

Last synced: about 1 month ago
JSON representation

Capacitor plugin to allow interact with App insights SDK

Awesome Lists containing this project

README

          

# @capgo/capacitor-appinsights
Capgo - Instant updates for capacitor


➡️ Get Instant updates for your App with Capgo


Missing a feature? We’ll build the plugin for you 💪



A wrapper around the https://github.com/apptopia/appinsights SDK

## Why Capacitor AppInsights?

The only Capacitor plugin for integrating the AppInsights SDK:

- **Market intelligence** - Access app store analytics and competitive data
- **User insights** - Track and analyze user behavior across platforms
- **SDK wrapper** - Clean JavaScript API for the native AppInsights SDKs
- **Cross-platform** - Works on iOS and Android

Essential for apps needing market intelligence, competitive analysis, and advanced analytics beyond standard tools.

## Documentation

The most complete doc is available here: https://capgo.app/docs/plugins/appinsights/

## Compatibility

| Plugin version | Capacitor compatibility | Maintained |
| -------------- | ----------------------- | ---------- |
| v8.\*.\* | v8.\*.\* | ✅ |
| v7.\*.\* | v7.\*.\* | On demand |
| v6.\*.\* | v6.\*.\* | ❌ |
| v5.\*.\* | v5.\*.\* | ❌ |

> **Note:** The major version of this plugin follows the major version of Capacitor. Use the version that matches your Capacitor installation (e.g., plugin v8 for Capacitor 8). Only the latest major version is actively maintained.

## Install

```bash
npm install @capgo/capacitor-appinsights
npx cap sync
```

## API

* [`init(...)`](#init)
* [`setUserId(...)`](#setuserid)
* [`getState()`](#getstate)
* [`getPluginVersion()`](#getpluginversion)
* [Interfaces](#interfaces)

### init(...)

```typescript
init(options: { partnerId: string; partnerKey: string; }) => Promise
```

Initialize the AppInsights SDK

| Param | Type | Description |
| ------------- | ------------------------------------------------------- | -------------------------------------------- |
| **`options`** | { partnerId: string; partnerKey: string; } | Configuration options for SDK initialization |

--------------------

### setUserId(...)

```typescript
setUserId(options: { userId: string; }) => Promise
```

Set or update the user ID after initialization

| Param | Type | Description |
| ------------- | -------------------------------- | -------------- |
| **`options`** | { userId: string; } | User ID to set |

--------------------

### getState()

```typescript
getState() => Promise
```

Get the current state of the SDK

**Returns:** Promise<PanelSDKState>

--------------------

### getPluginVersion()

```typescript
getPluginVersion() => Promise<{ version: string; }>
```

Get the native Capacitor plugin version

**Returns:** Promise<{ version: string; }>

--------------------

### Interfaces

#### PanelSDKState

| Prop | Type |
| ------------------------ | -------------------- |
| **`initCompleted`** | boolean |
| **`jobScheduled`** | boolean |
| **`permissionAcquired`** | boolean |