npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@capacitor-community/uxcam

v0.0.3

Published

Capacitor plugin for UXCam and FullStory analytics. It uses UXCam for Android and iOS platforms and FullStory for Web/PWA.

Downloads

7

Readme

Maintainers

| Maintainer | GitHub | Social | | ------------ | -------------------------------------------- | ------ | | Luis Alaguna | SalahAdDin | |

Installation

Install the package from the repository(by now):

# npm install @capacitor-community/uxcam
npm install SalahAdDin/capacitor-uxcam#dist
ionic cap update && ionic cap copy && ionic cap sync 

On iOS, no further steps are needed.

On Android:

  • Add the UXCam maven repository to your projects build's graddle script:

    maven {
    	url 'https://sdk.uxcam.com/android/'
    }
  • Register the plugin in your main activity:

import com.getcapacitor.community.uxcam.UXCamPlugin;

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

    // Initializes the Bridge
    this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
      // Additional plugins you've installed go here
      // Ex: add(TotallyAwesomePlugin.class);
      add(UXCamPlugin.class);
    }});
  }
}

Configuration

No configuration is required for this plugin.

Supported methods

The following are the UXCam implemented methogs on the plugin, for web plugin, FullStory methods are used:

| Name | Android | iOS | Web | | :---------------------------- | :------ | :--- | :--- | | startWithKey | ✅ | ✅ | ❌ | | setUserIdentity | ✅ | ✅ | ✅ | | setUserProperty | ✅ | ✅ | ✅ | | setMultiSessionRecord | ✅ | ✅ | ❌ | | getEnabledMultiSessionRecord | ✅ | ✅ | ❌ | | logEvent | ✅ | ✅ | ✅ | | tagScreenName | ✅ | ✅ | ❌ | | setAutomaticScreenNameTagging | ✅ | ✅ | ❌ | | stopSession | ✅ | ✅ | ✅ |

You can find the full list of UXCam methods here and FullStory methods here.

Usage

// Must import the package once to make sure the web support initializes
import "@capacitor-community/uxcam"
import { Plugins } from "@capacitor/core"
import { LogEventProperty, UserProperty } from "@capacitor-community/uxcam"

const { UXCamPlugin } = Plugins

/**
 * Platform: Web/Android/iOS
 * Logs and event.
 * @param eventName: String - Event's name.
 * @param properties?: { [key: string]: string | number } - a optional set of event's properties to include in the log.
 * @returns void
 * https://help.uxcam.com/hc/en-us/articles/115000969072-Send-Events-and-Properties
 */
UXCamPlugin.logEvent(options: LogEventProperty)

/**
 * Platform: Android/iOS
 * Start the UXCam service with the API key.
 * @param UXCamKey: String - UXCam's API key.
 * @returns void
 * https://help.uxcam.com/hc/en-us/articles/115001868272
 */
UXCamPlugin.startWithKey(options: { UXCamKey: string })

/**
 * Platform: Web/Android/iOS
 * Set the user's identifier(a name)
 * @param userIdentity: String - User's identifier.
 * @returns void
 * https://help.uxcam.com/hc/en-us/articles/115000968992-Send-Additional-User-Information
 */
UXCamPlugin.setUserIdentity(options: { userIdentity: string })

/**
 * Platform: Web/Android/iOS
 * Set the user's properties.
 * @param properties: { [key: string]: string | number } - a set of user's properties(as email, phone, age, etc.).
 * @returns void
 * https://help.uxcam.com/hc/en-us/articles/115000968992-Send-Additional-User-Information
 */
UXCamPlugin.setUserProperty(options: UserProperty)

/**
 * Platform: Android/iOS
 * Enables/disables the multisession record for users.
 * @param recordMultipleSessions: boolean - whether enables multi-session record per user or not.
 * @returns void
 * https://help.uxcam.com/hc/en-us/articles/115000968972-Control-Recording
 */
UXCamPlugin.setMultiSessionRecord(options: { recordMultipleSessions: boolean })

/**
 * Platform: Android/iOS
 * Get the multisession record status.
 * @param
 * @returns Promise<{ value: boolean }> - whether multi-session record per user is enabled or not.
 * https://help.uxcam.com/hc/en-us/articles/115000968972-Control-Recording
 */
UXCamPlugin.getEnabledMultiSessionRecord()

/**
 * Platform: Android/iOS
 * Set the name for a screen view in the application, it requires to dissable the automatic screen name tagging.
 * @param screenName: String - Screen view's name.
 * @returns void
 * https://help.uxcam.com/hc/en-us/articles/360043007412-Tag-Screen-Name
 */
UXCamPlugin.tagScreenName(options: { screenName: string })

/**
 * Platform: Android/iOS
 * Enables/disables the automatic screen name tagging.
 * @param recordMultipleSessions: boolean - whether enables automatic screen name tagging or not.
 * @returns void
 * https://help.uxcam.com/hc/en-us/articles/360043007412-Tag-Screen-Name
 */
UXCamPlugin.setAutomaticScreenNameTagging(options: { enable: boolean }): Promise<void>;

/**
 * Platform: Web/Android/iOS
 * Stops the session record.
 * @param 
 * @returns void
 * https://help.uxcam.com/hc/en-us/articles/115000968972-Control-Recording
 */
UXCamPlugin.stopSession(): Promise<void>

Further info