.. _client_preferences:

Параметры клиентского приложения
===========================================

ClientPreferences
---------------------------

.. pas:class:: ClientPreferences

  Реализует доступ к некоторым параметрам клиентского приложения

.. versionadded:: 1.24.0-ms20

  .. pas:method:: ClientId: String

    Получить идентификатор клиента (клиентского приложения).

    Если из одного браузера открыто несколько приложений (вкладок, окон), значение идентификатора для них одно.

    :rtype: String

  .. pas:method:: HostIp: String

    Получить IP-адрес клиентского приложения

    :rtype: String

  .. pas:method:: Language: String

    Получить тег языка клиентского приложения, например "ru-Ru"

    :rtype: String

  .. pas:method:: ScreenHeight: Int64

    Получить значение высоты экрана пользователя в пикселях.

    Если у пользователя несколько мониторов, вернется значение того, в котором находилось окно браузера при авторизации пользователя

    :rtype: Int64

  .. pas:method:: ScreenWidth: Int64

    Получить значение ширины экрана пользователя в пикселях.

    Если у пользователя несколько мониторов, вернется значение того, в котором находилось окно браузера при авторизации пользователя

    :rtype: Int64

  .. pas:method:: TimeZoneDifference: Int64

    Получить разницу во времени между клиентом и сервером в миллисекундах.

    Если сервер UTC+3, а клиент UTC+4, разница будет 360 000 мс

    :rtype: Int64

  .. pas:method:: TimeZoneOffset: Int64

    Получить смещение (по Гринвичу) временной зоны клиента в миллисекундах.

    Для UTC+3 значение будет равно 1 080 000 мс

    :rtype: Int64

  .. pas:method:: UserAgent: String

    Получить строку, содержащую информацию о клиентском приложении и операционной системе

    :rtype: String

  .. pas:method:: UserAgentName: String

    Получить строку, содержащую имя клиентского приложения (браузера). Метод вернет сокращенное название, например "Chrome"

    :rtype: String

  .. pas:method:: isDesktop: boolean

    Получить значение флага, указывающего, что клиентское приложение выполняется на устройстве десктопного типа

    :rtype: boolean

  .. pas:method:: isLinux: boolean

    Получить значение флага, указывающего, что клиентское приложение выполняется в операционной системе семейства Linux

    :rtype: boolean

  .. pas:method:: isMac: boolean

    Получить значение флага, указывающего, что клиентское приложение выполняется в операционной системе семейства Apple Mac

    :rtype: boolean

  .. pas:method:: isTablet: boolean

    Получить значение флага, указывающего, что клиентское приложение выполняется на устройстве мобильного типа

    :rtype: boolean

  .. pas:method:: isWindows: boolean

    Получить значение флага, указывающего, что клиентское приложение выполняется в операционной системе семейства MS Windows

    :rtype: boolean