Skip to content

Commit

Permalink
Fix Android and add README.
Browse files Browse the repository at this point in the history
  • Loading branch information
SpellChucker committed Jul 25, 2020
1 parent d09c6dc commit 524d5bc
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 4 deletions.
74 changes: 74 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
## Installation

```bash
$ npm i --save capacitor-plugin-facebook-analytics
```

To use yarn

```bash
yarn add capacitor-plugin-facebook-analytics
```

## Android configuration

In file `android/app/src/main/java/**/**/MainActivity.java`, add the plugin to the initialization list:

```diff
this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
[...]
+ add(com.vrba.plugins.facebookanalytics.FacebookAnalytics.class);
[...]
}});
```

In file `android/app/src/main/AndroidManifest.xml`, add the following XML elements under `<manifest><application>` :

```diff
+ <meta-data android:name="com.facebook.sdk.ApplicationId"
+ android:value="@string/facebook_app_id"/>
```

In file `android/app/src/main/res/values/strings.xml` add the following lines :

```diff
+ <string name="facebook_app_id">[APP_ID]</string>
```

Don't forget to replace `[APP_ID]` by your Facebook application Id.

More information can be found here: https://developers.facebook.com/docs/app-events/getting-started-app-events-android

## iOS configuration

Add the following in the `ios/App/App/info.plist` file:

```diff
+ <key>FacebookAppID</key>
+ <string>[APP_ID]</string>
+ <key>FacebookDisplayName</key>
+ <string>[APP_NAME]</string>
```

More information can be found here: https://developers.facebook.com/docs/app-events/getting-started-app-events-ios

## Supported methods

| Name | Android | iOS | Web |
| :-------------------- | :------ | :-- | :-- |
| logEvent ||||

## API

### logEvent

```ts
import { Plugins } from '@capacitor/core';
const { FacebookAnalytics } = Plugins;

// With Params.
await FacebookAnalytics.logEvent({ event: 'some_event', params: { someParam: 'someParam' } });

// Without Params.
await FacebookAnalytics.logEvent({ event: 'some_event' });
```
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
package com.vrba.plugins.facebookanalytics;

import com.getcapacitor.Bridge;
import com.getcapacitor.JSObject;
import com.getcapacitor.NativePlugin;
import com.getcapacitor.Plugin;
Expand All @@ -15,9 +16,13 @@ public class FacebookAnalytics extends Plugin {

@Override
public void load() {
super.load();
if (bridge == null) {
bridge = this.getBridge();
}

logger = AppEventsLogger.newLogger(this.bridge.getActivity());
logger = AppEventsLogger.newLogger(bridge.getActivity().getApplicationContext());

super.load();
}

@PluginMethod
Expand All @@ -27,7 +32,7 @@ public void logEvent(PluginCall call) {
return;
}

String event = call.getString("value");
String event = call.getString("event");
JSObject params = call.getObject("params", new JSObject());

if (params.length() > 0) {
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "capacitor-plugin-facebook-analytics",
"version": "0.0.1",
"version": "0.0.2",
"description": "Provide Facebook analytics functionality to Capacitor-based projects.",
"main": "dist/plugin.js",
"module": "dist/esm/index.js",
Expand Down

0 comments on commit 524d5bc

Please sign in to comment.