Important

This documentation is deprecated, and only kept here to support users of browser extension APIs. If you are using Trigger.io for iOS or Android, see https://trigger.io/docs/.

Native plugins

Important

Plugins are currently a beta feature, get in touch with support@trigger.io if you're interested in trying them out.

Native plugins allow you to write native Android and iOS code, compile it and include this compiled code in your app built using Forge. As part of this it also provides a method for your native code to communicate with your Javascript code.

Writing native plugins is obviously different for Android and iOS, however we have tried to keep the experience as consistent as possible. With that in mind these docs are split into the various tasks you might want to complete as part of writing a native plugin, with instructions for Android and iOS included in each section.

• The Basics
  • Downloading the inspector projects
    • Android
    • iOS
  • Updating inspector projects
  • Structure of the inspector projects
    • General
    • Android
    • iOS
  • Structure of a plugin
    • manifest.json
  • Testing your plugin
  • Building/packaging your plugin
    • Android
    • iOS
  • Expected workflow
• Exposing native APIs to Javascript
  • Javascript
  • Android
  • iOS
• Triggering Javascript events
  • Javascript
  • Android
  • iOS
• Handling native events
  • Android
  • iOS
• Communicating with native code
  • Android
  • iOS
• Using external libraries
  • Android
  • iOS
    • System frameworks
    • 3rd party libraries/frameworks
• Changing build configuration
  • General
    • include_dependencies
  • Android
    • android_add_permission
    • android_add_feature
    • android_add_activity
    • android_add_service
    • android_add_receiver
  • iOS
    • add_ios_system_framework
    • ios_add_url_handler
    • set_in_info_plist
• Including resources
  • Android
  • iOS
• Working with files
  • Javascript
  • Android
    • Receiving from JavaScript
    • Returning to JavaScript
  • iOS
    • Receiving from JavaScript
    • Returning to JavaScript
• Testing your plugin
  • Automated tests
  • Interactive tests
  • Fixtures
• API docs
• Common problems
  • Toolkit error messages
    • iOS/Android inspector not found
    • iOS/Android inspector out of date
    • The directory 'x' was expected to be a file
    • The file 'x' was expected to be a directory
    • The path 'x' is required and was not found
    • The path 'x' was found but not expected
    • File 'android/plugin.jar' is not a valid jar file containing a Forge Android plugin with name 'x'
    • File 'ios/plugin.a' is not a valid static library file containing a Forge iOS plugin with name 'x'
    • Validation for 'x' failed: ...