io.appium.java_client.android.options.locking.SupportsUnlockSuccessTimeoutOption Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation

Java client for Appium Mobile Webdriver

The newest version!

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 * 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 io.appium.java_client.android.options.locking;

import io.appium.java_client.remote.options.BaseOptions;
import io.appium.java_client.remote.options.CanSetCapability;
import org.openqa.selenium.Capabilities;

import java.time.Duration;
import java.util.Optional;

import static io.appium.java_client.internal.CapabilityHelpers.toDuration;

public interface SupportsUnlockSuccessTimeoutOption> extends
        Capabilities, CanSetCapability {
    String UNLOCK_SUCCESS_TIMEOUT_OPTION = "unlockSuccessTimeout";

    /**
     * Maximum timeout to wait until the device is unlocked.
     * 2000 ms by default.
     *
     * @param timeout Timeout value.
     * @return self instance for chaining.
     */
    default T setUnlockSuccessTimeout(Duration timeout) {
        return amend(UNLOCK_SUCCESS_TIMEOUT_OPTION, timeout.toMillis());
    }

    /**
     * Get the timeout to wait until the device is unlocked.
     *
     * @return The timeout value.
     */
    default Optional getUnlockSuccessTimeout() {
        return Optional.ofNullable(
                toDuration(getCapability(UNLOCK_SUCCESS_TIMEOUT_OPTION))
        );
    }
}