0.0.1 • Published 2 years ago

facebook-app-events v0.0.1

Weekly downloads
-
License
MIT
Repository
gitlab
Last release
2 years ago

Xcapit - facebook app events

Log app events to facebook app plugin for capacitor 3.

Install

# with npm
npm install @xcapit/facebook-app-events

# with yarn
yarn add @xcapit/facebook-app-events

npx cap sync

Android configuration

Add facebook app id to your local.properties file.

FACEBOOK_APP_ID=123465

Get the app id in build.gradle (app level)

...

Properties localProperties = new Properties()
localProperties.load(project.rootProject.file('local.properties').newDataInputStream())

android {
    ...

    buildTypes {
        debug {
            resValue 'string', "FACEBOOK_APP_ID", localProperties['FACEBOOK_APP_ID']
        }
        release {
            ...

            resValue 'string', "FACEBOOK_APP_ID", localProperties['FACEBOOK_APP_ID']
        }
    }
    ...
}

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

<meta-data android:name="com.facebook.sdk.ApplicationId"
           android:value="@string/FACEBOOK_APP_ID"/>

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

import android.os.Bundle;
import com.xcapit.plugins.facebookappevents.FacebookAppEventsPlugin;

public class MainActivity extends BridgeActivity {
    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        ...
        registerPlugin(FacebookAppEventsPlugin.class);
    }
}

API

logEvent(...)

logEvent(options: { event: string; params?: any; }) => Promise<string | void>
ParamType
options{ event: string; params?: any; }

Returns: Promise<string | void>


Supported methods

NameAndroidiOSWeb
logEvent

Usage

Log event

import { FacebookAppEvents } from '@xcapit/facebook-app-events'
FacebookAppEvents.logEvent({ event: 'test event name' });
FacebookAppEvents.logEvent({ event: 'test event with param', params: { name: 'test_param'} });
0.0.1

2 years ago