git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2020 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.freebox.internal;
  14
  15 import java.util.List;
  16 import java.util.Map;
  17
  18 import org.openhab.binding.freebox.internal.api.model.FreeboxAirMediaReceiver;
  19 import org.openhab.binding.freebox.internal.api.model.FreeboxLanHost;
  20 import org.openhab.core.thing.ThingUID;
  21
  22 /**
  23  * The {@link FreeboxDataListener} is notified by the bridge thing handler
  24  * with updated data from the Freebox server.
  25  *
  26  * @author Laurent Garnier - Initial contribution
  27  * @author Laurent Garnier - add discovery configuration
  28  * @author Laurent Garnier - use new internal classes
  29  */
  30 public interface FreeboxDataListener {
  31
  32     /**
  33      * Update the discovery configuration.
  34      *
  35      * @param configProperties the configuration
  36      */
  37     public void applyConfig(Map<String, Object> configProperties);
  38
  39     /**
  40      * This method is called just after the bridge thing handler fetched new data
  41      * from the Freebox server.
  42      *
  43      * @param bridge the Freebox server bridge.
  44      * @param lanHosts the LAN data received from the Freebox server.
  45      * @param airPlayDevices the list of AirPlay devices received from the Freebox server.
  46      */
  47     public void onDataFetched(ThingUID bridge, List<FreeboxLanHost> lanHosts,
  48             List<FreeboxAirMediaReceiver> airPlayDevices);
  49 }