src/main/java/com/google/android/libraries/feed/piet/host/ActionHandler.java

// Copyright 2018 The Feed Authors.
//
// 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.libraries.feed.piet.host;

import android.support.annotation.IntDef;
import android.view.View;
import com.google.search.now.ui.piet.ActionsProto.Action;
import com.google.search.now.ui.piet.LogDataProto.LogData;
import com.google.search.now.ui.piet.PietProto.Frame;

/**
 * Interface from the Piet host which provides handling of {@link Action} from the UI. An instance
 * of this is provided by the host. When an action is raised by the client {@link
 * #handleAction(Action, int, Frame, View, String)} will be called.
 */
public interface ActionHandler {
  /** Called on a event, such as a click of a view, on a UI element */
  // TODO: Do we need the veLoggingToken, one is defined in the Action
  void handleAction(
      Action action, @ActionType int actionType, Frame frame, View view, LogData logData);

  /** Possible action types. */
  @IntDef({ActionType.VIEW, ActionType.CLICK, ActionType.LONG_CLICK})
  @interface ActionType {
    /** View action type */
    int VIEW = 0;

    /** Click action */
    int CLICK = 1;

    /** Long click action */
    int LONG_CLICK = 2;
  }
}