Contents

# frozen_string_literal: true

# 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.

module Appium
  module Core
    class Base
      #
      # @api private
      #

      module Rotatable
        ORIENTATIONS = %i[
          landscape
          portrait
          uia_device_orientation_landscaperight
          uia_device_orientation_portrait_upsidedown
        ].freeze

        #
        # Change the screen orientation
        #
        # @param [:landscape, :portrait,
        #         :uia_device_orientation_landscaperight, :uia_device_orientation_portrait_upsidedown] orientation
        #
        #
        def rotation=(orientation)
          unless ORIENTATIONS.include?(orientation)
            raise ::Appium::Core::Error::ArgumentError, "expected #{ORIENTATIONS.inspect}, got #{orientation.inspect}"
          end

          bridge.screen_orientation = orientation.to_s.upcase
        end
        alias rotate rotation=
        alias orientation= rotation=

        #
        # Get the current screen orientation
        #
        # @return [:landscape, :portrait,
        #          :uia_device_orientation_landscaperight, :uia_device_orientation_portrait_upsidedown] orientation
        #
        # @api public
        #

        def orientation
          bridge.screen_orientation.to_sym.downcase
        end
      end
    end
  end
end

Version data entries

22 entries across 22 versions & 1 rubygems

Version	Path
appium_lib_core-6.3.0	lib/appium_lib_core/common/base/rotable.rb
appium_lib_core-6.2.1	lib/appium_lib_core/common/base/rotable.rb