io.appium.java_client.HasAppStrings 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;

import org.openqa.selenium.UnsupportedCommandException;

import java.util.Map;

import static io.appium.java_client.MobileCommand.GET_STRINGS;

public interface HasAppStrings extends ExecutesMethod, CanRememberExtensionPresence {
    /**
     * Get all defined Strings from an app for the default language.
     * See the documentation for 'mobile: getAppStrings' extension for more details.
     *
     * @return a map with localized strings defined in the app
     */
    default Map getAppStringMap() {
        final String extName = "mobile: getAppStrings";
        try {
            return CommandExecutionHelper.executeScript(assertExtensionExists(extName), extName);
        } catch (UnsupportedCommandException e) {
            // TODO: Remove the fallback
            return CommandExecutionHelper.execute(markExtensionAbsence(extName), GET_STRINGS);
        }
    }

    /**
     * Get all defined Strings from an app for the specified language.
     * See the documentation for 'mobile: getAppStrings' extension for more details.
     *
     * @param language strings language code
     * @return a map with localized strings defined in the app
     */
    default Map getAppStringMap(String language) {
        final String extName = "mobile: getAppStrings";
        try {
            return CommandExecutionHelper.executeScript(assertExtensionExists(extName), extName, Map.of(
                    "language", language
            ));
        } catch (UnsupportedCommandException e) {
            // TODO: Remove the fallback
            return CommandExecutionHelper.execute(
                    markExtensionAbsence(extName),
                    Map.entry(GET_STRINGS, Map.of("language", language))
            );
        }
    }

    /**
     * Get all defined Strings from an app for the specified language and
     * strings filename. See the documentation for 'mobile: getAppStrings'
     * extension for more details.
     *
     * @param language   strings language code
     * @param stringFile strings filename. Ignored on Android
     * @return a map with localized strings defined in the app
     */
    default Map getAppStringMap(String language, String stringFile) {
        final String extName = "mobile: getAppStrings";
        Map args = Map.of(
                "language", language,
                "stringFile", stringFile
        );
        try {
            return CommandExecutionHelper.executeScript(assertExtensionExists(extName), extName, args);
        } catch (UnsupportedCommandException e) {
            // TODO: Remove the fallback
            return CommandExecutionHelper.execute(
                    markExtensionAbsence(extName),
                    Map.entry(GET_STRINGS, args)
            );
        }
    }

}