-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.json
134 lines (118 loc) · 5.62 KB
/
docs.json
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
[
{
"Constant" : [
],
"submodules" : [
],
"Function" : [
],
"Variable" : [
{
"name" : "apiKey",
"stripped_doc" : [
"A \"personal access token\" for Asana. You can create one here: https:\/\/app.asana.com\/0\/developer-console"
],
"doc" : "A \"personal access token\" for Asana. You can create one here: https:\/\/app.asana.com\/0\/developer-console",
"parameters" : [
],
"notes" : [
],
"signature" : "Asana.apiKey (String)",
"type" : "Variable",
"returns" : [
],
"desc" : "A \"personal access token\" for Asana. You can create one here: https:\/\/app.asana.com\/0\/developer-console",
"def" : "Asana.apiKey (String)"
}
],
"stripped_doc" : [
],
"desc" : "Simple spoon that creates a new task in Asana with a given name in a given workspace.",
"Deprecated" : [
],
"type" : "Module",
"Constructor" : [
],
"doc" : "Simple spoon that creates a new task in Asana with a given name in a given workspace.\n\nExample configuration (using SpoonInstall.spoon and Seal.spoon):\n```\n-- Load configuration constants used throughout the code\nconsts = require \"configConsts\" -- just a table\n\n-- Load Asana spoon and configure it with API key\nspoon.SpoonInstall:andUse(\"Asana\", { config = { apiKey = consts.asanaApiKey } })\n\n-- Load Seal and setup user actions to add task to Asana workspaces\nspoon.SpoonInstall:andUse(\n \"Seal\",\n {\n fn = function(x)\n x:loadPlugins({\"apps\", \"calc\", \"useractions\", \"rot13\"})\n x.plugins.useractions.actions = {\n [\"New Asana task in \" .. consts.asanaWorkWorkspaceName] = {\n fn = function(y) spoon.Asana:createTask(y, consts.asanaWorkWorkspaceName) end,\n keyword = \"awork\"\n },\n [\"New Asana task in \" .. consts.asanaPersonalWorkspaceName] = {\n fn = function(y) spoon.Asana:createTask(y, consts.asanaPersonalWorkspaceName) end,\n keyword = \"ahome\"\n }\n }\n x:refreshAllCommands()\n end,\n start = true,\n hotkeys = { toggle = { \"cmd\", \"space\" } }\n }\n)\n```\n\nWith this setup, adding a new task to Asana is as easy pressing `Command + Space` to launch Seal and entering, e.g., \"awork Do that thing I forgot to do\".",
"Method" : [
{
"name" : "createTask",
"stripped_doc" : [
"Creates a new task named `taskName` in the workspace `workspaceName`.",
"",
"Example:",
"```",
"spoon.Asana.createTask(\"Do that thing I forgot about\", \"My Company Workspace\")",
"```",
""
],
"doc" : "Creates a new task named `taskName` in the workspace `workspaceName`.\n\nExample:\n```\nspoon.Asana.createTask(\"Do that thing I forgot about\", \"My Company Workspace\")\n```\n\nParameters:\n * taskName (String) - The title of the Asana task.\n * WorkspaceName (String) - The name of the workspace in which to create the task.\n\nReturns:\n * Self",
"parameters" : [
" * taskName (String) - The title of the Asana task.",
" * WorkspaceName (String) - The name of the workspace in which to create the task.",
""
],
"notes" : [
],
"signature" : "Asana:createTask(taskName, workspaceName) -> Self",
"type" : "Method",
"returns" : [
" * Self"
],
"desc" : "Creates a new task named `taskName` in the workspace `workspaceName`.",
"def" : "Asana:createTask(taskName, workspaceName) -> Self"
}
],
"Command" : [
],
"Field" : [
],
"items" : [
{
"name" : "apiKey",
"stripped_doc" : [
"A \"personal access token\" for Asana. You can create one here: https:\/\/app.asana.com\/0\/developer-console"
],
"doc" : "A \"personal access token\" for Asana. You can create one here: https:\/\/app.asana.com\/0\/developer-console",
"parameters" : [
],
"notes" : [
],
"signature" : "Asana.apiKey (String)",
"type" : "Variable",
"returns" : [
],
"desc" : "A \"personal access token\" for Asana. You can create one here: https:\/\/app.asana.com\/0\/developer-console",
"def" : "Asana.apiKey (String)"
},
{
"name" : "createTask",
"stripped_doc" : [
"Creates a new task named `taskName` in the workspace `workspaceName`.",
"",
"Example:",
"```",
"spoon.Asana.createTask(\"Do that thing I forgot about\", \"My Company Workspace\")",
"```",
""
],
"doc" : "Creates a new task named `taskName` in the workspace `workspaceName`.\n\nExample:\n```\nspoon.Asana.createTask(\"Do that thing I forgot about\", \"My Company Workspace\")\n```\n\nParameters:\n * taskName (String) - The title of the Asana task.\n * WorkspaceName (String) - The name of the workspace in which to create the task.\n\nReturns:\n * Self",
"parameters" : [
" * taskName (String) - The title of the Asana task.",
" * WorkspaceName (String) - The name of the workspace in which to create the task.",
""
],
"notes" : [
],
"signature" : "Asana:createTask(taskName, workspaceName) -> Self",
"type" : "Method",
"returns" : [
" * Self"
],
"desc" : "Creates a new task named `taskName` in the workspace `workspaceName`.",
"def" : "Asana:createTask(taskName, workspaceName) -> Self"
}
],
"name" : "Asana"
}
]