1+ /// {@category 10.0/tizen}
2+ library tizen_interop_10_0.appcore_agent;
3+
14// Copyright 2021 Samsung Electronics Co., Ltd. All rights reserved.
25// Use of this source code is governed by a BSD-style license that can be
36// found in the LICENSE file.
@@ -11,6 +14,7 @@ import 'generated_bindings_capi_appfw_app_common.dart' as app_common;
1114import 'generated_bindings_capi_appfw_app_control.dart' as app_control;
1215
1316/// Dart bindings for Tizen appcore-agent APIs.
17+ /// {@category 10.0/tizen}
1418class Tizen100AppcoreAgent {
1519 /// Holds the symbol lookup function.
1620 final ffi.Pointer <T > Function <T extends ffi.NativeType >(String symbolName)
@@ -26,21 +30,37 @@ class Tizen100AppcoreAgent {
2630 lookup)
2731 : _lookup = lookup;
2832
29- /// @brief Adds the system event handler.
30- /// @since_tizen 2.3
31- /// @remarks The service application can handle low memory event, low battery event, language setting changed event and region format changed event.
32- /// @remarks The @a handler should be released using service_app_remove_event_handler().
33- /// @param[out] handler The event handler
34- /// @param[in] event_type The system event type
35- /// @param[in] callback The callback function
36- /// @param[in] user_data The user data to be passed to the callback function
37- /// @return @c 0 on success,
38- /// otherwise a negative error value
39- /// @retval #APP_ERROR_NONE Successful
40- /// @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
41- /// @retval #APP_ERROR_OUT_OF_MEMORY Out of memory
42- /// @par Example
43- /// @code
33+ /// Adds the system event handler.
34+ ///
35+ /// **Since Tizen:**
36+ /// - 2.3
37+ ///
38+ /// **Remarks:**
39+ /// - The service application can handle low memory event, low battery event, language setting changed event and region format changed event.
40+ /// - The `handler` should be released using service_app_remove_event_handler().
41+ ///
42+ /// **Parameters:**
43+ /// - `handler` (out): The event handler
44+ /// - `event_type` (in): The system event type
45+ /// - `callback` (in): The callback function
46+ /// - `user_data` (in): The user data to be passed to the callback function
47+ ///
48+ /// **Returns:**
49+ /// - `0` on success, otherwise a negative error value
50+ ///
51+ /// **Return values:**
52+ /// - `APP_ERROR_NONE` : Successful
53+ /// - `APP_ERROR_INVALID_PARAMETER` : Invalid parameter
54+ /// - `APP_ERROR_OUT_OF_MEMORY` : Out of memory
55+ ///
56+ /// **See also:**
57+ /// - `app_event_type_e`
58+ /// - `app_event_cb()`
59+ /// - `service_app_remove_event_handler()`
60+ ///
61+ /// **Example:**
62+ ///
63+ /// ```
4464 /// #include <service_app.h>
4565 ///
4666 /// static void
@@ -59,10 +79,7 @@ class Tizen100AppcoreAgent {
5979 ///
6080 /// return 0;
6181 /// }
62- /// @endcode
63- /// @see app_event_type_e
64- /// @see app_event_cb()
65- /// @see service_app_remove_event_handler()
82+ /// ```
6683 int service_app_add_event_handler (
6784 ffi.Pointer <app_common.app_event_handler_h> handler,
6885 int event_type,
@@ -89,14 +106,23 @@ class Tizen100AppcoreAgent {
89106 int Function (ffi.Pointer <app_common.app_event_handler_h>, int ,
90107 app_common.app_event_cb, ffi.Pointer <ffi.Void >)> ();
91108
92- /// @brief Removes registered event handler.
93- /// @since_tizen 2.3
94- /// @param[in] event_handler The event handler
95- /// @return @c 0 on success,
96- /// otherwise a negative error value
97- /// @retval #APP_ERROR_NONE Successful
98- /// @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
99- /// @see service_app_add_event_handler()
109+ /// Removes registered event handler.
110+ ///
111+ /// **Since Tizen:**
112+ /// - 2.3
113+ ///
114+ /// **Parameters:**
115+ /// - `event_handler` (in): The event handler
116+ ///
117+ /// **Returns:**
118+ /// - `0` on success, otherwise a negative error value
119+ ///
120+ /// **Return values:**
121+ /// - `APP_ERROR_NONE` : Successful
122+ /// - `APP_ERROR_INVALID_PARAMETER` : Invalid parameter
123+ ///
124+ /// **See also:**
125+ /// - `service_app_add_event_handler()`
100126 int service_app_remove_event_handler (
101127 app_common.app_event_handler_h event_handler,
102128 ) {
@@ -112,25 +138,34 @@ class Tizen100AppcoreAgent {
112138 _service_app_remove_event_handlerPtr
113139 .asFunction< int Function (app_common.app_event_handler_h)> ();
114140
115- /// @brief Runs the main loop of the application until service_app_exit() is called.
116- /// @details This function is the main entry point of the Tizen service application.
117- /// This main loop supports event handling for the GMainLoop and the Ecore Main Loop.
118- /// @since_tizen 2.3
119- /// @param[in] argc The argument count
120- /// @param[in] argv The argument vector
121- /// @param[in] callback The set of callback functions to handle application events
122- /// @param[in] user_data The user data to be passed to the callback functions
123- /// @return @c 0 on success,
124- /// otherwise a negative error value.
125- /// @retval #APP_ERROR_NONE Successful
126- /// @retval #APP_ERROR_INVALID_PARAMETER Invalid parameter
127- /// @retval #APP_ERROR_INVALID_CONTEXT The application is launched illegally, not launched by the launch system.
128- /// @retval #APP_ERROR_ALREADY_RUNNING The main loop has already started
129- /// @see service_app_create_cb()
130- /// @see service_app_terminate_cb()
131- /// @see service_app_control_cb()
132- /// @see service_app_exit()
133- /// @see #service_app_lifecycle_callback_s
141+ /// Runs the main loop of the application until service_app_exit() is called.
142+ ///
143+ /// This function is the main entry point of the Tizen service application. This main loop supports event handling for the GMainLoop and the Ecore Main Loop.
144+ ///
145+ /// **Since Tizen:**
146+ /// - 2.3
147+ ///
148+ /// **Parameters:**
149+ /// - `argc` (in): The argument count
150+ /// - `argv` (in): The argument vector
151+ /// - `callback` (in): The set of callback functions to handle application events
152+ /// - `user_data` (in): The user data to be passed to the callback functions
153+ ///
154+ /// **Returns:**
155+ /// - `0` on success, otherwise a negative error value.
156+ ///
157+ /// **Return values:**
158+ /// - `APP_ERROR_NONE` : Successful
159+ /// - `APP_ERROR_INVALID_PARAMETER` : Invalid parameter
160+ /// - `APP_ERROR_INVALID_CONTEXT` : The application is launched illegally, not launched by the launch system.
161+ /// - `APP_ERROR_ALREADY_RUNNING` : The main loop has already started
162+ ///
163+ /// **See also:**
164+ /// - `service_app_create_cb()`
165+ /// - `service_app_terminate_cb()`
166+ /// - `service_app_control_cb()`
167+ /// - `service_app_exit()`
168+ /// - `service_app_lifecycle_callback_s`
134169 int service_app_main (
135170 int argc,
136171 ffi.Pointer <ffi.Pointer <ffi.Char >> argv,
@@ -159,11 +194,16 @@ class Tizen100AppcoreAgent {
159194 ffi.Pointer <service_app_lifecycle_callback_s>,
160195 ffi.Pointer <ffi.Void >)> ();
161196
162- /// @brief Exits the main loop of the application.
163- /// @details The main loop of the application stops and service_app_terminate_cb() is invoked.
164- /// @since_tizen 2.3
165- /// @see service_app_main()
166- /// @see service_app_terminate_cb()
197+ /// Exits the main loop of the application.
198+ ///
199+ /// The main loop of the application stops and service_app_terminate_cb() is invoked.
200+ ///
201+ /// **Since Tizen:**
202+ /// - 2.3
203+ ///
204+ /// **See also:**
205+ /// - `service_app_main()`
206+ /// - `service_app_terminate_cb()`
167207 void service_app_exit () {
168208 return _service_app_exit ();
169209 }
@@ -174,13 +214,19 @@ class Tizen100AppcoreAgent {
174214 _service_app_exitPtr.asFunction< void Function ()> ();
175215}
176216
177- /// @brief The structure type containing the set of callback functions for handling application events.
178- /// @details It is one of the input parameters of the service_app_efl_main() function.
179- /// @since_tizen 2.3
180- /// @see service_app_main()
181- /// @see service_app_create_cb()
182- /// @see service_app_terminate_cb()
183- /// @see service_app_control_cb()
217+ /// The structure type containing the set of callback functions for handling application events.
218+ ///
219+ /// It is one of the input parameters of the service_app_efl_main() function.
220+ ///
221+ /// **Since Tizen:**
222+ /// - 2.3
223+ ///
224+ /// **See also:**
225+ /// - `service_app_main()`
226+ /// - `service_app_create_cb()`
227+ /// - `service_app_terminate_cb()`
228+ /// - `service_app_control_cb()`
229+ /// @nodoc
184230final class service_app_lifecycle_callback_s extends ffi.Struct {
185231 /// < This callback function is called at the start of the application.
186232 external service_app_create_cb create;
@@ -192,49 +238,82 @@ final class service_app_lifecycle_callback_s extends ffi.Struct {
192238 external service_app_control_cb app_control;
193239}
194240
195- /// @brief Called at the start of the agent application.
196- /// @since_tizen 2.3
197- /// @param[in] user_data The user data passed from the callback registration function
198- /// @return @c true on success,
199- /// otherwise @c false
200- /// @pre service_app_main() will invoke this callback function.
201- /// @see service_app_main()
202- /// @see #service_app_lifecycle_callback_s
241+ /// Called at the start of the agent application.
242+ ///
243+ /// **Since Tizen:**
244+ /// - 2.3
245+ ///
246+ /// **Parameters:**
247+ /// - `user_data` (in): The user data passed from the callback registration function
248+ ///
249+ /// **Returns:**
250+ /// - `true` on success, otherwise `false`
251+ ///
252+ /// **Preconditions:**
253+ /// - service_app_main() will invoke this callback function.
254+ ///
255+ /// **See also:**
256+ /// - `service_app_main()`
257+ /// - `service_app_lifecycle_callback_s`
258+ /// @nodoc
203259typedef service_app_create_cb
204260 = ffi.Pointer <ffi.NativeFunction <service_app_create_cbFunction>>;
261+ /// @nodoc
205262typedef service_app_create_cbFunction = ffi.Bool Function (
206263 ffi.Pointer <ffi.Void > user_data);
264+ /// @nodoc
207265typedef Dartservice_app_create_cbFunction = bool Function (
208266 ffi.Pointer <ffi.Void > user_data);
209267
210- /// @brief Called once after the main loop of the agent application exits.
211- /// @since_tizen 2.3
212- /// @param[in] user_data The user data passed from the callback registration function
213- /// @see service_app_main()
214- /// @see #service_app_lifecycle_callback_s
268+ /// Called once after the main loop of the agent application exits.
269+ ///
270+ /// **Since Tizen:**
271+ /// - 2.3
272+ ///
273+ /// **Parameters:**
274+ /// - `user_data` (in): The user data passed from the callback registration function
275+ ///
276+ /// **See also:**
277+ /// - `service_app_main()`
278+ /// - `service_app_lifecycle_callback_s`
279+ /// @nodoc
215280typedef service_app_terminate_cb
216281 = ffi.Pointer <ffi.NativeFunction <service_app_terminate_cbFunction>>;
282+ /// @nodoc
217283typedef service_app_terminate_cbFunction = ffi.Void Function (
218284 ffi.Pointer <ffi.Void > user_data);
285+ /// @nodoc
219286typedef Dartservice_app_terminate_cbFunction = void Function (
220287 ffi.Pointer <ffi.Void > user_data);
221288
222- /// @brief Called when another application sends the launch request to the agent application.
223- /// @since_tizen 2.3
224- /// @param[in] app_control The handle to the app_control
225- /// @param[in] user_data The user data passed from the callback registration function
226- /// @see service_app_main()
227- /// @see #service_app_lifecycle_callback_s
228- /// @see @ref CAPI_APP_CONTROL_MODULE API
289+ /// Called when another application sends the launch request to the agent application.
290+ ///
291+ /// **Since Tizen:**
292+ /// - 2.3
293+ ///
294+ /// **Parameters:**
295+ /// - `app_control` (in): The handle to the app_control
296+ /// - `user_data` (in): The user data passed from the callback registration function
297+ ///
298+ /// **See also:**
299+ /// - `service_app_main()`
300+ /// - `service_app_lifecycle_callback_s`
301+ /// - `CAPI_APP_CONTROL_MODULE` API
302+ /// @nodoc
229303typedef service_app_control_cb
230304 = ffi.Pointer <ffi.NativeFunction <service_app_control_cbFunction>>;
305+ /// @nodoc
231306typedef service_app_control_cbFunction = ffi.Void Function (
232307 app_control.app_control_h app_control, ffi.Pointer <ffi.Void > user_data);
308+ /// @nodoc
233309typedef Dartservice_app_control_cbFunction = void Function (
234310 app_control.app_control_h app_control, ffi.Pointer <ffi.Void > user_data);
235311
236- /// @brief Enumeration for system events.
237- /// @since_tizen 2.3
312+ /// Enumeration for system events.
313+ ///
314+ /// **Since Tizen:**
315+ /// - 2.3
316+ /// @nodoc
238317abstract class _app_event_type_e {
239318 /// < The low memory event
240319 static const int APP_EVENT_LOW_MEMORY = 0 ;
@@ -252,7 +331,9 @@ abstract class _app_event_type_e {
252331 static const int APP_EVENT_REGION_FORMAT_CHANGED = 4 ;
253332
254333 /// < The suspended state changed event of the application (since 2.4)
255- /// @see app_event_get_suspended_state()
334+ ///
335+ /// **See also:**
336+ /// - `app_event_get_suspended_state()`
256337 static const int APP_EVENT_SUSPENDED_STATE_CHANGED = 5 ;
257338
258339 /// < The update requested event (Since 3.0)
0 commit comments