[dbus] add overload 'value' for custom dbus property types
[profile/ivi/automotive-message-broker.git] / plugins / dbus / fakeidlheader.h
1 #ifndef _FAKEIDLHEADER_H_
2 #define _FAKEIDLHEADER_H_
3
4 /** @module Vehicle **/
5
6 /** @moduleComment
7 *
8 * Details.
9 *
10 * \def-api-feature http://tizen.org/api/vehicle
11 * \brief Allows access to the vehicle API
12 *
13 **/
14
15 /** @interface Navigator
16  *  @interfaceType partial **/
17  /**
18   * @attributeName vehicle
19   * @type Vehicle
20   * @access readonly
21 } **/
22
23 /** @interface VehiclePropertyType **/
24 /** @attributeName timeStamp
25  *  @type Date
26  *  @access readonly
27 **/
28
29 /** @raw callback VehiclePropertyCallback = void (VehiclePropertyType value); **/
30
31 /** @raw callback VehiclePropertyErrorCallback = void (VehiclePropertyError error); **/
32
33 /** @raw callback VehiclePropertyListCallback = void (sequence<VehiclePropertyType> values); **/
34
35 /** @interface VehiclePropertyError 
36 *
37 *    @enum const unsigned short PERMISSION_DENIED = 1;
38 *    @enum const unsigned short PROPERTY_UNAVAILABLE = 2;
39 *    @enum const unsigned short TIMEOUT = 3;
40 *
41 *    @attributeName code
42 *    @type unsigned short
43 *    @access readonly
44 *    @attributeComment MUST return error code.
45 *
46 *    @attributeName message
47 *    @type DOMString
48 *    @access readonly
49 *    @attributeComment MUST return error message
50 **/
51
52 /** @interface Vehicle **/
53 /** @method sequence<DOMString> getSupported();
54  *  @methodComment \brief returns supported properties
55  *  @method get(DOMString property, VehiclePropertyCallback successCallback, optional VehiclePropertyErrorCallback errorCallback);
56  *  @methodComment \brief fetch the current value for 'property'.
57  *  @methodComment \arg DOMString property is the property
58  *  @methodComment \arg VehiclePropertyCallback successCallback function to be called when method has completed successfully
59  *  @methodComment \arg VehiclePropertyErrorCallback this function is called when an error has occured.
60  *  @method set(DOMString property, VehiclePropertyType value, optional SuccessCallback successCallback, optional VehiclePropertyErrorCallback errorCallback);
61  *  @methodComment \brief set the given property to value
62  *  @methodComment \arg DOMString property property to set
63  *  @methodComment \arg VehiclePropertyType value value to set
64  *  @methodComment \arg SuccessCallback successCallback callback if operation is successfull
65  *  @methodComment \arg VehiclePropertyErrorCallback errorCallback callback if error has been called.
66  *  @method getHistory(DOMString property, Date startTime, Date endTime, VehiclePropertyListCallback successCallback, optional VehiclePropertyErrorCallback errorCallback);
67  *  @methodComment \brief get values for a given property within a certain past time period between 'startTime' and 'endTime'
68  *  @methodComment \arg DOMString property property to request
69  *  @methodComment \arg Date startTime, starting period of time.
70  *  @methodComment \arg Date endTime, ending period of time.
71  *  @methodComment \arg VehiclePropertyListCallback successCallback. Callback with the result of the method call
72  *  @methodComment \arg VehiclePropertyErrorCallback errorCallback. Callback if an error has occurred.
73  **/
74
75
76 #endif