VancedMicroG/play-services-location-api/src/main/java/com/google/android/gms/location/GeofencingEvent.java

/*
 * Copyright (C) 2017 microG Project Team
 *
 * 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 com.google.android.gms.location;

import android.content.Intent;
import android.location.Location;

import com.google.android.gms.location.internal.ParcelableGeofence;

import org.microg.gms.common.PublicApi;
import org.microg.safeparcel.SafeParcelUtil;

import java.util.ArrayList;
import java.util.List;

/**
 * Represents an event from the GeofencingApi API. The event can be
 * <p>
 * A geofence triggering event generated when a geofence transition happens.
 * An error happens after geofences are registered and being monitored.
 */
@PublicApi
public class GeofencingEvent {
    @PublicApi(exclude = true)
    public static final String EXTRA_ERROR_CODE = "gms_error_code";
    @PublicApi(exclude = true)
    public static final String EXTRA_TRIGGERING_LOCATION = "com.google.android.location.intent.extra.triggering_location";
    @PublicApi(exclude = true)
    public static final String EXTRA_TRANSITION = "com.google.android.location.intent.extra.transition";
    @PublicApi(exclude = true)
    public static final String EXTRA_GEOFENCE_LIST = "com.google.android.location.intent.extra.geofence_list";

    private int errorCode;
    private int geofenceTransition;
    private List<Geofence> triggeringGeofences;
    private Location triggeringLocation;

    /**
     * Creates a {@link GeofencingEvent} object from the given intent.
     *
     * @param intent the intent to extract the geofencing event data from
     * @return a {@link GeofencingEvent} object or {@code null} if the given intent is {@code null}
     */
    public static GeofencingEvent fromIntent(Intent intent) {
        if (intent == null) {
            return null;
        }
        GeofencingEvent event = new GeofencingEvent();
        event.errorCode = intent.getIntExtra(EXTRA_ERROR_CODE, -1);
        event.geofenceTransition = intent.getIntExtra(EXTRA_TRANSITION, -1);
        if (event.geofenceTransition != 1 && event.geofenceTransition != 2 && event.geofenceTransition != 4)
            event.geofenceTransition = -1;
        ArrayList<byte[]> parceledGeofences = (ArrayList<byte[]>) intent.getSerializableExtra(EXTRA_GEOFENCE_LIST);
        if (parceledGeofences != null) {
            event.triggeringGeofences = new ArrayList<Geofence>();
            for (byte[] parceledGeofence : parceledGeofences) {
                event.triggeringGeofences.add(SafeParcelUtil.fromByteArray(parceledGeofence, ParcelableGeofence.CREATOR));
            }
        }
        event.triggeringLocation = intent.getParcelableExtra(EXTRA_TRIGGERING_LOCATION);
        return event;
    }

    /**
     * Returns the error code that explains the error that triggered the intent specified in
     * {@link #fromIntent(Intent)}.
     *
     * @return the error code specified in {@link GeofenceStatusCodes} or {@code -1} if
     * {@link #hasError()} returns false.
     */
    public int getErrorCode() {
        return errorCode;
    }

    /**
     * Returns the transition type of the geofence transition alert.
     *
     * @return -1 if the intent specified in {@link #fromIntent(Intent)} is not generated for a
     * transition alert; Otherwise returns the GEOFENCE_TRANSITION_ flags value defined in
     * {@link Geofence}.
     */
    public int getGeofenceTransition() {
        return geofenceTransition;
    }


    /**
     * Returns a list of geofences that triggered this geofence transition alert.
     *
     * @return a list of geofences that triggered this geofence transition alert or {@code null} if
     * the intent specified in {@link #fromIntent(Intent)} is not generated for a geofence
     * transition alert
     */
    public List<Geofence> getTriggeringGeofences() {
        return triggeringGeofences;
    }

    /**
     * Gets the location that triggered the geofence transition. Triggering location is only
     * available if the calling app links against Google Play services 5.0 SDK.
     *
     * @return the location that triggered this geofence alert or {@code null} if it's not included
     * in the intent specified in {@link #fromIntent(Intent)}
     */
    public Location getTriggeringLocation() {
        return triggeringLocation;
    }

    /**
     * Whether an error triggered this intent.
     *
     * @return {@code true} if an error triggered the intent specified in
     * {@link #fromIntent(Intent)}, otherwise {@code false}
     */
    public boolean hasError() {
        return errorCode != -1;
    }
}