001package com.pi4j.io.gpio.event;
002
003/*
004 * #%L
005 * **********************************************************************
006 * ORGANIZATION  :  Pi4J
007 * PROJECT       :  Pi4J :: Java Library (Core)
008 * FILENAME      :  IFTTTMakerChannelTriggerListener.java
009 *
010 * This file is part of the Pi4J project. More information about
011 * this project can be found here:  http://www.pi4j.com/
012 * **********************************************************************
013 * %%
014 * Copyright (C) 2012 - 2016 Pi4J
015 * %%
016 * This program is free software: you can redistribute it and/or modify
017 * it under the terms of the GNU Lesser General Public License as
018 * published by the Free Software Foundation, either version 3 of the
019 * License, or (at your option) any later version.
020 *
021 * This program is distributed in the hope that it will be useful,
022 * but WITHOUT ANY WARRANTY; without even the implied warranty of
023 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
024 * GNU General Lesser Public License for more details.
025 *
026 * You should have received a copy of the GNU General Lesser Public
027 * License along with this program.  If not, see
028 * <http://www.gnu.org/licenses/lgpl-3.0.html>.
029 * #L%
030 */
031
032
033import com.pi4j.io.gpio.GpioPin;
034import com.pi4j.io.gpio.PinState;
035
036import javax.net.ssl.HttpsURLConnection;
037import java.io.BufferedReader;
038import java.io.DataOutputStream;
039import java.io.IOException;
040import java.io.InputStreamReader;
041import java.net.URL;
042import java.net.URLEncoder;
043import java.nio.charset.StandardCharsets;
044import java.util.List;
045
046@SuppressWarnings("unused")
047public interface IFTTTMakerChannelTriggerListener {
048
049    /**
050     * This callback listener is fired when the IFTTTMakerChannelTrigger
051     * receives a GPIO pin change that invokes the trigger.  This listener
052     * provides the consumer an opportunity to be notified of the trigger event,
053     * to optionally abort the triggered event before sending data to the IFTTT
054     * Maker Channel API, or an opportunity to override any data payload values
055     * before transmitting to the IFTTT Maker Channel API.
056     *
057     * @param event the IFTTTMakerChannelTriggerEvent event object that
058     *              contains details about the GPIO pin, pin state, and
059     *              IFTTT Maker Channel event name and data payload.
060     * @return Return a 'true' value to continue trasmitting the trigger data to
061     *         the IFTTT Maker Channel API.  Return a 'false' value to abort
062     *         bypass sending the triggered event to IFTTT.
063     */
064    public boolean onTriggered(IFTTTMakerChannelTriggerEvent event);
065}