mk.gdx.firebase.distributions.CrashDistribution Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gdx-fireapp-core Show documentation

Firebase SDK API for LibGDX projects.

There is a newer version: 3.3.1

/*
 * Copyright 2017 mk
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package mk.gdx.firebase.distributions;

/**
 * Provides access to Firebase crash method.
 * 
 * Basic Firebase crash functionality is initialized during application startup.

 * On iOS it is possible that your logs will be only information about ios-moe 'kill signal', then you
 * should implement {@link Thread#setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler)} inside {@code ios-moe} module.
 */
public interface CrashDistribution {

    /**
     * Logs custom message to Firebase.
     * 

     * It will be accessible inside Firebase console within about 24 hours.
     *
     * @param message Custom message you want to log into firebase console.
     */
    void log(String message);

    /**
     * Initialize crash reporting.
     * 
     * Fabric.with will be call here so you don't need to add it manually to your AndroidLauncher/IOSMoeLauncher.
     */
    void initialize();
}