Spec-Zone.ru › Hammerspoon

hs.network.configuration

Этот подмодуль предоставляет доступ к текущим настройкам конфигурации расположения, установленным в динамическом хранилище системы.

Обзор API

  • Конструкторы - вызовы API, которые возвращают объект, обычно тот, который предлагает методы API
    • open
  • Методы - вызовы API, которые могут быть выполнены только на объекте, возвращённом конструктором
    • computerName
    • consoleUser
    • contents
    • dhcpInfo
    • hostname
    • keys
    • location
    • locations
    • monitorKeys
    • proxies
    • setCallback
    • setLocation
    • start
    • stop

Документация API

Конструкторы

open
Подпись hs.network.configuration.open() -> storeObject
Тип Конструктор
Описание

Открывает сеанс для динамического хранилища, поддерживаемого сервером конфигурации системы.

Параметры
  • Нет
Возвращаемое значение
  • storeObject
Исходный код extensions/network/libnetwork_configuration.m строка 48

Методы

computerName
Подпись hs.network.configuration:computerName() -> name, encoding
Тип Метод
Описание

Возвращает имя компьютера, указанное в настройках совместного использования, и его кодировку.

Параметры
  • Нет
Возвращаемое значение
  • name - имя компьютера
  • encoding - тип кодировки
Примечания
  • Вы также можете получить эту информацию в виде пар ключ-значение с помощью hs.network.configuration:contents("Setup:/System")
Исходный код extensions/network/libnetwork_configuration.m строка 194
consoleUser
Подпись hs.network.configuration:consoleUser() -> name, uid, gid
Тип Метод
Описание

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

Параметры
  • Нет
Возвращаемое значение
  • name - имя пользователя
  • uid - идентификатор пользователя
  • gid - идентификатор основной группы пользователя
Примечания
  • Вы также можете получить эту информацию в виде пар ключ-значение с помощью hs.network.configuration:contents("State:/Users/ConsoleUser")
Исходный код extensions/network/libnetwork_configuration.m строка 245
содержимое
Подпись hs.network.configuration:contents([keys], [pattern]) -> table
Тип Метод
Описание

Возвращает содержимое хранилища для указанных ключей или ключей, соответствующих указанному шаблону(ам)

Параметры
  • keys - строка или таблица строк, содержащая ключи или шаблоны ключей, если pattern равно true. По умолчанию - все ключи.
  • pattern - логическое значение, указывающее, следует ли рассматривать предоставленную(ые) строку(и) как шаблоны регулярных выражений (true) или литеральные строки для соответствия (false). По умолчанию - false.
Возвращаемое значение
  • таблица пар ключ-значение из динамического хранилища, соответствующих указанным ключам или шаблонам ключей.
Примечания
  • если параметры не указаны, возвращаются все пары ключ-значение в динамическом хранилище.
Источник extensions/network/libnetwork_configuration.m строка 86
dhcpInfo
Подпись hs.network.configuration:dhcpInfo([serviceID]) -> table
Тип Метод
Описание

Возвращает информацию DHCP для указанной службы или основной службы, если параметр не указан.

Параметры
  • serviceID - необязательная строка, содержащая идентификатор службы интерфейса, для которого требуется информация DHCP. Если этот параметр не указан, запрашивается по умолчанию (основная) служба.
Возвращаемое значение
  • таблица, содержащая информацию DHCP, включая время аренды и параметры DHCP
Примечания
  • список возможных идентификаторов служб можно получить с помощью hs.network.configuration:contents("Setup:/Network/Global/IPv4")
  • генерирует ошибку, если идентификатор службы недействителен или ему не был назначен IP-адрес через DHCP.
Источник extensions/network/libnetwork_configuration.m строка 161
имя_хоста
Подпись hs.network.configuration:hostname() -> name
Тип Метод
Описание

Возвращает текущее имя локального хоста компьютера

Параметры
  • Нет
Возвращаемое значение
  • имя - имя локального хоста
Примечания
  • Вы также можете получить эту информацию в виде пар ключ-значение с помощью hs.network.configuration:contents("Setup:/System")
Источник extensions/network/libnetwork_configuration.m строка 278
ключи
Подпись hs.network.configuration:keys([keypattern]) -> table
Тип Метод
Описание

Возвращает ключи в динамическом хранилище, соответствующие указанному шаблону

Параметры
  • keypattern - регулярное выражение, определяющее, какие ключи вернуть (по умолчанию ".*", или все ключи)
Возвращаемое значение
  • таблица ключей из динамического хранилища.
Источник extensions/network/libnetwork_configuration.m строка 136
местоположение
Подпись hs.network.configuration:location() -> location
Тип Метод
Описание

Возвращает текущий идентификатор местоположения

Параметры
  • Нет
Возвращаемое значение
  • местоположение - UUID для текущего активного сетевого местоположения
Примечания
  • Вы также можете получить эту информацию в виде пар ключ-значение с помощью hs.network.configuration:contents("Setup:")
  • Если в панели «Сетевые настройки» определены разные местоположения, это можно использовать для определения текущего активного местоположения.
Источник extensions/network/libnetwork_configuration.m строка 397
местоположения
Подпись hs.network.configuration:locations() -> table
Тип Метод
Описание

Возвращает все настроенные местоположения

Параметры
  • Нет
Возвращаемое значение
  • таблица пар ключ-значение, сопоставляющая UUID местоположений с их именами
Источник extensions/network/libnetwork_configuration.m строка 425
отслеживаниеКлючей
Подпись hs.network.configuration:monitorKeys([keys], [pattern]) -> storeObject
Тип Метод
Описание

Укажите ключ(и) или шаблон(ы) ключей для отслеживания изменений.

Параметры
  • keys - строка или таблица строк, содержащая ключи или шаблоны ключей, если pattern равно true. По умолчанию - все ключи.
  • pattern - логическое значение, указывающее, следует ли рассматривать предоставленную(ые) строку(и) как шаблоны регулярных выражений (true) или литеральные строки для соответствия (false). По умолчанию - false.
Возвращаемое значение
  • объект хранилища
Примечания
  • если параметры не указаны, все пары ключ-значение в динамическом хранилище отслеживаются на предмет изменений.
Источник extensions/network/libnetwork_configuration.m строка 572
прокси
Подпись hs.network.configuration:proxies() -> table
Тип Метод
Описание

Возвращает информацию о текущих активных прокси-серверах, если таковые имеются

Параметры
  • Нет
Возвращаемое значение
  • таблица пар ключ-значение, описывающих текущие действующие прокси-серверы, как глобальные, так и ограниченные по определённым интерфейсам.
Примечания
  • Вы также можете получить эту информацию в виде пар ключ-значение с помощью hs.network.configuration:contents("State:/Network/Global/Proxies")
Источник extensions/network/libnetwork_configuration.m строка 461
setCallback
Подпись hs.network.configuration:setCallback(function) -> storeObject
Тип Метод
Описание

Установить или удалить функцию обратного вызова для объекта хранилища

Параметры
  • функция или nil для установки или удаления функции обратного вызова объекта хранилища
Возвращаемое значение
  • объект хранилища
Примечания
  • Функция обратного вызова будет вызываться каждый раз, когда отслеживаемое значение изменяется, и функция обратного вызова должна принимать два параметра: сам объект хранилища и массив ключей, содержащих значения, которые изменились.
  • Этот метод просто устанавливает функцию обратного вызова. Вы указываете, какие ключи наблюдать с помощью hs.network.configuration:monitorKeys, а запуск или остановку наблюдения выполните с помощью hs.network.configuration:start или hs.network.configuration:stop
Источник extensions/network/libnetwork_configuration.m строка 488
setLocation
Подпись hs.network.configuration:setLocation(location) -> boolean
Тип Метод
Описание

Переключается на новое местоположение

Параметры
  • location - строка, содержащая имя или UUID нового местоположения
Возвращаемое значение
  • bool - true, если местоположение было успешно изменено, false в случае ошибки
Источник extensions/network/libnetwork_configuration.m строка 316
start
Подпись hs.network.configuration:start() -> storeObject
Тип Метод
Описание

Начинает отслеживание объекта хранилища на предмет изменений отслеживаемых ключей и вызывает функцию обратного вызова (если она указана) при возникновении изменения.

Параметры
  • Нет
Возвращаемое значение
  • объект хранилища
Примечания
  • Функцию обратного вызова следует указать с помощью hs.network.configuration:setCallback, а ключи для отслеживания — с помощью hs.network.configuration:monitorKeys.
Источник extensions/network/libnetwork_configuration.m строка 523
stop
Подпись hs.network.configuration:stop() -> storeObject
Тип Метод
Описание

Останавливает отслеживание объекта хранилища на предмет изменений.

Параметры
  • Нет
Возвращаемое значение
  • объект хранилища
Источник extensions/network/libnetwork_configuration.m строка 550

© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.network.configuration.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API