/*
 * 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;

public interface IGoogleMessengerHelper extends IAppHelper {
    /*
     * Setup expectations: Google Messenger app is open.
     *
     * This method brings the Messenger app to the home page.
     */
    public void goToHomePage();

    /*
     * Setup expectation: Google Messenger app is on the home page.
     *
     * This method brings up the new conversation page.
     */
    public void goToNewConversationPage();

    /*
     * Setup expectations: Google Messenger app is on the new conversation page.
     *
     * This method moves the Google Messenger app to messages page with the specified contacts.
     */
    public void goToMessagesPage();

    /**
     * Setup expectations: Google Messenger app is on the messages page.
     *
     * This method scrolls through the messages on the messages page.
     *
     * @param direction Direction to scroll, must be UP or DOWN.
     */
    public void scrollMessages(Direction direction);

    /**
     * Setup expectations: Google Messenger app is on the messages page.
     *
     * This method clicks the "send message" textbox on the messages page.
     */
    public void clickComposeMessageText();

    /**
     * Setup expectations:
     *   1. Google Messenger app is on the messages page
     *   2. New message textbox is not empty.
     */
    public void clickSendMessageButton();

    /**
     * Setup expectations: Google Messenger app is on the messages page.
     *
     * This method clicks the "attach media" button and attaches the media file with the given
     * index in the device media gallery view.
     */
    public void attachMediaFromDevice(int index);

    /**
     * Setup expectations: Google Messenger app is on the New conversation page.
     *
     * This method selects a contact from the New conversation page.
     *
     * @param index The Index of contact to select.
     */
    default public void selectRecipient(int index){
        throw new UnsupportedOperationException("Not yet implemented.");
    }
}