To get the information of installed widgets.

Required Header

#include <widget_service.h> #include <widget_errno.h>

Related Features

This API is related with the following feature:

http://tizen.org/feature/shell.appwidget

Overview

1. widget service API

Tizen supports various kinds of API set for retrieving information of widgets. Every widgets are installed via package manager utilities. The information of installed widgets are stored in the system DB.

In some cases, application developer needs to send update request to some widgets. To make it possible, this module provides related API set. But the API will only works if the widget and application are packaged in one.

1.1 APIs for retrieving information of widgets

To get the information for installed widgets.

1.2 APIs for communicating with running widget instances

To trigger the update event or send the updated content string to the widget.

2. Size of widget

Widget has predefined size types. 1x1 is a square so its pixel size of width and height must has to be same. 2x2, 4x4 also sqaure.

2x1, 4x1, 4x2, 4x3 is a rectangle. so its pixel size of width & height should not be same. pixel size of width should be long than height.

Pixel size can be differ between different devices. It depends on its screen resolution.

So widget developer should care various kinds of devices (has different screen resolution).

Size Type	Size in pixels	Supported profile
WIDGET_SIZE_TYPE_1x1	- (SQUARE, depends on screen resolution)	No profile - This size type is not used. just defined for specifying a default cell size
WIDGET_SIZE_TYPE_2x1	- (RECTANGLE, depends on screen resolution)	Mobile
WIDGET_SIZE_TYPE_2x2	- (SQUARE, depends on screen resolution)	Mobile, Wearable (Default size)
WIDGET_SIZE_TYPE_4x1	- (RECTANGLE, depends on screen resolution)	Mobile
WIDGET_SIZE_TYPE_4x2	- (RECTANGLE, depends on screen resolution)	Mobile
WIDGET_SIZE_TYPE_4x3	- (RECTANGLE, depends on screen resolution)	Mobile
WIDGET_SIZE_TYPE_4x4	- (SQUARE, depends on screen resolution)	Mobile

Widget also works for Easy Mode. For the Easy Mode, there are different size types. Called WIDGET_SIZE_TYPE_EASY_NxM

Size Type	Size in pixels	Supported profile
WIDGET_SIZE_TYPE_EASY_1x1	- (SQUARE, depends on screen resolution)	Mobile
WIDGET_SIZE_TYPE_EASY_3x1	- (RECTANGLE, depends on screen resolution)	Mobile
WIDGET_SIZE_TYPE_EASY_3x3	- (SQARE - depends on screen resolution)	Mobile

However the Easy Mode is not a mandatory requirements for viewer application development. So you will not be able to create your widgets using Easy Mode size types. But if you are developing the homescreen(or application which is related with widgets displaying), You should care these types too.

Functions
int	widget_service_get_size (widget_size_type_e type, int width, int height)
	Gets the pixel size of given size type.
int	widget_service_get_size_type (int width, int height, widget_size_type_e *size_type)
	Gets the size type for given pixel size.
int	widget_service_get_need_of_mouse_event (const char widget_id, widget_size_type_e size_type, bool need_of_mouse_event)
	Gets the need of mouse event for the given widget.
int	widget_service_get_need_of_touch_effect (const char widget_id, widget_size_type_e size_type, bool need_of_touch_event)
	Gets the need of touch effect for the given widget.
int	widget_service_get_need_of_frame (const char widget_id, widget_size_type_e size_type, bool need_of_frame)
	Gets the need of decoration frame for the given widget.
int	widget_service_trigger_update (const char widget_id, const char instance_id, bundle *b, int force)
	Triggers the update event for given widget instance.
int	widget_service_change_period (const char widget_id, const char instance_id, double period)
	Changes the update period of given widget instance.
int	widget_service_get_widget_list (widget_list_cb cb, void *data)
	Gets a list of all widgets.
char *	widget_service_get_main_app_id (const char *widget_id)
	Gets the MAIN application Id of given widget package Id.
int	widget_service_get_widget_list_by_pkgid (const char pkgid, widget_list_by_pkgid_cb cb, void data)
	Gets a list of widgets included in the given package id.
char *	widget_service_get_widget_id (const char *id)
	Gets the id of a widget by the given id of package or UI app. If there are two or more widgets in the package, this function returns the id of the primary widget.
char *	widget_service_get_app_id_of_setup_app (const char *widget_id)
	Gets the appId of setup app which is specified by given widget Id's manifest.
char *	widget_service_get_package_id (const char *widget_id)
	Gets the package id of the given widget.
char *	widget_service_get_name (const char widget_id, const char lang)
	Gets the name of the given widget.
char *	widget_service_get_preview_image_path (const char *widget_id, widget_size_type_e size_type)
	Gets the preview image path of given size type.
char *	widget_service_get_icon (const char pkgid, const char lang)
	Gets icon path of given widget package.
int	widget_service_get_nodisplay (const char *widget_id)
	Gets the "nodisplay" value.
int	widget_service_get_supported_sizes (const char widget_id, int cnt, int w, int h)
	Gets the supported size list.
int	widget_service_get_supported_size_types (const char widget_id, int cnt, int **types)
	Gets the supported size list of given widget id.
int	widget_service_get_widget_instance_list (const char widget_id, widget_instance_list_cb cb, void data)
	Gets widget instances of given widget_id.
int	widget_service_set_lifecycle_event_cb (const char widget_id, widget_lifecycle_event_cb cb, void data)
	Registers event handler callback function for life-cycle events of widgets.
int	widget_service_unset_lifecycle_event_cb (const char widget_id, void *user_data)
	Unregisters event handler callback function for life-cycle events of widgets.
int	widget_service_get_content_of_widget_instance (const char widget_id, const char widget_instance_id, bundle **b)
	Gets content of the widget instance.
Typedefs
typedef enum widget_error	widget_error_e
	Enumeration for the result status of widget operation.
typedef enum widget_event_type	widget_event_type_e
	Enumeration for widget event type.
typedef enum widget_size_type	widget_size_type_e
	Enumeration for list of supporting widget size types.
typedef int(*	widget_list_cb )(const char pkgid, const char widget_id, int is_prime, void *data)
	Callback function for getting result of widget_service_get_widget_list.
typedef int(*	widget_list_by_pkgid_cb )(const char widget_id, int is_prime, void data)
	Callback function for getting result of widget_service_get_widget_list_by_pkgid.
typedef int(*	widget_instance_list_cb )(const char widget_id, const char instance_id, void *data)
	Callback function for getting result of widget_service_get_widget_instance_list.
typedef enum widget_lifecycle_event	widget_lifecycle_event_e
	Enumerations for life cycle event of widgets.
typedef int(*	widget_lifecycle_event_cb )(const char widget_id, widget_lifecycle_event_e lifecycle_event, const char widget_instance_id, void *data)
	Called when a widget is created or destroyed.

Typedef Documentation

typedef enum widget_error widget_error_e

Enumeration for the result status of widget operation.

Since :: 2.3.1

typedef enum widget_event_type widget_event_type_e

Enumeration for widget event type.

These events will be sent from the provider.

Since :: 2.3.1

typedef int(* widget_instance_list_cb)(const char *widget_id, const char *instance_id, void *data)

Callback function for getting result of widget_service_get_widget_instance_list.

Since :: 2.3.1

Parameters:

[in]	widget_id	widget app id
[in]	widget_instance_id	widget instance id
[in]	data	user data

Returns:: WIDGET_ERROR_NONE to continue with the next iteration of the loop, other error values to break out of the loop

See also:: widget_service_get_widget_instance_list

typedef int(* widget_lifecycle_event_cb)(const char *widget_id, widget_lifecycle_event_e lifecycle_event, const char *widget_instance_id, void *data)

Called when a widget is created or destroyed.

Since :: 2.3.1

Parameters:

[in]	widget_id	appid of widget application
[in]	lifecycle_event	type of event
[in]	widget_instance_id	widget instance id
[in]	data	user data

Returns:: 0 on success, otherwise a negative error value

See also:: widget_service_set_lifecycle_event_cb

typedef enum widget_lifecycle_event widget_lifecycle_event_e

Enumerations for life cycle event of widgets.

Since :: 2.3.1

See also:: widget_lifecycle_event_cb

typedef int(* widget_list_by_pkgid_cb)(const char *widget_id, int is_prime, void *data)

Callback function for getting result of widget_service_get_widget_list_by_pkgid.

Since :: 2.3.1

Parameters:

[in]	widget_id	appid of widget application
[in]	is_prime	will be sent as 1 if the widget is a default widget
[in]	data	user data

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: WIDGET_ERROR_NONE to continue with the next iteration of the loop, other error values to break out of the loop

See also:: widget_service_get_widget_list_by_pkgid

typedef int(* widget_list_cb)(const char *pkgid, const char *widget_id, int is_prime, void *data)

Callback function for getting result of widget_service_get_widget_list.

Since :: 2.3.1

Parameters:

[in]	pkgid	package id
[in]	widget_id	appid of widget application
[in]	is_prime	will be sent as 1 if the widget is a default widget
[in]	data	user data

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: WIDGET_ERROR_NONE to continue with the next iteration of the loop, other error values to break out of the loop

See also:: widget_service_get_widget_list

typedef enum widget_size_type widget_size_type_e

Enumeration for list of supporting widget size types.

Since :: 2.3.1

Enumeration Type Documentation

enum widget_error

Enumeration for the result status of widget operation.

Since :: 2.3.1

Enumerator:

WIDGET_ERROR_NONE	Operation is successfully completed
WIDGET_ERROR_INVALID_PARAMETER	Invalid function parameter
WIDGET_ERROR_OUT_OF_MEMORY	Out of memory
WIDGET_ERROR_RESOURCE_BUSY	Device or resource busy
WIDGET_ERROR_PERMISSION_DENIED	Permission denied
WIDGET_ERROR_CANCELED	Operation Canceled
WIDGET_ERROR_IO_ERROR	I/O error
WIDGET_ERROR_TIMED_OUT	Time out
WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_FILE_NO_SPACE_ON_DEVICE	No space left on device
WIDGET_ERROR_FAULT	Fault - Unable to recover from the error
WIDGET_ERROR_ALREADY_EXIST	Already exists
WIDGET_ERROR_ALREADY_STARTED	Operation is already started
WIDGET_ERROR_NOT_EXIST	Not exists
WIDGET_ERROR_DISABLED	Disabled

enum widget_event_type

Enumeration for widget event type.

These events will be sent from the provider.

Since :: 2.3.1

Enumerator:

WIDGET_EVENT_WIDGET_UPDATED	Contents of the given widget is updated
WIDGET_EVENT_WIDGET_EXTRA_UPDATED	Extra buffer is updated (N'th buffering)
WIDGET_EVENT_CREATED	A new widget is created
WIDGET_EVENT_DELETED	A widget is deleted
WIDGET_EVENT_PERIOD_CHANGED	Update period is changed
WIDGET_EVENT_WIDGET_SIZE_CHANGED	widget size is changed
WIDGET_EVENT_EXTRA_INFO_UPDATED	Extra information is updated
WIDGET_EVENT_IGNORED	Request is ignored

enum widget_lifecycle_event

Enumerations for life cycle event of widgets.

Since :: 2.3.1

See also:: widget_lifecycle_event_cb

Enumerator:

WIDGET_LIFE_CYCLE_EVENT_CREATE	The widget is created
WIDGET_LIFE_CYCLE_EVENT_DESTROY	The widget is destroyed
WIDGET_LIFE_CYCLE_EVENT_PAUSE	The widget is paused
WIDGET_LIFE_CYCLE_EVENT_RESUME	The widget is resumed

enum widget_size_type

Enumeration for list of supporting widget size types.

Since :: 2.3.1

Enumerator:

WIDGET_SIZE_TYPE_1x1	175x175 based on 720x1280 resolution
WIDGET_SIZE_TYPE_2x1	354x175 based on 720x1280 resolution
WIDGET_SIZE_TYPE_2x2	354x354 based on 720x1280 resolution
WIDGET_SIZE_TYPE_4x1	712x175 based on 720x1280 resolution
WIDGET_SIZE_TYPE_4x2	712x354 based on 720x1280 resolution
WIDGET_SIZE_TYPE_4x3	712x533 based on 720x1280 resolution
WIDGET_SIZE_TYPE_4x4	712x712 based on 720x1280 resolution
WIDGET_SIZE_TYPE_4x5	712x891 based on 720x1280 resolution
WIDGET_SIZE_TYPE_4x6	712x1070 based on 720x1280 resolution
WIDGET_SIZE_TYPE_EASY_1x1	224x215 based on 720x1280 resolution
WIDGET_SIZE_TYPE_EASY_3x1	680x215 based on 720x1280 resolution
WIDGET_SIZE_TYPE_EASY_3x3	680x653 based on 720x1280 resolution
WIDGET_SIZE_TYPE_FULL	720x1280 based on 720x1280 resolution
WIDGET_SIZE_TYPE_UNKNOWN	Error case

Function Documentation

int widget_service_change_period	(	const char *	widget_id,
		const char *	instance_id,
		double	period
	)

Changes the update period of given widget instance.

Since :: 2.3.1

Parameters:

[in]	widget_id	appid of widget application
[in]	instance_id	widget instance id
[in]	period	New update period in sec

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NONE	Successfully changed(requested)
WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_FAULT	Failed to create a request packet
WIDGET_ERROR_OUT_OF_MEMORY	Not enough memory
WIDGET_ERROR_PERMISSION_DENIED	Permission denied

char* widget_service_get_app_id_of_setup_app ( const char * widget_id )

Gets the appId of setup app which is specified by given widget Id's manifest.

This setup app should be launched before adding the widget to get the content_info.
This function should be called before add a widget.
To determine the content information string.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Remarks:: Result string should be freed by free()

Parameters:

[in] widget_id appid of widget application

Returns:: char * type

Return values:

@c	NULL There is no setup application or error occurred, you can check it using get_last_result()
appid	AppId if exists or `NULL`

Postcondition:: Returned string must be freed manually.

See also:: get_last_result()

int widget_service_get_content_of_widget_instance	(	const char *	widget_id,
		const char *	widget_instance_id,
		bundle **	b
	)

Gets content of the widget instance.

Since :: 2.3.1

Parameters:

[in]	widget_id	appid of widget application
[in]	widget_instance_id	widget instance id
[out]	b	bundle(content) data of the given widget instance, it should be released by caller.

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_OUT_OF_MEMORY	Memory is not enough to make request
WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_NOT_EXIST	Instance is not exist
WIDGET_ERROR_FAULT	Failed to create a request packet
WIDGET_ERROR_PERMISSION_DENIED	Permission denied
WIDGET_ERROR_NONE	Successfully done

Postcondition:: caller should have to release the bundle

char* widget_service_get_icon	(	const char *	pkgid,
		const char *	lang
	)

Gets icon path of given widget package.

The user should free the returned string with free().

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Remarks:: Result string should be freed by free()

Parameters:

[in]	pkgid	package id of widget application
[in]	lang	Locale(en-us, ko-kr, ...), if it is `NULL`, function will use the system locale automatically

Returns:: char * type

Return values:

name	Allocated heap address
@c	NULL Fails to get path of an icon, get_last_result() will returns reason of failure if it fails.

Postcondition:: Returned string must be freed manually.

See also:: widget_service_get_name; widget_service_get_preview_image_path

char* widget_service_get_main_app_id ( const char * widget_id )

Gets the MAIN application Id of given widget package Id.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Remarks:: Result string should be freed by free()

Parameters:

[in] widget_id appid of widget application

Returns:: char * type

Return values:

@c	NULL If it fails to get main application Id (UI-APPID), get_last_result() will returns reason of failure.
appid	Main application Id

See also:: get_last_result

char* widget_service_get_name	(	const char *	widget_id,
		const char *	lang
	)

Gets the name of the given widget.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Remarks:: Result string should be freed by free()

Parameters:

[in]	widget_id	appid of widget application
[in]	lang	Locale(en-us, ko-kr, ...), if it is `NULL`, function will use the system locale automatically

Returns:: char * type

Return values:

name	If it fails to get name
@c	NULL Allocated heap address, get_last_result() will returns reason of failure if it fails.

Postcondition:: Returned string must be freed by manually.

See also:: widget_service_i18n_icon(); widget_service_preview()

int widget_service_get_need_of_frame	(	const char *	widget_id,
		widget_size_type_e	size_type,
		bool *	need_of_frame
	)

Gets the need of decoration frame for the given widget.

This API gets the need of decoration frame for the given widget from database.
The value of the need of touch effect means...
true : the viewer should make decoration frame on outside of the widget. false : no need to make decoration frame.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Parameters:

[in]	widget_id	appid of widget application
[in]	size_type	Size type
[out]	need_of_frame	the need of decoration frame

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid parameter was given.
WIDGET_ERROR_FAULT	SQL error occurs
WIDGET_ERROR_NOT_EXIST	Frame not exist
WIDGET_ERROR_PERMISSION_DENIED	Permission denied
WIDGET_ERROR_NONE	Successfully done

See also:: widget_service_get_need_of_mouse_event(); widget_service_get_need_of_touch_effect()

int widget_service_get_need_of_mouse_event	(	const char *	widget_id,
		widget_size_type_e	size_type,
		bool *	need_of_mouse_event
	)

Gets the need of mouse event for the given widget.

This function gets need of mouse event for the given widget from database.
The value of mouse event requirement means...
true : The widget requires mouse event. A viewer must has to feed the mouse event to the widget instance
false : The widget doesn't require mouse event.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Parameters:

[in]	widget_id	appid of widget application
[in]	size_type	widget size type
[out]	need_of_mouse_event	the need of mouse event

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid parameter was given.
WIDGET_ERROR_FAULT	SQL error occurs
WIDGET_ERROR_PERMISSION_DENIED	Permission denied
WIDGET_ERROR_NONE	Successfully done

See also:: widget_size_type_e; widget_service_get_need_of_touch_effect(); widget_service_get_need_of_frame()

int widget_service_get_need_of_touch_effect	(	const char *	widget_id,
		widget_size_type_e	size_type,
		bool *	need_of_touch_event
	)

Gets the need of touch effect for the given widget.

This API gets the need of touch effect for the given widget from database.
The value of the need of touch effect means...
true : A viewer is required to make the touch effect when a user click the widget, but it is just recommendation.
false : A viewer is not required to make the touch effect, the box will make touch effect itself.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Parameters:

[in]	widget_id	appid of widget application
[in]	size_type	Size type
[out]	need_of_touch_event	the need of touch effect

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid parameter was given.
WIDGET_ERROR_FAULT	SQL error occurs
WIDGET_ERROR_PERMISSION_DENIED	Permission denied
WIDGET_ERROR_NONE	Successfully done

See also:: widget_size_type_e; widget_service_get_need_of_mouse_event(); widget_service_get_need_of_frame()

int widget_service_get_nodisplay ( const char * widget_id )

Gets the "nodisplay" value.

Since :: 2.3.1

Privilege:: http://tizen.org/privilege/widget.viewer

Parameters:

[in] widget_id Appid of widget application

Privilege Level:: public

Returns:: The "nodisplay" value of given widget

Return values:

1	The box should not be listed by the widget list app
0	Box should be listed, get_last_result() will returns reason of failure if it fails

Precondition:: Widget tag includes "nodisplay" attribute

char* widget_service_get_package_id ( const char * widget_id )

Gets the package id of the given widget.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Remarks:: Result string should be freed by free()

Parameters:

[in] widget_id appid of widget application

Returns:: char * type

Return values:

appid	String which is allocated in the heap
@c	NULL Invalid appid, get_last_result() will returns reason of failure if it fails.

Postcondition:: Returned string must be freed manually.

See also:: widget_service_widget_id()

char* widget_service_get_preview_image_path	(	const char *	widget_id,
		widget_size_type_e	size_type
	)

Gets the preview image path of given size type.

This function will return the preview image path.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Remarks:: Result string should be freed by free()

Parameters:

[in]	widget_id	appid of widget application
[in]	size_type	widget size type

Returns:: char * type

Return values:

path	Preview image path
@c	NULL There is no preview image file, get_last_result() will returns reason of failure if it fails.

Postcondition:: Returned string must be freed manually.

See also:: widget_service_get_icon; widget_service_get_name

int widget_service_get_size	(	widget_size_type_e	type,
		int *	width,
		int *	height
	)

Gets the pixel size of given size type.

Size types would be
WIDGET_SIZE_TYPE_1x1
WIDGET_SIZE_TYPE_2x1
WIDGET_SIZE_TYPE_2x2
WIDGET_SIZE_TYPE_4x1
WIDGET_SIZE_TYPE_4x2
WIDGET_SIZE_TYPE_4x3
WIDGET_SIZE_TYPE_4x4
WIDGET_SIZE_TYPE_4x5
WIDGET_SIZE_TYPE_4x6
WIDGET_SIZE_TYPE_FULL
WIDGET_SIZE_TYPE_EASY_1x1
WIDGET_SIZE_TYPE_EASY_3x1
WIDGET_SIZE_TYPE_EASY_3x3.

Since :: 2.3.1

Parameters:

[in]	type	Size type
[out]	width	Pixel size width
[out]	height	Pixel size height

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid parameter was given.
WIDGET_ERROR_NONE	Successfully done

See also:: widget_size_type(); widget_service_get_size_type()

int widget_service_get_size_type	(	int	width,
		int	height,
		widget_size_type_e *	size_type
	)

Gets the size type for given pixel size.

Returnable size types are
WIDGET_SIZE_TYPE_1x1
WIDGET_SIZE_TYPE_2x1
WIDGET_SIZE_TYPE_2x2
WIDGET_SIZE_TYPE_4x1
WIDGET_SIZE_TYPE_4x2
WIDGET_SIZE_TYPE_4x3
WIDGET_SIZE_TYPE_4x4
WIDGET_SIZE_TYPE_4x5
WIDGET_SIZE_TYPE_4x6
WIDGET_SIZE_TYPE_FULL
WIDGET_SIZE_TYPE_EASY_1x1
WIDGET_SIZE_TYPE_EASY_3x1
WIDGET_SIZE_TYPE_EASY_3x3
or
WIDGET_SIZE_TYPE_UNKNOWN for error.

Since :: 2.3.1

Parameters:

[in]	width	Pixel size width
[in]	height	Pixel size height
[out]	size_type	Widget size type

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid parameter was given.
WIDGET_ERROR_NONE	Successfully done

See also:: widget_size_type(); widget_service_get_size()

int widget_service_get_supported_size_types	(	const char *	widget_id,
		int *	cnt,
		int **	types
	)

Gets the supported size list of given widget id.

Since :: 2.3.1

Parameters:

[in]	widget_id	appid of widget application
[in,out]	cnt	Count you want to get/Result count of types array
[out]	types	Array of types

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_IO_ERROR	Failed to access DB
WIDGET_ERROR_NONE	Successfully done
WIDGET_ERROR_PERMISSION_DENIED	Permission denied

See also:: widget_service_get_supported_sizes()

int widget_service_get_supported_sizes	(	const char *	widget_id,
		int *	cnt,
		int **	w,
		int **	h
	)

Gets the supported size list.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Parameters:

[in]	widget_id	appid of widget application
[in,out]	cnt	Count you want to get/Result count of array w and h
[out]	w	Width array
[out]	h	Height array

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NONE	If succeed to get supported size list
WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_NOT_EXIST	Not exist
WIDGET_ERROR_IO_ERROR	Failed to access DB
WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_PERMISSION_DENIED	Permission denied

See also:: widget_service_get_supported_size_types()

char* widget_service_get_widget_id ( const char * id )

Gets the id of a widget by the given id of package or UI app. If there are two or more widgets in the package, this function returns the id of the primary widget.

Since :: 2.3.1

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Remarks:: Result string should be freed by free()

Parameters:

[in] id Package Id or UI App Id

Returns:: char * type

Return values:

@c	NULL Failed to get primary widget id, get_last_result() will returns reason of failure.
widget_id	Primary widget Id.

Precondition:: Must be released returned string by manually.

See also:: widget_service_package_id()

int widget_service_get_widget_instance_list	(	const char *	widget_id,
		widget_instance_list_cb	cb,
		void *	data
	)

Gets widget instances of given widget_id.

Since :: 2.3.1

Parameters:

[in]	widget_id	appid of widget application
[in]	cb	Callback function
[in]	data	user data for callback function

Returns:: Negative error value on fail, otherwise count of instances

Return values:

WIDGET_ERROR_NOT_EXIST	Instance is not exist
WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_FAULT	Failed to create a request packet
WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_PERMISSION_DENIED	Permission denied

See also:: widget_instance_list_cb

int widget_service_get_widget_list	(	widget_list_cb	cb,
		void *	data
	)

Gets a list of all widgets.

Since :: 2.3.1

Parameters:

[in]	cb	Callback function
[in]	data	user data for callback function

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: Negative error value on fail, otherwise count of widget

Return values:

WIDGET_ERROR_NOT_EXIST	Widget not exist
WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_PERMISSION_DENIED	Permission denied

See also:: widget_service_get_widget_list_by_pkgid; widget_list_cb

int widget_service_get_widget_list_by_pkgid	(	const char *	pkgid,
		widget_list_by_pkgid_cb	cb,
		void *	data
	)

Gets a list of widgets included in the given package id.

Since :: 2.3.1

Parameters:

[in]	pkgid	Package Id (Not the UI App Id)
[in]	cb	Callback function
[in]	data	Callback data

Privilege Level:: public

Privilege:: http://tizen.org/privilege/widget.viewer

Returns:: Negative error value on fail, otherwise count of widget packages

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_IO_ERROR	Failed to access DB
WIDGET_ERROR_PERMISSION_DENIED	Permission denied

See also:: widget_service_get_widget_list; widget_list_by_pkgid_cb

int widget_service_set_lifecycle_event_cb	(	const char *	widget_id,
		widget_lifecycle_event_cb	cb,
		void *	data
	)

Registers event handler callback function for life-cycle events of widgets.

Since :: 2.3.1

Privilege Level:: public

Parameters:

[in]	widget_id	appid of widget application
[in]	cb	Callback function
[in]	data	user data

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_OUT_OF_MEMORY	Memory is not enough to make request
WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_ALREADY_EXIST	Callback already exist
WIDGET_ERROR_NONE	Successfully done

See also:: widget_lifecycle_event_cb; widget_service_unset_lifecycle_event_cb

int widget_service_trigger_update	(	const char *	widget_id,
		const char *	instance_id,
		bundle *	b,
		int	force
	)

Triggers the update event for given widget instance.

Since :: 2.3.1

Parameters:

[in]	widget_id	appid of widget application
[in]	instance_id	Set `NULL` if you don't know what the Id is. Then every instance of given pkgname will be triggered its update event
[in]	b	bundle data will be passed to the widget application via widget_update handler, default is `NULL`
[in]	force	1 if you want to update your widget even if the provider is paused or 0. 0 is default

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_INVALID_PARAMETER	Invalid argument
WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_CANCELED	Provider is paused, so this update request is cancelled.(ignored), if you want to make update forcedly, use force=1
WIDGET_ERROR_OUT_OF_MEMORY	Memory is not enough to make request
WIDGET_ERROR_FAULT	Failed to create a request packet
WIDGET_ERROR_PERMISSION_DENIED	Permission denied
WIDGET_ERROR_NONE	Successfully requested

See also:: widget_service_trigger_update()

int widget_service_unset_lifecycle_event_cb	(	const char *	widget_id,
		void **	user_data
	)

Unregisters event handler callback function for life-cycle events of widgets.

Since :: 2.3.1

Parameters:

[in]	widget_id	appid of widget application
[out]	user_data	user callback data

Returns:: 0 on success, otherwise a negative error value

Return values:

WIDGET_ERROR_NOT_SUPPORTED	Not supported
WIDGET_ERROR_NOT_EXIST	Event handler callback function is not exist
WIDGET_ERROR_NONE	Successfully done

See also:: widget_service_set_lifecycle_event_cb

Required Header

Related Features

Overview

1. widget service API

1.1 APIs for retrieving information of widgets

1.2 APIs for communicating with running widget instances

2. Size of widget

Functions

Typedefs

Typedef Documentation

Enumeration Type Documentation

Function Documentation