# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The SFC licenses this file
# to you 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.

from datetime import timedelta
from typing import Optional, Union

from appium.options.common.supports_capabilities import SupportsCapabilities

WAIT_FOR_QUIESCENCE = 'waitForQuiescence'


class WaitForQuiescenceOption(SupportsCapabilities):
    @property
    def wait_for_quiescence(self) -> Optional[bool]:
        """
        Whether to wait for application quiescence.
        """
        return self.get_capability(WAIT_FOR_QUIESCENCE)

    @wait_for_quiescence.setter
    def wait_for_quiescence(self, value: Union[timedelta, float]) -> None:
        """
        It allows to turn on/off waiting for application quiescence in WebDriverAgent,
        while performing queries. The default value is true. You can avoid this kind
        of issues if you turn it off. Consider using waitForIdleTimeout capability
        instead for this purpose since Appium 1.20.0.
        """
        self.set_capability(WAIT_FOR_QUIESCENCE, value)
