This sub-module is used to access results to a spotlightObject query which have been grouped by one or more attribute values.
A spotlightGroupObject is a special object created when you specify one or more grouping attributes with hs.spotlight:groupingAttributes. Spotlight items which match the Spotlight query and share a common value for the specified attribute will be grouped in objects you can retrieve with the hs.spotlight:groupedResults method. This method returns an array of spotlightGroupObjects.
For each spotlightGroupObject you can identify the attribute and value the grouping represents with the hs.spotlight.group:attribute and hs.spotlight.group:value methods. An array of the results which belong to the group can be retrieved with the hs.spotlight.group:resultAtIndex method. For convenience, metamethods have been added to the spotlightGroupObject which make accessing individual results easier: an individual spotlightItemObject may be accessed from a spotlightGroupObject by treating the spotlightGroupObject like an array; e.g. spotlightGroupObject[n]
will access the n'th spotlightItemObject in the grouped results.
Signature | hs.spotlight.group:attribute() -> string |
---|---|
Type | Method |
Description |
Returns the name of the attribute the spotlightGroupObject results are grouped by. |
Parameters |
|
Returns |
|
Source | extensions/spotlight/libspotlight.m line 686 |
Signature | hs.spotlight.group:count() -> integer |
---|---|
Type | Method |
Description |
Returns the number of query results contained in the spotlightGroupObject. |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/spotlight/libspotlight.m line 722 |
Signature | hs.spotlight.group:resultAtIndex(index) -> spotlightItemObject |
---|---|
Type | Method |
Description |
Returns the spotlightItemObject at the specified index of the spotlightGroupObject |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/spotlight/libspotlight.m line 743 |
Signature | hs.spotlight.group:subgroups() -> table |
---|---|
Type | Method |
Description |
Returns the subgroups of the spotlightGroupObject |
Parameters |
|
Returns |
|
Notes |
|
Source | extensions/spotlight/libspotlight.m line 774 |
Signature | hs.spotlight.group:value() -> value |
---|---|
Type | Method |
Description |
Returns the value for the attribute the spotlightGroupObject results are grouped by. |
Parameters |
|
Returns |
|
Source | extensions/spotlight/libspotlight.m line 704 |
© 2014–2017 Hammerspoon contributors
Licensed under the MIT License.
https://www.hammerspoon.org/docs/hs.spotlight.group.html