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: https://www.pi4j.com/ 012 * ********************************************************************** 013 * %% 014 * Copyright (C) 2012 - 2019 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 033@SuppressWarnings("unused") 034public interface IFTTTMakerChannelTriggerListener { 035 036 /** 037 * This callback listener is fired when the IFTTTMakerChannelTrigger 038 * receives a GPIO pin change that invokes the trigger. This listener 039 * provides the consumer an opportunity to be notified of the trigger event, 040 * to optionally abort the triggered event before sending data to the IFTTT 041 * Maker Channel API, or an opportunity to override any data payload values 042 * before transmitting to the IFTTT Maker Channel API. 043 * 044 * @param event the IFTTTMakerChannelTriggerEvent event object that 045 * contains details about the GPIO pin, pin state, and 046 * IFTTT Maker Channel event name and data payload. 047 * @return Return a 'true' value to continue trasmitting the trigger data to 048 * the IFTTT Maker Channel API. Return a 'false' value to abort 049 * bypass sending the triggered event to IFTTT. 050 */ 051 public boolean onTriggered(IFTTTMakerChannelTriggerEvent event); 052}