hockeyApp.*

Type Library
Revision Release 2024.3703
Keywords HockeyApp, testing, distribution
Platforms Android, iOS

Overview

HockeyApp is a service which supports various aspects of the app development process, including the recruitment and management of testers, app distribution, and collection of crash reports.

Registration

To use this plugin, please register for an account.

Syntax

local hockeyApp = require( "plugin.hockey" )

Functions

hockeyApp.init()

hockeyApp.checkForUpdate()

hockeyApp.unRegisterForUpdate()

Project Settings

To use this plugin, add an entry into the plugins table of build.settings. When added, the build server will integrate the plugin during the build phase.

settings =
{
    plugins =
    {
        ["plugin.hockey"] =
        {
            publisherId = "com.coronalabs"
        },
    },
}

In addition, you must enable pop-up error messages within config.lua to catch crash reports:

application =
{
    showRuntimeErrors = true,
}

Important

If building for iOS, you must bypass App Transport Security (ATS) by adding the following to the plist table of build.settings. While we do not blindly encourage this approach for all developers and projects, bypassing ATS is required in certain cases. For more information on ATS, please see the Managing App Transport Security guide. 

settings =
{
    iphone =
    {
        plist =
        {
            NSAppTransportSecurity = { NSAllowsArbitraryLoads=true },
        },
    },
}
Note

For Android, the following permissions/features are automatically added when using this plugin:

  • "android.permission.INTERNET"
  • "android.permission.WRITE_EXTERNAL_STORAGE"

Support