DockClick.spoon/docs.json at main · silasbur/DockClick.spoon · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
[
  {
    "Constant" : [

    ],
    "submodules" : [

    ],
    "Function" : [

    ],
    "Variable" : [

    ],
    "stripped_doc" : [

    ],
    "desc" : "Emulates clicking the currently active application in the dock to avoid hunting for app icons.",
    "Deprecated" : [

    ],
    "type" : "Module",
    "Constructor" : [

    ],
    "Field" : [

    ],
    "Method" : [
      {
        "desc" : "Finds and clicks the currently active application in the dock",
        "stripped_doc" : [
          "Finds and clicks the currently active application in the dock",
          ""
        ],
        "def" : "DockClick:clickFrontmost()",
        "doc" : "Finds and clicks the currently active application in the dock\n\nParameters:\n * None\n\nReturns:\n * None\n\nNotes:\n * This method uses accessibility features to interact with the dock\n * The method will match partial application names (e.g., \"Chrome\" matches \"Google Chrome\")\n * If the active application is not found in the dock, nothing happens",
        "notes" : [
          " * This method uses accessibility features to interact with the dock",
          " * The method will match partial application names (e.g., \"Chrome\" matches \"Google Chrome\")",
          " * If the active application is not found in the dock, nothing happens"
        ],
        "signature" : "DockClick:clickFrontmost()",
        "type" : "Method",
        "returns" : [
          " * None",
          ""
        ],
        "name" : "clickFrontmost",
        "parameters" : [
          " * None",
          ""
        ]
      },
      {
        "desc" : "Binds hotkeys for DockClick",
        "stripped_doc" : [
          "Binds hotkeys for DockClick",
          ""
        ],
        "def" : "DockClick:bindHotkeys(mapping)",
        "doc" : "Binds hotkeys for DockClick\n\nParameters:\n * mapping - A table containing hotkey modifier\/key details for the following items:\n  * click - Restore the window of the currently active application by clicking its icon in the dock (default: cmd+alt+w)\n\nReturns:\n * The DockClick object\n\nNotes:\n * If no mapping is provided, the default hotkey (cmd+alt+w) is used\n * Example usage:\n   ```lua\n   spoon.DockClick:bindHotkeys({\n     click = {{\"cmd\", \"alt\"}, \"w\"}\n   })\n   ```",
        "notes" : [
          " * If no mapping is provided, the default hotkey (cmd+alt+w) is used",
          " * Example usage:",
          "   ```lua",
          "   spoon.DockClick:bindHotkeys({",
          "     click = {{\"cmd\", \"alt\"}, \"w\"}",
          "   })",
          "   ```"
        ],
        "signature" : "DockClick:bindHotkeys(mapping)",
        "type" : "Method",
        "returns" : [
          " * The DockClick object",
          ""
        ],
        "name" : "bindHotkeys",
        "parameters" : [
          " * mapping - A table containing hotkey modifier\/key details for the following items:",
          "  * click - Restore the window of the currently active application by clicking its icon in the dock (default: cmd+alt+w)",
          ""
        ]
      },
      {
        "desc" : "Initializes the DockClick spoon",
        "stripped_doc" : [
          "Initializes the DockClick spoon",
          ""
        ],
        "def" : "DockClick:init()",
        "doc" : "Initializes the DockClick spoon\n\nParameters:\n * None\n\nReturns:\n * The DockClick object\n\nNotes:\n * Currently this method does nothing, but is reserved for future use",
        "notes" : [
          " * Currently this method does nothing, but is reserved for future use"
        ],
        "signature" : "DockClick:init()",
        "type" : "Method",
        "returns" : [
          " * The DockClick object",
          ""
        ],
        "name" : "init",
        "parameters" : [
          " * None",
          ""
        ]
      }
    ],
    "Command" : [

    ],
    "items" : [
      {
        "desc" : "Binds hotkeys for DockClick",
        "stripped_doc" : [
          "Binds hotkeys for DockClick",
          ""
        ],
        "def" : "DockClick:bindHotkeys(mapping)",
        "doc" : "Binds hotkeys for DockClick\n\nParameters:\n * mapping - A table containing hotkey modifier\/key details for the following items:\n  * click - Restore the window of the currently active application by clicking its icon in the dock (default: cmd+alt+w)\n\nReturns:\n * The DockClick object\n\nNotes:\n * If no mapping is provided, the default hotkey (cmd+alt+w) is used\n * Example usage:\n   ```lua\n   spoon.DockClick:bindHotkeys({\n     click = {{\"cmd\", \"alt\"}, \"w\"}\n   })\n   ```",
        "notes" : [
          " * If no mapping is provided, the default hotkey (cmd+alt+w) is used",
          " * Example usage:",
          "   ```lua",
          "   spoon.DockClick:bindHotkeys({",
          "     click = {{\"cmd\", \"alt\"}, \"w\"}",
          "   })",
          "   ```"
        ],
        "signature" : "DockClick:bindHotkeys(mapping)",
        "type" : "Method",
        "returns" : [
          " * The DockClick object",
          ""
        ],
        "name" : "bindHotkeys",
        "parameters" : [
          " * mapping - A table containing hotkey modifier\/key details for the following items:",
          "  * click - Restore the window of the currently active application by clicking its icon in the dock (default: cmd+alt+w)",
          ""
        ]
      },
      {
        "desc" : "Finds and clicks the currently active application in the dock",
        "stripped_doc" : [
          "Finds and clicks the currently active application in the dock",
          ""
        ],
        "def" : "DockClick:clickFrontmost()",
        "doc" : "Finds and clicks the currently active application in the dock\n\nParameters:\n * None\n\nReturns:\n * None\n\nNotes:\n * This method uses accessibility features to interact with the dock\n * The method will match partial application names (e.g., \"Chrome\" matches \"Google Chrome\")\n * If the active application is not found in the dock, nothing happens",
        "notes" : [
          " * This method uses accessibility features to interact with the dock",
          " * The method will match partial application names (e.g., \"Chrome\" matches \"Google Chrome\")",
          " * If the active application is not found in the dock, nothing happens"
        ],
        "signature" : "DockClick:clickFrontmost()",
        "type" : "Method",
        "returns" : [
          " * None",
          ""
        ],
        "name" : "clickFrontmost",
        "parameters" : [
          " * None",
          ""
        ]
      },
      {
        "desc" : "Initializes the DockClick spoon",
        "stripped_doc" : [
          "Initializes the DockClick spoon",
          ""
        ],
        "def" : "DockClick:init()",
        "doc" : "Initializes the DockClick spoon\n\nParameters:\n * None\n\nReturns:\n * The DockClick object\n\nNotes:\n * Currently this method does nothing, but is reserved for future use",
        "notes" : [
          " * Currently this method does nothing, but is reserved for future use"
        ],
        "signature" : "DockClick:init()",
        "type" : "Method",
        "returns" : [
          " * The DockClick object",
          ""
        ],
        "name" : "init",
        "parameters" : [
          " * None",
          ""
        ]
      }
    ],
    "doc" : "Emulates clicking the currently active application in the dock to avoid hunting for app icons.\n\nThis spoon is useful for quickly restoring the primary window of the frontmost application\nby simulating a click on its dock icon. This is particularly helpful when you want to bring\nback a closed or hidden window.\n\nDownload: [https:\/\/github.com\/Hammerspoon\/Spoons\/raw\/master\/Spoons\/DockClick.spoon.zip](https:\/\/github.com\/Hammerspoon\/Spoons\/raw\/master\/Spoons\/DockClick.spoon.zip)",
    "name" : "DockClick"
  }
]