How to use getSafariDeviceType method of io.appium.java_client.safari.options.SupportsSafariDeviceTypeOption class

1/*
2 * Licensed under the Apache License, Version 2.0 (the "License");
3 * you may not use this file except in compliance with the License.
4 * See the NOTICE file distributed with this work for additional
5 * information regarding copyright ownership.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package io.appium.java_client.safari.options;
18
19import io.appium.java_client.remote.options.BaseOptions;
20import io.appium.java_client.remote.options.CanSetCapability;
21import org.openqa.selenium.Capabilities;
22
23import java.util.Optional;
24
25public interface SupportsSafariDeviceTypeOption<T extends BaseOptions<T>> extends
26        Capabilities, CanSetCapability<T> {
27    String SAFARI_DEVICE_TYPE_OPTION = "safari:deviceType";
28
29    /**
30     * If the value of safari:deviceType is 'iPhone', safaridriver will only create a session
31     * using an iPhone device or iPhone simulator. If the value of safari:deviceType is 'iPad',
32     * safaridriver will only create a session using an iPad device or iPad simulator.
33     * Values of safari:deviceType are compared case-insensitively.
34     *
35     * @param deviceType Device type name.
36     * @return self instance for chaining.
37     */
38    default T setSafariDeviceType(String deviceType) {
39        return amend(SAFARI_DEVICE_TYPE_OPTION, deviceType);
40    }
41
42    /**
43     * Get the type of the device.
44     *
45     * @return String representing the type of the device.
46     */
47    default Optional<String> getSafariDeviceType() {
48        return Optional.ofNullable((String) getCapability(SAFARI_DEVICE_TYPE_OPTION));
49    }
50}
51

Source: SupportsSafariDeviceTypeOption.java

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

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

import java.util.Optional;

public interface SupportsSafariDeviceTypeOption<T extends BaseOptions<T>> extends
        Capabilities, CanSetCapability<T> {
    String SAFARI_DEVICE_TYPE_OPTION = "safari:deviceType";

    /**
     * If the value of safari:deviceType is 'iPhone', safaridriver will only create a session
     * using an iPhone device or iPhone simulator. If the value of safari:deviceType is 'iPad',
     * safaridriver will only create a session using an iPad device or iPad simulator.
     * Values of safari:deviceType are compared case-insensitively.
     *
     * @param deviceType Device type name.
     * @return self instance for chaining.
     */
    default T setSafariDeviceType(String deviceType) {
        return amend(SAFARI_DEVICE_TYPE_OPTION, deviceType);
    }

    /**
     * Get the type of the device.
     *
     * @return String representing the type of the device.
     */
    default Optional<String> getSafariDeviceType() {
        return Optional.ofNullable((String) getCapability(SAFARI_DEVICE_TYPE_OPTION));
    }
}