hs.spotlight.group

Этот подмодуль используется для доступа к результатам запроса spotlightObject, сгруппированным по одному или нескольким значениям атрибутов.

spotlightGroupObject — это специальный объект, создаваемый, когда вы указываете один или несколько атрибутов группировки с помощью hs.spotlight:groupingAttributes. Элементы spotlight, которые соответствуют запросу Spotlight и имеют общее значение для указанного атрибута, будут сгруппированы в объекты, которые можно получить с помощью метода hs.spotlight:groupedResults. Этот метод возвращает массив spotlightGroupObjects.

Для каждого spotlightGroupObject вы можете определить атрибут и значение, которые представляют группировку, с помощью методов hs.spotlight.group:attribute и hs.spotlight.group:value. Массив результатов, относящихся к группе, можно получить с помощью метода hs.spotlight.group:resultAtIndex. Для удобства были добавлены метаметоды к spotlightGroupObject, которые упрощают доступ к отдельным результатам: отдельный объект spotlightItemObject может быть получен из spotlightGroupObject, рассматривая spotlightGroupObject как массив; например, spotlightGroupObject[n] даст доступ к n-му spotlightItemObject в сгруппированных результатах.

Обзор API

Методы — вызовы API, которые могут быть выполнены только на объекте, возвращённом конструктором

attribute
count
resultAtIndex
subgroups
value

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

Методы

attribute

Подпись	`hs.spotlight.group:attribute() -> string`
Тип	Метод
Описание	Возвращает имя атрибута, по которому сгруппированы результаты spotlightGroupObject.
Параметры	Нет
Возвращает	имя атрибута в виде строки
Источник	extensions/spotlight/libspotlight.m строка 686

count

Подпись	`hs.spotlight.group:count() -> integer`
Тип	Метод
Описание	Возвращает количество результатов запроса, содержащихся в spotlightGroupObject.
Параметры	Нет
Возвращает	целое число, указывающее количество результатов, соответствующих атрибуту и значению, представленному этим объектом spotlightGroup.
Примечания	Для удобства были добавлены метаметоды к spotlightGroupObject, которые позволяют использовать `#spotlightGroupObject` в качестве сокращения для `spotlightGroupObject:count()`.
Источник	extensions/spotlight/libspotlight.m строка 722

resultAtIndex

Подпись	`hs.spotlight.group:resultAtIndex(index) -> spotlightItemObject`
Тип	Метод
Описание	Возвращает spotlightItemObject по указанному индексу spotlightGroupObject.
Параметры	`index` — целое число, определяющее индекс возвращаемого результата.
Возвращает	spotlightItemObject по указанному индексу или ошибку, если индекс вне границ.
Примечания	Для удобства были добавлены метаметоды к spotlightGroupObject, которые позволяют использовать `spotlightGroupObject[index]` в качестве сокращения для `spotlightGroupObject:resultAtIndex(index)`.
Источник	extensions/spotlight/libspotlight.m строка 743

subgroups

Подпись	`hs.spotlight.group:subgroups() -> table`
Тип	Метод
Описание	Возвращает подгруппы spotlightGroupObject.
Параметры	Нет
Возвращает	таблицу массивов, содержащую подгруппы spotlightGroupObject, или nil, если подгрупп нет.
Примечания	Подгруппы создаются, когда вы предоставляете более одного атрибута группировки в `hs.spotlight:groupingAttributes`.
Источник	extensions/spotlight/libspotlight.m строка 774

value

Подпись	`hs.spotlight.group:value() -> value`
Тип	Метод
Описание	Возвращает значение атрибута, по которому сгруппированы результаты spotlightGroupObject.
Параметры	Нет
Возвращает	значение атрибута как соответствующего типа данных
Источник	extensions/spotlight/libspotlight.m строка 704

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