{"__v":10,"_id":"55ecd6edae66a30d00446ce7","category":{"__v":35,"_id":"55e67b5556007d23005fee7d","pages":["55e67b91de6fef23009480cb","55e67c28de6fef23009480ce","55e67c3cde6fef23009480d1","55e680e185a9741900314e96","55e682b7de6fef23009480dc","55ecd69bb2714d2100f227c0","55ecd6c554a67b1700edcf40","55ecd6edae66a30d00446ce7","55ecd777b2714d2100f227c2","55ecda5a7659d21700a7ef9b","55ecdaf6ae66a30d00446cf3","55ed006a0d968e2100de831e","55ed0258c9d5b3350072ae7a","55ee66a073d3941700f760e5","55f5ef61a1dea80d00a5dec5","55f5f38618b39b0d00c27eb0","55f9f86417b9d00d00969e29","55f9fdc8aba81f0d00a1156d","561b10b4c89cc30d0082154f","561b110a03bce90d00c4bd11","561c6195ad272c0d00a892dd","561c6ca0be5fb20d00077754","564f3e66c133343500286ca0","565b955b922c9a0d00d1f124","566784d2919aaa0d008e32db","566e1ee5972a290d00552084","569c58d77c3e44170014114f","56a2692f6928550d006c8327","56ca6c868014e417002bfe54","56cfa5386c5d7a13005eec0f","56e73d86555c030e00a52a73","56e7460c9000b120000ffe2e","56e8c19e99c6400e003820cf","56e8c53fc88bf80e00f8bed8","56f06ff4d386ce0e008e9b21"],"project":"55e67aaa9cc7c62b00c4a1ea","version":"55e67aab9cc7c62b00c4a1ed","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-02T04:30:13.305Z","from_sync":false,"order":1,"slug":"install-in-your-app","title":"Install in your app"},"parentDoc":null,"project":"55e67aaa9cc7c62b00c4a1ea","user":"55d2bd8e2463351700f67dd7","version":{"__v":9,"_id":"55e67aab9cc7c62b00c4a1ed","project":"55e67aaa9cc7c62b00c4a1ea","createdAt":"2015-09-02T04:27:23.612Z","releaseDate":"2015-09-02T04:27:23.612Z","categories":["55e67aac9cc7c62b00c4a1ee","55e67b5556007d23005fee7d","55e67b5dde6fef23009480ca","55e680efde6fef23009480db","55e6829485a9741900314e99","561c61b4ad272c0d00a892df","586c014c0abf1d0f000d04d4","58991d2ad207df0f0002186b","589b8e1fdbb7cd190026732c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-07T00:14:37.434Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"Carnival supports a [Cordova](https://cordova.apache.org/) plugin that allows you to use the Carnival SDK for iOS and Android through a JavaScript interface.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Cordova minimum version\",\n  \"body\": \"Carnival supports `cordova-platform-ios` version 4.3.1 or later and `cordova-platform-android` version 6.1.0 or later.\\n\\nAlthough Carnival may compile on with earlier versions, it may lead to unforeseen issues.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Installation\"\n}\n[/block]\nThis guide assumes Cordova is installed in your machine and your project is already initialized.\n\n### Add the plugin\n\nType the following command:\n`cordova plugin add https://github.com/carnivalmobile/carnival-sdk-cordova.git`\n\n### iOS\n\nAdd a preference to your `config.xml` file with your Carnival App key (from [http://app.carnivalmobile.com](http://app.carnivalmobile.com)).\n\ne.g.\n\n```xml\n<platform name=\"ios\">\n    <preference name=\"carnival_ios_app_key\" value=\"YOUR_APP_KEY_GOES_HERE\" />\n</platform>\n```\n\nOpen your Xcode project, which should be located in the `platforms/ios` directory of your Cordova/Phonegap project and Drag and drop the `Carnival.embeddedframework` into it. The `Carnival.embeddedframework` can be downloaded from the [Carnival iOS SDK repo](https://github.com/carnivalmobile/carnival-ios-sdk/releases).\n\nTo set up Push with Cordova and iOS, follow [Push Notifications for iOS](doc:push-notifications-for-ios) \n\n### Android\n\nAdd these preferences to your `config.xml` file with your Carnival App key (from [http://app.carnivalmobile.com](http://app.carnivalmobile.com)).\n\ne.g.\n\n```xml\n<platform name=\"android\">\n    <preference name=\"carnival_android_app_key\" value=\"YOUR_APP_KEY_GOES_HERE\"/>\n</platform>\n```\n\nThe next step is to setup [Push Notifications for Android](doc:enable-push-notifications-for-android)","excerpt":"Integration instructions for Cordova Apps","slug":"cordova-integration","type":"basic","title":"Cordova Integration"}

Cordova Integration

Integration instructions for Cordova Apps

Carnival supports a [Cordova](https://cordova.apache.org/) plugin that allows you to use the Carnival SDK for iOS and Android through a JavaScript interface. [block:callout] { "type": "info", "title": "Cordova minimum version", "body": "Carnival supports `cordova-platform-ios` version 4.3.1 or later and `cordova-platform-android` version 6.1.0 or later.\n\nAlthough Carnival may compile on with earlier versions, it may lead to unforeseen issues." } [/block] [block:api-header] { "type": "basic", "title": "Installation" } [/block] This guide assumes Cordova is installed in your machine and your project is already initialized. ### Add the plugin Type the following command: `cordova plugin add https://github.com/carnivalmobile/carnival-sdk-cordova.git` ### iOS Add a preference to your `config.xml` file with your Carnival App key (from [http://app.carnivalmobile.com](http://app.carnivalmobile.com)). e.g. ```xml <platform name="ios"> <preference name="carnival_ios_app_key" value="YOUR_APP_KEY_GOES_HERE" /> </platform> ``` Open your Xcode project, which should be located in the `platforms/ios` directory of your Cordova/Phonegap project and Drag and drop the `Carnival.embeddedframework` into it. The `Carnival.embeddedframework` can be downloaded from the [Carnival iOS SDK repo](https://github.com/carnivalmobile/carnival-ios-sdk/releases). To set up Push with Cordova and iOS, follow [Push Notifications for iOS](doc:push-notifications-for-ios) ### Android Add these preferences to your `config.xml` file with your Carnival App key (from [http://app.carnivalmobile.com](http://app.carnivalmobile.com)). e.g. ```xml <platform name="android"> <preference name="carnival_android_app_key" value="YOUR_APP_KEY_GOES_HERE"/> </platform> ``` The next step is to setup [Push Notifications for Android](doc:enable-push-notifications-for-android)