/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * 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 android.platform.helpers;

import androidx.test.uiautomator.Direction;
import androidx.test.uiautomator.UiObject2;

public interface IPhotosHelper extends IAppHelper {
    /**
     * Setup expectations: Photos is open and on the main or a device folder's screen.
     *
     * <p>This method will check if there are videos that can be opened on current screen by looking
     * for any view objects with content-desc that starts with "Video"
     *
     * @return true if video clips are found, false otherwise
     */
    public boolean searchForVideoClip();

    /**
     * Setup expectations: Photos is open and on the main or a device folder's screen.
     *
     * <p>This method will select the first clip to open and play. This will block until the clip
     * begins to plays.
     */
    public void openFirstClip();

    /**
     * Setup expectations: Photos is open and a clip is currently playing.
     *
     * <p>This method will pause the current clip and block until paused.
     */
    public void pauseClip();

    /**
     * Setup expectations: Photos is open and a clip is currently paused in the foreground.
     *
     * <p>This method will play the current clip and block until it is playing.
     */
    public void playClip();

    /**
     * Setup expectations: Photos is open.
     *
     * <p>This method will go to the main screen.
     */
    public void goToMainScreen();

    /**
     * Setup expectation: Photos is open.
     *
     * <p>This method will go to the top of the main screen.
     */
    public void goToTopOfMainScreen();

    /**
     * Setup expectations: Photos is open.
     *
     * <p>This method will go to device folder screen.
     */
    public void goToDeviceFolderScreen();

    /**
     * Setup expectations: 1. Photos is open 2. on device folder screen 3. the first device folder
     * is shown on the screen
     *
     * <p>This method will search for user-specified device folder in device folders. If the device
     * folder is found, the function will return with the device folder on current screen.
     *
     * @param folderName User-specified device folder name
     * @return true if device folder is found, false otherwise
     */
    public boolean searchForDeviceFolder(String folderName);

    /**
     * Setup expectations: 1. Photos is open 2. on device folder screen 3. user-specified device
     * folder is currently on screen
     *
     * <p>This method will open the user-specified device folder.
     *
     * @param folderName User-specified device folder name
     */
    public void openDeviceFolder(String folderName);

    /**
     * Setup expectations: Photos is open and on the main or a device folder's screen.
     *
     * <p>This method will check if there are pictures that can be opened on current screen by
     * looking for any view objects with content-desc that starts with "Photo"
     *
     * @return true if pictures are found
     */
    public boolean searchForPicture();

    /**
     * Setup expectations: Photos is open and on the main or a device folder's screen.
     *
     * <p>This method will open the picture at the specified index.
     *
     * @param index The index of the picture to open
     */
    public void openPicture(int index);

    /**
     * Setup expectations: Photos is open and a picture is open.
     *
     * <p>This method will scroll to next or previous picture in the specified direction.
     *
     * @param direction The direction to scroll, must be LEFT or RIGHT.
     * @return Returns whether picture can be still scrolled in the given direction
     */
    public boolean scrollPicture(Direction direction);

    /**
     * Setup expectations: Photos is open and a page contains pictures or albums is open.
     *
     * <p>This method will scroll the page in the specified direction.
     *
     * @param direction The direction of the scroll, must be UP or DOWN.
     * @return Returns whether the object can still scroll in the given direction
     */
    public boolean scrollPage(Direction direction);

    /**
     * Setup expectations: Photos is open and a page contains pictures or albums is open.
     *
     * <p>This method will scroll the page in the specified direction.
     *
     * <p>This method needs to check the UI object additionally.
     *
     * @param container The container with scrollable elements.
     * @param direction The direction of the scroll, must be UP or DOWN.
     * @param percentOfPhotoSize The distance of scroll as a percentage of Photo size.
     * @param speed The speed of the scroll.
     * @return Returns whether the object can still scroll in the given direction.
     */
    public boolean scrollPhotosGrid(
            UiObject2 container, Direction direction, float percentOfPhotoSize, int speed);

    /**
     * Setup expectations: Photos is open and a page contains pictures or albums is open.
     *
     * <p>This method will swipe to scroll the page in the specified direction.
     *
     * <p>This method needs to check the UI object additionally.
     *
     * @param container The container with scrollable elements.
     * @param direction The direction of the scroll, must be UP or DOWN.
     * @param percent The distance of scroll as a percentage of Photo size.
     */
    public void scrollPhotosGridBySwiping(UiObject2 container, Direction direction, float percent);

    /**
     * Setup expectation: Photos is open and a page contains pictures or albums is open.
     *
     * <p>Get the UiObject2 of photo scroll view pattern.
     */
    public UiObject2 getPhotoScrollView();

    /**
     * Setup expectation: Photos is open.
     *
     * <p>Check if device is now in Photos main screen.
     *
     * @return Returns true if device is in Photos main screen, false if not.
     */
    public boolean isOnMainScreen();

    /** Setup expectation: Disable backup mode in settings. */
    public void disableBackupMode();

    /** Setup expectation: Enable backup mode in settings. */
    public void enableBackupMode();

    /** Setup expectation: Verify backup starts uploading new pictures in settings. */
    public void verifyContentStartedUploading();

    /** Setup expectation: Verify backup is finishedin settings. */
    public void verifyContentBackupFinished();

    /** Setup expectation: Remove photos app content. */
    public void removeContent();

    /**
     * This method checks and waits whether any music is active. The music track is active when a
     * video is playing, even the video is silent or the media volume is muted.
     *
     * @return true if any music tracks are active.
     */
    public boolean isMusicPlaying();

    /**
     * Setup expectation: Photos is open.
     *
     * <p>Check if device is now in Photos folder page.
     *
     * @return Returns true if device is in Photos folder page, false if not.
     */
    public boolean isOnDeviceFolderPage();

    /**
     * Setup expectation: Photos is open.
     *
     * <p>Check if device has video player.
     *
     * @return Returns true if device has video player, false if not.
     */
    public boolean hasVideoPlayer();
}