Get Started

our flutter plugin wrapper makes it easier for you to install the sdk directly on your flutter app follow these simple steps add dependencies to add the cooee flutter plugin to your project, edit your project's pubspec yaml file dependencies cooee plugin x y z replace x y z with the latest release of the sdk or run command $ flutter pub add cooee plugin this command will add the latest version of cooee plugin configure credentials android setup add the following inside the application tag in androidmanifest xml present in android/app/src/main/ folder \<meta data android\ name="cooee app id" android\ value="my cooee app id"/> \<! sets configuration for com google ar core > \<meta data android\ name="com google ar core" android\ value="optional" /> ios setup add the following snippet in the app's info plist present at ios/runner/ folder plist \<key>cooee app id\</key> \<string>my cooee app id\</string> replace my cooee app id with the app id which is present at cooee portal configure firebase (android only) for android, cooee uses firebase messaging service to send push notifications to enable this feature, follow the steps below register your app with firebase to connect your app to firebase, follow step 2 provided in the firebase documentation once the app is connected to your firebase project, add the google service json file in the android/app folder of your project add firebase messaging service note note this step is required for cooee plugin ^1 3 7 and below versions once you registered your app with firebase, add the following inside the application tag in androidmanifest xml present at android/app/src/main/ folder \<service android\ name="com letscooee flutter fluttercooeefirebasemessagingservice" android\ exported="false"> \<intent filter> \<action android\ name="com google firebase messaging event" /> \</intent filter> \</service> permission usage android (optional) cooee sdk supports prompting the following permissions via engagement to make it work, you need to add the following to the app's androidmanifest xml file present in android/app/src/main/ folder \<! cooee sdk use this permission to run augmented reality engagements > \<uses permission android\ name="android permission camera" /> \<! cooee sdk use this permission to run location based engagements > \<uses permission android\ name="android permission access fine location" /> \<! cooee sdk use this permission to post an notification(required only on android 13 and above) > \<uses permission android\ name="android permission post notifications" /> ios cooee sdk uses a few permission if granted (we do not ask explicitly) for analysing the user this helps us to create and deliver better notifications and in apps apple requires a user friendly description of such permissions as defined here add the following permission description to app's info plist file present at ios/runner/ folder plist \<key>nslocationwheninuseusagedescription\</key> \<string>app uses location to search retailer location\</string> \<key>nsbluetoothalwaysusagedescription\</key> \<string>app uses bluetooth to find out nearby devices\</string> \<key>nscamerausagedescription\</key> \<string>need to access your camera for a better ar experience \</string> import it now in your dart code, import the package and start using it dart import 'package\ cooee plugin/cooee plugin dart'; android 13 and above needs permission to be granted to post a notification you will need to add the below code once the flutter view initializes dart void requestnotificationpermission() { cooeeplugin requestnotificationpermission(); }