Add a new definition for component-based application
[platform/core/appfw/aul-1.git] / include / aul_key.h
1 /*
2  * Copyright (c) 2019 Samsung Electronics Co., Ltd. All rights reserved.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #pragma once
18
19 /**
20  * @brief Definition for AUL: The process ID of the caller.
21  * @since_tizen 2.2
22  */
23 #define AUL_K_CALLER_PID                "__AUL_CALLER_PID__"
24
25 /**
26  * @brief Definition for AUL: The process ID of the callee.
27  * @since_tizen 2.2
28  */
29 #define AUL_K_CALLEE_PID                "__AUL_CALLEE_PID__"
30
31 /**
32  * @brief Definition for AUL: The user ID of the caller.
33  * @since_tizen 3.0
34  */
35 #define AUL_K_CALLER_UID                "__AUL_CALLER_UID__"
36
37 /**
38  * @brief Definition for AUL: The user ID of the callee.
39  * @since_tizen 3.0
40  */
41 #define AUL_K_CALLEE_UID                "__AUL_CALLEE_UID__"
42
43 /**
44  * @brief Definition for AUL: The user ID of the taget user.
45  * @since_tizen 3.0
46  */
47 #define AUL_K_TARGET_UID                "__AUL_TARGET_UID__"
48
49 /**
50  * @brief Definition for AUL: The application ID of the caller.
51  * @since_tizen 2.2
52  */
53 #define AUL_K_CALLER_APPID              "__AUL_CALLER_APPID__"
54
55 /**
56  * @brief Definitnon for AUL: The application ID of the callee.
57  * @since_tizen 2.2
58  */
59 #define AUL_K_CALLEE_APPID              "__AUL_CALLEE_APPID__"
60
61 /**
62  * @deprecated Deprecated since 3.0
63  * @brief Definition for AUL: The first argument.
64  * @since_tizen 2.2
65  */
66 #define AUL_K_ARGV0                     "__AUL_ARGV0__"
67
68 /**
69  * @brief Definition for AUL: The start time.
70  * @since_tizen 2.2
71  */
72 #define AUL_K_STARTTIME                 "__AUL_STARTTIME__"
73
74 /**
75  * @brief Definition for AUL: The MIME-Type data.
76  * @since_tizen 2.2
77  */
78 #define AUL_K_MIME_TYPE                 "__AUL_MIME_TYPE__"
79
80 /**
81  * @brief Definition for AUL: The unaliased MIME-Type data.
82  * @since_tizen 2.2
83  */
84 #define AUL_K_UNALIASED_MIME_TYPE       "__AUL_UNALIASED_MIME_TYPE__"
85
86 /**
87  * @brief Definition for AUL: The content of the MIME-Type data.
88  * @since_tizen 2.2
89  */
90 #define AUL_K_MIME_CONTENT              "__AUL_MIME_CONTENT__"
91
92 /**
93  * @brief Definition for AUL: The service name.
94  * @since_tizen 2.2
95  */
96 #define AUL_K_SERVICE_NAME              "__AUL_SERVICE_NAME__"
97
98 /**
99  * @brief Definition for AUL: The flag if it's 'true', the app-selector is launched forcedly.
100  * @since_tizen 2.2
101  */
102 #define AUL_K_FORCE_LAUNCH_APP_SELECTOR "__AUL_FORCE_LAUNCH_APP_SELECTOR__"
103
104 /**
105  * @brief Definition for AUL: The flag if it's set, the request is for debugging web-applications.
106  * @since_tizen 3.0
107  */
108 #define AUL_K_DEBUG                     "__AUL_DEBUG__"
109
110 /**
111  * @brief Definition for AUL: The SDK data.
112  * @since_tizen 2.3
113  */
114 #define AUL_K_SDK                       "__AUL_SDK__"
115
116 /**
117  * @deprecated Deprecated since 3.0
118  * @brief Definition for AUL: The multiple key.
119  * @since_tizen 2.3
120  */
121 #define AUL_K_MULTI_KEY                 "__AUL_MULTI_KEY__"
122
123 /**
124  * @deprecated Deprecated since 3.0
125  * @brief Definition for AUL: The multiple key event.
126  * @since_tizen 2.3
127  */
128 #define AUL_K_MULTI_KEY_EVENT           "__AUL_MULTI_KEY_EVENT__"
129
130 /**
131  * @brief Definition for AUL: The privacy application ID.
132  * @since_tizen 2.3
133  */
134 #define AUL_K_PRIVACY_APPID             "__AUL_PRIVACY_APPID__"
135
136 /**
137  * @deprecased Deprecated since tizen 3.0
138  * @brief Definition for AUL: The key pressed event.
139  * @since_tizen 2.3
140  */
141 #define AUL_V_KEY_PRESSED               "__AUL_KEY_PRESSED__"
142
143 /**
144  * @deprecased Deprecated since tizen 3.0
145  * @brief Definition for AUL: The key released event.
146  * @since_tizen 2.3
147  */
148 #define AUL_V_KEY_RELEASED              "__AUL_KEY_RELEASED__"
149
150 /**
151  * @brief Definition for RUA: The caller information.
152  * @since_tizen 3.0
153  */
154 #define AUL_SVC_K_RUA_STAT_CALLER       "__K_RUA_STAT_CALLER__"
155
156 /**
157  * @brief Definition for RUA: The tag information.
158  * @since_tizen 3.0
159  */
160 #define AUL_SVC_K_RUA_STAT_TAG          "__K_RUA_STAT_TAG__"
161
162 /**
163  * @brief Definition for RUA: The application ID.
164  * @since_tizen 3.0
165  */
166 #define AUL_K_RUA_PKGNAME               "__K_RUA_PKGNAME"
167
168 /**
169  * @brief Definition for RUA: The application path.
170  * @since_tizen 3.0
171  */
172 #define AUL_K_RUA_APPPATH               "__K_RUA_APPPATH"
173
174 /**
175  * @brief Definition for RUA: The arguments.
176  * @since_tizen 3.0
177  */
178 #define AUL_K_RUA_ARG                   "__K_RUA_ARG"
179
180 /**
181  * @brief Definition for RUA: The launched time.
182  * @since_tizen 3.0
183  */
184 #define AUL_K_RUA_TIME                  "__K_RUA_TIME"
185
186 /**
187  * @brief Definition for RUA: The instance ID.
188  * @since_tizen 3.0
189  */
190 #define AUL_K_RUA_INSTANCE_ID           "__K_RUA_INSTANCE_ID"
191
192 /**
193  * @brief Definition for RUA: The instance name.
194  * @since_tizen 3.0
195  */
196 #define AUL_K_RUA_INSTANCE_NAME         "__K_RUA_INSTANCE_NAME"
197
198 /**
199  * @brief Definition for RUA: The icon path.
200  * @since_tizen 3.0
201  */
202 #define AUL_K_RUA_ICON                  "__K_RUA_ICON"
203
204 /**
205  * @brief Definition for RUA: The URI data.
206  * @since_tizen 3.0
207  */
208 #define AUL_K_RUA_URI                   "__K_RUA_URI"
209
210 /**
211  * @brief Definition for AUL: The application ID.
212  * @since_tizen 2.2
213  */
214 #define AUL_K_PKG_NAME                  "__AUL_PKG_NAME__"
215
216 /**
217  * @brief Definition for AUL: The flag if it's 'true', the caller process waits to get the result from the callee application.
218  * @since_tizen 2.2
219  */
220 #define AUL_K_WAIT_RESULT               "__AUL_WAIT_RESULT__"
221
222 /**
223  * @brief Definition for AUL: The flag if it's 'true', the request is for sending the result.
224  * @since_tizen 2.2
225  */
226 #define AUL_K_SEND_RESULT               "__AUL_SEND_RESULT__"
227
228 /**
229  * @brief Definition for AUL: The taskmanage value.
230  * @since_tizen 2.2
231  */
232 #define AUL_K_TASK_MANAGE               "__AUL_TASK_MANAGE__"
233
234 /**
235  * @brief Definition for AUL: The application type.
236  * @since_tizen 2.2
237  */
238 #define AUL_K_APP_TYPE                  "__AUL_APP_TYPE__"
239
240 /**
241  * @brief Definition for AUL: The process ID of the original caller.
242  * @since_tizen 2.2
243  */
244 #define AUL_K_ORG_CALLER_PID            "__AUL_ORG_CALLER_PID__"
245
246 /**
247  * @brief Definition for AUL: The process ID of the forwarded callee.
248  * @since_tizen 2.2
249  */
250 #define AUL_K_FWD_CALLEE_PID            "__AUL_FWD_CALLEE_PID__"
251
252 /**
253  * @brief Definition for AUL: The flag if it's 'true', the request is not cancelled.
254  * @since_tizen 2.2
255  */
256 #define AUL_K_NO_CANCEL                 "__AUL_NO_CANCEL__"
257
258 /**
259  * @brief Definition for AUL: The executable file path.
260  * @since_tizen 2.2
261  */
262 #define AUL_K_EXEC                      "__AUL_EXEC__"
263
264 /**
265  * @brief Definition for AUL: The flag if it's 'true', the application can be launched by multiple processes.
266  * @since_tizen 2.2
267  */
268 #define AUL_K_MULTIPLE                  "__AUL_MULTIPLE__"
269
270 /**
271  * @brief Definition for AUL: The type of the package.
272  * @since_tizen 2.2
273  */
274 #define AUL_K_PACKAGETYPE               "__AUL_PACKAGETYPE__"
275
276 /**
277  * @brief Definition for AUL: The flag if it's 'true', the application uses hardware-acceleration.
278  * @since_tizen 2.2
279  */
280 #define AUL_K_HWACC                     "__AUL_HWACC__"
281
282 /**
283  * @brief Definition for AUL: The application ID.
284  * @since_tizen 2.2
285  */
286 #define AUL_K_APPID                     "__AUL_APPID__"
287
288 /**
289  * @brief Definition for AUL: The process ID.
290  * @since_tizen 2.2
291  */
292 #define AUL_K_PID                       "__AUL_PID__"
293
294 /**
295  * @brief Definition for AUL: The window ID.
296  * @since_tizen 2.4
297  */
298 #define AUL_K_WID                       "__AUL_WID__"
299
300 /**
301  * @breif Definition for AUL: The process ID of the leader process.
302  * @since_tizen 2.4
303  */
304 #define AUL_K_LEADER_PID                "__AUL_LEADER_PID__"
305
306 /**
307  * @brief Definition for Data-Control: The type of data-control.
308  * @since_tizen 2.2
309  */
310 #define AUL_K_DATA_CONTROL_TYPE         "__AUL_DATA_CONTROL_TYPE__"
311
312 /**
313  * @brief Definition for AUL: The package ID.
314  * @since_tizen 2.2
315  */
316 #define AUL_K_PKGID                     "__AUL_PKGID_"
317
318 /**
319  * @deprecated Deprecated since 3.0
320  * @brief Definition for AUL: The flag if it's 'true', the application can be launched by internal process-pool.
321  * @since_tizen 2.2
322  */
323 #define AUL_K_INTERNAL_POOL             "__AUL_INTERNAL_POOL__"
324
325 /**
326  * @brief Definition for AUL: The TEP resource path.
327  * @since_tizen 2.4
328  */
329 #define AUL_K_TEP_PATH                  "__AUL_TEP_PATH__"
330
331 /**
332  * @brief Definition for AUL: The component type.
333  * @since_tizen 2.2
334  */
335 #define AUL_K_COMP_TYPE                 "__AUL_COMP_TYPE__"
336
337 /**
338  * @brief Definition for AUL: The loader ID.
339  * @since_tizen 3.0
340  */
341 #define AUL_K_LOADER_ID                 "__AUL_LOADER_ID__"
342
343 /**
344  * @brief Definition for AUL: The executable file path of the loader.
345  * @since_tizen 3.0
346  */
347 #define AUL_K_LOADER_PATH               "__AUL_LOADER_PATH__"
348
349 /**
350  * @brief Definition for AUL: The extra data of the loader.
351  * @since_tizen 3.0
352  */
353 #define AUL_K_LOADER_EXTRA              "__AUL_LOADER_EXTRA__"
354
355 /**
356  * @brief Definition for AUL: The loader name.
357  * @since_tizen 3.0
358  */
359 #define AUL_K_LOADER_NAME               "__AUL_LOADER_NAME__"
360
361 /**
362  * @brief Definition for AUL: The wayland display.
363  * @since_tizen 3.0
364  */
365 #define AUL_K_WAYLAND_DISPLAY           "__AUL_WAYLAND_DISPLAY__"
366
367 /**
368  * @brief Definition for AUL: The wayland working directory path.
369  * @since_tizen 3.0
370  */
371 #define AUL_K_WAYLAND_WORKING_DIR       "__AUL_WAYLAND_WORKING_DIR__"
372
373 /**
374  * @brief Definition for AUL: The sender process ID of app-com.
375  * @since_tizen 3.0
376  */
377 #define AUL_K_COM_SENDER_PID            "__AUL_COM_SENDER_PID__"
378
379 /**
380  * @brief Definition for AUL: The endpoint of app-com.
381  * @since_tizen 3.0
382  */
383 #define AUL_K_COM_ENDPOINT              "__AUL_COM_ENDPOINT__"
384
385 /**
386  * @brief Definition for AUL: The privilege of app-com.
387  * @since_tizen 3.0
388  */
389 #define AUL_K_COM_PRIVILEGE             "__AUL_COM_PRIVILEGE__"
390
391 /**
392  * @brief Definition for AUL: The propagate information of app-com.
393  * @since_tizen 3.0
394  */
395 #define AUL_K_COM_PROPAGATE             "__AUL_COM_PROPAGATE__"
396
397 /**
398  * @brief Definition for AUL: The filter of app-com.
399  * @since_tizen 3.0
400  */
401 #define AUL_K_COM_FILTER                "__AUL_COM_FILTER__"
402
403 /**
404  * @brief Definition for AUL: The result of app-com.
405  * @since_tizen 3.0
406  */
407 #define AUL_K_COM_RESULT                "__AUL_COM_RESULT__"
408
409 /**
410  * @brief Definition for AUL: The root path.
411  * @since_tizen 3.0
412  */
413 #define AUL_K_ROOT_PATH                 "__AUL_ROOT_PATH__"
414
415 /**
416  * @brief Definition for AUL: The sequence number.
417  * @since_tizen 3.0
418  */
419 #define AUL_K_SEQ_NUM                   "__AUL_SEQ_NUM__"
420
421 /**
422  * @brief Definition for AUL: The API version.
423  * @since_tizen 3.0
424  */
425 #define AUL_K_API_VERSION               "__AUL_API_VERSION__"
426
427 /**
428  * @brief Definition for AUL: The flag if it's 'true', the application can be running in the background.
429  * @since_tizen 2.4
430  */
431 #define AUL_K_ALLOWED_BG                "__AUL_ALLOWED_BG__"
432
433 /**
434  * @brief Definition for AUL: The owner process ID of app-group.
435  * @since_tizen 2.4
436  */
437 #define AUL_K_OWNER_PID                 "__AUL_OWNER_PID__"
438
439 /**
440  * @brief Definition for AUL: The child process ID of app-group.
441  * @since_tizen 2.4
442  */
443 #define AUL_K_CHILD_PID                 "__AUL_CHILD_PID__"
444
445 /**
446  * @brief Definition for Widget: The widget viewer.
447  * @since_tizen 3.0
448  */
449 #define AUL_K_WIDGET_VIEWER             "__AUL_WIDGET_VIEWER__"
450
451 /**
452  * @brief Definition for Widget: The widget ID.
453  * @since_tizen 3.0
454  */
455 #define AUL_K_WIDGET_ID                 "__AUL_WIDGET_ID__"
456
457 /**
458  * @brief Definition for Widget: The instance ID of the widget.
459  * @since_tizen 3.0
460  */
461 #define AUL_K_WIDGET_INSTANCE_ID        "__AUL_WIDGET_INSTANCE_ID__"
462
463 /**
464  * @brief Definition for Widget: The status of the widget.
465  * @since_tizen 3.0
466  */
467 #define AUL_K_WIDGET_STATUS             "__AUL_WIDGET_STATUS__"
468
469 /**
470  * @brief Definition for Widget: The error code of the widget.
471  * @since_tizen 3.0
472  */
473 #define AUL_K_WIDGET_ERROR_CODE         "__AUL_WIDGET_ERROR_CODE__"
474
475 /**
476  * @brief Definition for Widget: The widget content infomation.
477  * @since_tizen 3.0
478  */
479 #define AUL_K_WIDGET_CONTENT_INFO       "__AUL_WIDGET_CONTENT_INFO__"
480
481 /**
482  * @brief Definition for AUL: The target process ID.
483  * @since_tizen 3.0
484  */
485 #define AUL_K_TARGET_PID                "__AUL_TARGET_PID__"
486
487 /**
488  * @brief Definition for AUL: The alias application ID.
489  * @since_tizen 3.0
490  */
491 #define AUL_K_ALIAS_APPID               "__AUL_ALIAS_APPID__"
492
493 /**
494  * @brief Definition for AUL: The original application ID.
495  * @since_tizen 3.0
496  */
497 #define AUL_K_ORG_APPID                 "__AUL_ORG_APPID__"
498
499 /**
500  * @brief Definition for AUL: The status value.
501  * @since_tizen 3.0
502  */
503 #define AUL_K_STATUS                    "__AUL_STATUS__"
504
505 /**
506  * @brief Definition for AUL: The flag if it's 'true', the application is launched by sub-application of app-group.
507  * @since_tizen 2.4
508  */
509 #define AUL_K_IS_SUBAPP                 "__AUL_IS_SUBAPP__"
510
511 /**
512  * @brief Definition for AUL: The instance ID.
513  * @since_tizen 4.0
514  */
515 #define AUL_K_INSTANCE_ID               "__AUL_INSTANCE_ID__"
516
517 /**
518  * @brief Definition for AUL: The user ID of the original caller.
519  * @since_tizen 3.0
520  */
521 #define AUL_K_ORG_CALLER_UID            "__AUL_ORG_CALLER_UID__"
522
523 /**
524  * @brief Definition for AUL: The checksum data to store app-control information.
525  * @details This definition is to improve the launch performance.
526  * @since_tizen 3.0
527  */
528 #define AUL_K_CHECKSUM                  "__AUL_CHECKSUM__"
529
530 /**
531  * @brief Definition for Screen-Connector: The flag if it's 'true', the request type is private.
532  * @since_tizen 3.0
533  */
534 #define AUL_K_PRIVATE                   "__AUL_PRIVATE__"
535
536 /**
537  * @brief Definition for Screen-Connector: The screen type.
538  * @since_tizen 3.0
539  */
540 #define AUL_K_SCREEN_TYPE               "__AUL_SCREEN_TYPE__"
541
542 /**
543  * @brief Definition for Screen-Connector: The reference count of the viewer.
544  * @since_tizen 3.0
545  */
546 #define AUL_K_VIEWER_REF                "__AUL_VIEWER_REF__"
547
548 /**
549  * @brief Definition for AUL: The application ID of the parent for transient-for.
550  * @since_tizen 3.0
551  */
552 #define AUL_K_PARENT_APPID              "__AUL_PARENT_APPID__"
553
554 /**
555  * @brief Definition for AUL: The application ID of the child for transient-for.
556  * @since_tizen 3.0
557  */
558 #define AUL_K_CHILD_APPID               "__AUL_CHILD_APPID__"
559
560 /**
561  * @deprecated Deprecated since 4.0
562  * @brief Definition for AUL: The flag if it's 'true', the request is for fast launch.
563  * @since_tizen 3.0
564  */
565 #define AUL_K_FAST_LAUNCH               "__AUL_FAST_LAUNCH__"
566
567 /**
568  * @brief Definition for Widget: The flag if it's 'true', the widget is faulted.
569  * @since_tizen 3.0
570  */
571 #define AUL_K_IS_FAULT                  "__AUL_IS_FAULT__"
572
573 /**
574  * @brief Definition for AUL: The profile.
575  * @since_tizen 3.0
576  */
577 #define AUL_K_PROFILE                   "__AUL_PROFILE__"
578
579 /**
580  * @brief Definition for AUL: The flag if it's 'true', the application is installed for global user.
581  * @since_tizen 3.0
582  */
583 #define AUL_K_IS_GLOBAL                 "__AUL_IS_GLOBAL__"
584
585 /**
586  * @brief Definition for AUL: The flag if it's 'true', the request is to create a new instance.
587  * @since_tizen 3.0
588  */
589 #define AUL_K_NEW_INSTANCE              "__AUL_NEW_INSTANCE__"
590
591 /**
592  * @brief Definition for AUL: The flag if it's 'true', the application is installed.
593  * @since_tizen 3.0
594  */
595 #define AUL_K_IS_INSTALLED              "__AUL_IS_INSTALLED__"
596
597 /**
598  * @brief Definition for AUL: The request type.
599  * @details This key is only for Application Manager.
600  * @since_tizen 4.0
601  */
602 #define AUL_K_REQUEST_TYPE              "__AUL_REQUEST_TYPE__"
603
604 /**
605  * @brief Definition for AUL: The application ID of the original caller.
606  * @since_tizen 3.0
607  */
608 #define AUL_K_ORG_CALLER_APPID          "__AUL_ORG_CALLER_APPID__"
609
610 /**
611  * @brief Definition for AUL: The package ID of the original caller.
612  * @since_tizen 3.0
613  */
614 #define AUL_K_ORG_CALLER_PKGID          "__AUL_ORG_CALLER_PKGID__"
615
616 /**
617  * @brief Definition for AUL: The installed storage.
618  * @since_tizen 2.4
619  */
620 #define AUL_K_INSTALLED_STORAGE         "__AUL_INSTALLED_STORAGE__"
621
622 /**
623  * @brief Definition for AUL: The component ID.
624  * @since_tizen 5.5
625  */
626 #define AUL_K_COMPONENT_ID              "__AUL_COMPONENT_ID__"