aware 0.1.0

  • Readme
  • Example
  • Installing
  • new57

aware #

Flutter plugin for AIQAware

Prerequisite #

  1. Create project in AIQAware studio

  2. Create android, ios app in AIQAware studio

  3. Get App ID, API key, App package(bundle) name

For Android #

  • Create aware-client-config.json in src/main/assets and put information

    {
      "version": 1,
      "project_id": "AAAAAAAAAA",
      "app_id": "AAAAAAAAAA",
      "api_key": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
    }
    
  • Add permissions to AndroidManifest.xml

    <!-- Required Permissions to Use the SDK -->
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION"/>
    <!-- targetSDKVersion is Android API Level 28 or higher -->
    <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
    
  1. More information, see simple app

For ios #

  • Create AwareClient-Info.plist in Runner and put information (Be sure to create in xcode)

    <?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
      <key>API_KEY</key>
      <string>AAAAAAAAAAAAAAAAAAAAAAAAAAA</string>
      <key>APP_ID</key>
      <string>AAAAAAAAAA</string>
      <key>PROJECT_ID</key>
      <string>AAAAAAAAAA</string>
    </dict>
    </plist>
    
  • Add Capabilities

    • background modes

      • Location updates
      • Background fetch
      • Remote notifications
    • wifi information

    • push notification

  • Add permission strings to plist

      Privacy - Location When In Use Usage Description
      Privacy - Location Always Usage Description
      Privacy - Location Always and When In Use Usage Description
      Privacy - Media Library Usage Description
      Privacy - Photo Library Usage Description
      Privacy - Microphone Usage Description
      Privacy - Calendars Usage Description
      Privacy - Motion Usage Description
    

Prerequisite for development #

  1. Go to example directory

  2. Build Android, iOS projects

For Android

flutter build apk

For iOS

flutter build ios --no-codesign

Develop plugins on Android #

  • Open example/android project in Android Studio.

  • You can see aware, android projects.

  • android is example project

  • aware is plugin project

Develop plugins on iOS #

  • Open example/ios/Runner.xcworkspace in xcode

  • You can see Runner, Pods

  • Runner is example project

  • Pods/DevelopmentPods/../../example/ios/.symlink/plugins/aware/ios/Classes is plugin project

example/README.md

aware_example #

Demonstrates how to use the aware plugin.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  aware: ^0.1.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:aware/aware.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
28
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
64
Overall:
Weighted score of the above. [more]
57
Learn more about scoring.

We analyzed this package on Dec 4, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.6

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health issues and suggestions

Document public APIs. (-1 points)

28 out of 28 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Format lib/aware.dart.

Run flutter format to format lib/aware.dart.

Maintenance issues and suggestions

Provide a file named CHANGELOG.md. (-20 points)

Changelog entries help developers follow the progress of your package. See the example generated by stagehand.

The package description is too short. (-16 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.5.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test