/*
 * Copyright (C) 2021. Uber Technologies
 *
 * 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.uber.rib.core

import com.uber.autodispose.lifecycle.LifecycleScopeProvider
import com.uber.rib.core.lifecycle.InteractorEvent

/**
 * An interface used as the upper bound of the generic used by [Router]s to avoid cyclic generic
 * types
 */
public interface InteractorType : LifecycleScopeProvider<InteractorEvent> {
  /** @return `true` if the controller is attached, `false` if not. */
  public fun isAttached(): Boolean

  /**
   * Handle an activity back press.
   *
   * @return whether this interactor took action in response to a back press.
   */
  public fun handleBackPress(): Boolean
}
