io.appium.java_client.ios.IOSMobileCommandHelper 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

There is a newer version: 9.3.0

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

import com.google.common.collect.ImmutableMap;

import io.appium.java_client.MobileCommand;

import java.util.AbstractMap;
import java.util.Map;

public class IOSMobileCommandHelper extends MobileCommand {

    /**
     * This method forms a {@link java.util.Map} of parameters for the
     * device shaking.
     *
     * @return a key-value pair. The key is the command name. The value is a
     * {@link java.util.Map} command arguments.
     */
    public static Map.Entry>  shakeCommand() {
        return new AbstractMap.SimpleEntry<>(
                SHAKE, ImmutableMap.of());
    }
    
    /**
     * This method forms a {@link java.util.Map} of parameters for the touchId simulator.
     * 
     * @param match If true, simulates a successful fingerprint scan. If false, simulates a failed fingerprint scan.
     * 
     */
    public static Map.Entry> touchIdCommand(boolean match) {
        return new AbstractMap.SimpleEntry<>(
            TOUCH_ID, prepareArguments("match", match));
    }

    /**
     * This method forms a {@link java.util.Map} of parameters for the toggling touchId
     * enrollment in simulator.
     * The method is deprecated. Please use {@link #toggleTouchIdEnrollmentCommand(boolean)} instead.
     */
    @Deprecated
    public static Map.Entry> toggleTouchIdEnrollmentCommand() {
        return new AbstractMap.SimpleEntry<>(
                TOUCH_ID_ENROLLMENT, ImmutableMap.of());
    }

    /**
     * This method forms a {@link java.util.Map} of parameters for the toggling touchId
     * enrollment in simulator.
     *
     * @param enabled Whether to enable or disable Touch ID Enrollment for Simulator.
     *
     */
    public static Map.Entry> toggleTouchIdEnrollmentCommand(boolean enabled) {
        return new AbstractMap.SimpleEntry<>(
                TOUCH_ID_ENROLLMENT, prepareArguments("enabled", enabled));
    }
}