{"_id":"@capacitor-community/uxcam","_rev":"36-2c18521c852be5e006a322e52fa7f7a7","name":"@capacitor-community/uxcam","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.3":{"name":"@capacitor-community/uxcam","version":"0.0.3","keywords":["capacitor","plugin","native"],"author":{"name":"CloudNesil"},"license":"MIT","_id":"@capacitor-community/uxcam@0.0.3","maintainers":[{"name":"diachedelic","email":"james@diacono.com.au"},{"name":"robingenz","email":"mail@robingenz.de"},{"name":"thomasvidas","email":"hello@thomasvidas.com"},{"name":"epicshaggy","email":"epicshaggy@gmail.com"},{"name":"pwespi","email":"pwespi@pm.me"},{"name":"maxlynch","email":"max@ionic.io"},{"name":"mhartington","email":"mikehartington@gmail.com"},{"name":"dotnetkow","email":"matt.netkow@gmail.com"},{"name":"it_mike_s","email":"mike.summerfeldt@gmail.com"},{"name":"byrds","email":"info@byrds.ch"},{"name":"rdlabo","email":"sakakibara@rdlabo.jp"},{"name":"priyankpatel","email":"priyank.patel@stackspace.ca"},{"name":"dwieeb","email":"dwieeb@gmail.com"},{"name":"stewan","email":"oi@stewan.io"},{"name":"arielhernandezmusa","email":"arielhernandezmusa@gmail.com"},{"name":"jeepq","email":"jeanpierre.queau@gmail.com"},{"name":"start9keagan","email":"keagan@start9labs.com"},{"name":"boosten","email":"kevinboosten@gmail.com"},{"name":"nklayman","email":"noahklayman@gmail.com"},{"name":"ihadeed","email":"ibby@zyra.ca"},{"name":"danielprr","email":"daniel.prr.azevedo@gmail.com"},{"name":"ckgaparajita","email":"aparajita@aparajita.com"},{"name":"jpender","email":"joey@ionic.io"},{"name":"nhyatt","email":"nick@ionic.io"}],"homepage":"https://github.com/SalahAdDin/capacitor-uxcam#readme","bugs":{"url":"https://github.com/SalahAdDin/capacitor-uxcam.git/issues"},"dist":{"shasum":"736e38953cb81b50a6631de19979ba8ad9ae5fc5","tarball":"https://registry.npmjs.org/@capacitor-community/uxcam/-/uxcam-0.0.3.tgz","fileCount":41,"integrity":"sha512-4hVtTHss1JT95t6iPJQzg/A6wFxRBb3GGTSbU8oqu6+OCFGq3vq4zwKgKHaDPNZLyzYrYEonSu5+Rz+NBeqL4g==","signatures":[{"sig":"MEYCIQDDFde9QUEt7YwzpeN0LyVMxOB+Mborh2y3dAYU5Am94wIhAMcm61uqeiV3vnTcgASJqxPIy+t7/YyRH94Yjp7GWMQe","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":130242,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh2CMQCRA9TVsSAnZWagAA5eQP/jIukPt/IPqxwBHVYPEx\nFfFyskxMVBUdPWtkJR+02dfP5c6MW9Rcb1UYPvw8DUDeOKv/f0KMuDRZjOgX\nwzoXA+7ZGxrFg4RFKyAwWUkOgKngTp6gLtfMzGeOH8gnZ4vyPatEYTY3Stbz\ndh3r4dSHFTgeuSjQsbVEZhw1OMsmKC4o5LZpoEB0Biaigy7ctpYcZ2VVhYKx\nmNP5QO4GqTpoL9GGPZCAHw1lf5u99aCzKm6INiiJOfB4OFlajxaVkBx893gZ\nIHeaR2tUPbtxOgPTxQ05w6mSaK9mY28KiUkE7bU9UOYdLHormtT8Upwrvix2\niIMftzCugfJYHRkyNh+z34wzY+2Z3MAO2x8jGBOWIMbyyuaUwcphfK4Xvidl\n3JPtoLHRBAm7lGjJL55KVwb9AMnbAJbE2fmH0fDtL7wOagfEFphFdsNLxS1O\nnd8OmjDTjVvRu8zb2BQGzRyRHu1CG8LPbPz7nRR+ohNuMZd08G1qrSz8995x\n2LUycwljum1DQxRaMFiPhTpQTOCz6WfRp7GKeDvu31leMYaTJPqQUWh4Qxo/\nwLg7znAKSoSVMojX2mDAiiWUkt4LMuxMU1tEjopUGLM/WOTQL5S0s5MARJLu\nBWkngzugHYIofNxx+HAgLl6J3fEKaQ44loJ2qjxvQUcZy7nw7fmEIr3GW/4F\nhafK\r\n=3chl\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/plugin.js","types":"dist/esm/index.d.ts","module":"dist/esm/index.js","gitHead":"7f200bef493c71a9606b8e0fe6082d0ee88e75c8","scripts":{"lint":"npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","prepublishOnly":"npm run build"},"_npmUser":{"name":"dwieeb","email":"dwieeb@gmail.com"},"prettier":"@ionic/prettier-config","capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/SalahAdDin/capacitor-uxcam.git","type":"git"},"_npmVersion":"6.14.11","description":"Capacitor plugin for UXCam and FullStory analytics. It uses UXCam for Android and iOS platforms and FullStory for Web/PWA.","directories":{},"_nodeVersion":"15.3.0","_hasShrinkwrap":false,"devDependencies":{"rimraf":"^3.0.0","rollup":"^2.21.0","prettier":"^2.0.5","swiftlint":"^1.0.1","typescript":"~3.8.3","@capacitor/ios":"^2.4.6","@capacitor/core":"^2.4.6","@capacitor/android":"^2.4.6","prettier-plugin-java":"^0.8.0","@ionic/prettier-config":"^1.0.0","@ionic/swiftlint-config":"^1.0.0","@rollup/plugin-node-resolve":"^8.1.0"},"peerDependencies":{"@capacitor/core":"^2.4.6"},"_npmOperationalInternal":{"tmp":"tmp/uxcam_0.0.3_1611941297589_0.811385550035143","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-01-29T17:28:17.360Z","modified":"2026-09-28T16:57:58.151Z","0.0.3":"2021-01-29T17:28:17.802Z"},"bugs":{"url":"https://github.com/SalahAdDin/capacitor-uxcam.git/issues"},"author":{"name":"CloudNesil"},"license":"MIT","homepage":"https://github.com/SalahAdDin/capacitor-uxcam#readme","keywords":["capacitor","plugin","native"],"repository":{"url":"git+https://github.com/SalahAdDin/capacitor-uxcam.git","type":"git"},"description":"Capacitor plugin for UXCam and FullStory analytics. It uses UXCam for Android and iOS platforms and FullStory for Web/PWA.","maintainers":[{"email":"jcesarmobile@gmail.com","name":"jcesarmobile"},{"email":"vitor.oliveira@outsystems.com","name":"vmfo"},{"email":"ihasmax@gmail.com","name":"maxlynch"},{"email":"mikehartington@gmail.com","name":"mhartington"},{"email":"mike.summerfeldt@gmail.com","name":"it_mike_s"},{"email":"info@byrds.ch","name":"byrds"},{"email":"sakakibara@rdlabo.jp","name":"rdlabo"},{"email":"priyank.patel@stackspace.ca","name":"priyankpatel"},{"email":"dwieeb@gmail.com","name":"dwieeb"},{"email":"oi@stewan.io","name":"stewan"},{"email":"arielhernandezmusa@gmail.com","name":"arielhernandezmusa"},{"email":"jeanpierre.queau@gmail.com","name":"jeepq"},{"email":"keagan@start9labs.com","name":"start9keagan"},{"email":"kevinboosten@gmail.com","name":"boosten"},{"email":"noahklayman@gmail.com","name":"nklayman"},{"email":"ibby@zyra.ca","name":"ihadeed"},{"email":"daniel.prr.azevedo@gmail.com","name":"danielprrazevedo"},{"email":"aparajita@aparajita.com","name":"ckgaparajita"},{"email":"joey@ionic.io","name":"jpender"},{"email":"nick@ionic.io","name":"nhyatt"},{"email":"pwespi@pm.me","name":"pwespi"},{"email":"epicshaggy@gmail.com","name":"epicshaggy"},{"email":"hello@thomasvidas.com","name":"thomasvidas"},{"email":"mail@robingenz.dev","name":"robingenz"},{"email":"james@diacono.com.au","name":"diachedelic"},{"email":"jaborges@protonmail.ch","name":"johnborges"},{"email":"tobyas@tobyas.nl","name":"tobyas"},{"email":"ely@meta-tek.net","name":"elylucas"},{"email":"giovanni@ionic.io","name":"giodimiliaionic"},{"email":"brownoxford@gmail.com","name":"brownoxford"},{"email":"mrba7ista@gmail.com","name":"mrbatista"},{"email":"bazuka5801@mail.ru","name":"bazuka5801"},{"email":"hemangsk@gmail.com","name":"hemang"},{"email":"ache@bbit.io","name":"thegnuu"},{"email":"peter@mapledesign.co.uk","name":"pbowyer"},{"email":"ely+capcom@meta-tek.net","name":"capcombot"},{"email":"rui.moreira.mendes@outsystems.com","name":"rui.mendes"},{"email":"andre.destro@outsystems.com","name":"ndr"},{"email":"agerardojacinto@gmail.com","name":"alexgerardojacinto"},{"email":"tafelnl@protonmail.com","name":"tafelnl"},{"email":"pedro.gustavo.bilro@outsystems.com","name":"os-pedrobilro"},{"email":"dallastjames@gmail.com","name":"dallasjames"},{"email":"ryltsov.alex@gmail.com","name":"ryaa"},{"email":"avishkank@gmail.com","name":"nkalupahana"},{"email":"hi@ionic.io","name":"ionicjs"},{"email":"sp@shiv19.com","name":"multishiv19"},{"email":"nuno.azevedo@outsystems.com","name":"nuno.azevedo-outsystems"},{"email":"trevorlambert11@gmail.com","name":"trevorlambert"},{"email":"philip.peitsch@gmail.com","name":"peitschie"},{"email":"damiantarnawsky@gmail.com","name":"damiantarnawsky"},{"email":"eric.harvey@outsystems.com","name":"harvdoggy"},{"email":"ossplugins@outsystems.com","name":"capacitor-plugin-bot"},{"email":"horodyski@ionic.io","name":"eric-ionic"},{"email":"rui.alves@outsystems.com","name":"os-ruialves"}],"readme":"


\n

UXCam

\n

@capacitor-community/uxcam

\n

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

\n\n\n

\n \n \n \n
\n \n \n\n\n\n

\n\n\n## Maintainers\n\n| Maintainer | GitHub | Social |\n| ------------ | -------------------------------------------- | ------ |\n| Luis Alaguna | [SalahAdDin](https://github.com/SalahAdDin/) | |\n\n## Installation\n\nInstall the package from the repository(by now):\n\n```bash\n# npm install @capacitor-community/uxcam\nnpm install SalahAdDin/capacitor-uxcam#dist\nionic cap update && ionic cap copy && ionic cap sync \n```\n\nOn iOS, no further steps are needed.\n\nOn Android:\n\n* Add the `UXCam` *maven* repository to your projects build's *graddle* script:\n\n ```gradle\n maven {\n \turl 'https://sdk.uxcam.com/android/'\n }\n ```\n\n* Register the plugin in your main activity:\n\n```java\nimport com.getcapacitor.community.uxcam.UXCamPlugin;\n\npublic class MainActivity extends BridgeActivity {\n @Override\n public void onCreate(Bundle savedInstanceState) {\n super.onCreate(savedInstanceState);\n\n // Initializes the Bridge\n this.init(savedInstanceState, new ArrayList>() {{\n // Additional plugins you've installed go here\n // Ex: add(TotallyAwesomePlugin.class);\n add(UXCamPlugin.class);\n }});\n }\n}\n```\n\n## Configuration\n\nNo configuration is required for this plugin.\n\n## Supported methods\n\nThe following are the [**UXCam**](https://uxcam.com/) implemented methogs on the plugin, for web plugin, **[FullStory](https://www.fullstory.com/)** methods are used:\n\n| Name | Android | iOS | Web |\n| :---------------------------- | :------ | :--- | :--- |\n| startWithKey | ✅ | ✅ | ❌ |\n| setUserIdentity | ✅ | ✅ | ✅ |\n| setUserProperty | ✅ | ✅ | ✅ |\n| setMultiSessionRecord | ✅ | ✅ | ❌ |\n| getEnabledMultiSessionRecord | ✅ | ✅ | ❌ |\n| logEvent | ✅ | ✅ | ✅ |\n| tagScreenName | ✅ | ✅ | ❌ |\n| setAutomaticScreenNameTagging | ✅ | ✅ | ❌ |\n| stopSession | ✅ | ✅ | ✅ |\n\nYou can find the full list of **UXCam** methods [here](https://help.uxcam.com/hc/en-us/categories/115000129131-Developer-Guide) and **FullStory** methods [here](https://developer.fullstory.com/introduction).\n\n## Usage\n\n```typescript\n// Must import the package once to make sure the web support initializes\nimport \"@capacitor-community/uxcam\"\nimport { Plugins } from \"@capacitor/core\"\nimport { LogEventProperty, UserProperty } from \"@capacitor-community/uxcam\"\n\nconst { UXCamPlugin } = Plugins\n\n/**\n * Platform: Web/Android/iOS\n * Logs and event.\n * @param eventName: String - Event's name.\n * @param properties?: { [key: string]: string | number } - a optional set of event's properties to include in the log.\n * @returns void\n * https://help.uxcam.com/hc/en-us/articles/115000969072-Send-Events-and-Properties\n */\nUXCamPlugin.logEvent(options: LogEventProperty)\n\n/**\n * Platform: Android/iOS\n * Start the UXCam service with the API key.\n * @param UXCamKey: String - UXCam's API key.\n * @returns void\n * https://help.uxcam.com/hc/en-us/articles/115001868272\n */\nUXCamPlugin.startWithKey(options: { UXCamKey: string })\n\n/**\n * Platform: Web/Android/iOS\n * Set the user's identifier(a name)\n * @param userIdentity: String - User's identifier.\n * @returns void\n * https://help.uxcam.com/hc/en-us/articles/115000968992-Send-Additional-User-Information\n */\nUXCamPlugin.setUserIdentity(options: { userIdentity: string })\n\n/**\n * Platform: Web/Android/iOS\n * Set the user's properties.\n * @param properties: { [key: string]: string | number } - a set of user's properties(as email, phone, age, etc.).\n * @returns void\n * https://help.uxcam.com/hc/en-us/articles/115000968992-Send-Additional-User-Information\n */\nUXCamPlugin.setUserProperty(options: UserProperty)\n\n/**\n * Platform: Android/iOS\n * Enables/disables the multisession record for users.\n * @param recordMultipleSessions: boolean - whether enables multi-session record per user or not.\n * @returns void\n * https://help.uxcam.com/hc/en-us/articles/115000968972-Control-Recording\n */\nUXCamPlugin.setMultiSessionRecord(options: { recordMultipleSessions: boolean })\n\n/**\n * Platform: Android/iOS\n * Get the multisession record status.\n * @param\n * @returns Promise<{ value: boolean }> - whether multi-session record per user is enabled or not.\n * https://help.uxcam.com/hc/en-us/articles/115000968972-Control-Recording\n */\nUXCamPlugin.getEnabledMultiSessionRecord()\n\n/**\n * Platform: Android/iOS\n * Set the name for a screen view in the application, it requires to dissable the automatic screen name tagging.\n * @param screenName: String - Screen view's name.\n * @returns void\n * https://help.uxcam.com/hc/en-us/articles/360043007412-Tag-Screen-Name\n */\nUXCamPlugin.tagScreenName(options: { screenName: string })\n\n/**\n * Platform: Android/iOS\n * Enables/disables the automatic screen name tagging.\n * @param recordMultipleSessions: boolean - whether enables automatic screen name tagging or not.\n * @returns void\n * https://help.uxcam.com/hc/en-us/articles/360043007412-Tag-Screen-Name\n */\nUXCamPlugin.setAutomaticScreenNameTagging(options: { enable: boolean }): Promise;\n\n/**\n * Platform: Web/Android/iOS\n * Stops the session record.\n * @param \n * @returns void\n * https://help.uxcam.com/hc/en-us/articles/115000968972-Control-Recording\n */\nUXCamPlugin.stopSession(): Promise\n```\n\n## Further info\n\n- [Android](https://firebase.google.com/docs/android/setup)\n- [iOS](https://firebase.google.com/docs/analytics/get-started?platform=ios)\n- [Web](https://firebase.google.com/docs/analytics/get-started?platform=web)\n\n","readmeFilename":"README.md"}