Tizen Native API
|
Functions | |
int | service_plugin_destroy (service_plugin_h plugin) |
Destroy Service Adaptor. | |
int | service_plugin_add_property (service_plugin_h plugin, const char *key, const char *value) |
Add Plugin Property. | |
int | service_plugin_remove_property (service_plugin_h plugin, const char *key) |
Remove Plugin Property. | |
int | service_plugin_get_property (service_plugin_h plugin, const char *key, char **value) |
Gets Plugin Property. | |
int | service_plugin_start (service_plugin_h plugin, int service_mask) |
Requests start initalization for service plugin. | |
int | service_plugin_stop (service_plugin_h plugin) |
Requests stop manually for service plugin. | |
Typedefs | |
typedef struct _service_plugin_s * | service_plugin_h |
The Plugn handle for Service Adaptor. | |
Defines | |
#define | SERVICE_PLUGIN_PROPERTY_APP_KEY "http://tizen.org/service-adaptor/plugin/property/app_key" |
Definition for the service_plugin property: The application id be issued from service provider for 3rd party developer. | |
#define | SERVICE_PLUGIN_PROPERTY_APP_SECRET "http://tizen.org/service-adaptor/plugin/property/app_secret" |
Definition for the service_plugin property: The application password be issued from service provider for 3rd party developer. | |
#define | SERVICE_PLUGIN_PROPERTY_USER_ID "http://tizen.org/service-adaptor/plugin/property/user_id" |
Definition for the service_plugin property: The user id for using specific service. |
The Service Plugin API provides functions to manage the plugin set's property and state.
Required Header
#include <service_adaptor_client.h>
Overview
The service_plugin_h can gets using Service Adaptor API.
It means kind of plugin set, the APIs can set property for using service and handling service plugin.
API | Description |
---|---|
Storage | Provide functions for access and manage storage service |
Define Documentation
#define SERVICE_PLUGIN_PROPERTY_APP_KEY "http://tizen.org/service-adaptor/plugin/property/app_key" |
Definition for the service_plugin property: The application id be issued from service provider for 3rd party developer.
- Since :
- 2.4
#define SERVICE_PLUGIN_PROPERTY_APP_SECRET "http://tizen.org/service-adaptor/plugin/property/app_secret" |
Definition for the service_plugin property: The application password be issued from service provider for 3rd party developer.
- Since :
- 2.4
#define SERVICE_PLUGIN_PROPERTY_USER_ID "http://tizen.org/service-adaptor/plugin/property/user_id" |
Definition for the service_plugin property: The user id for using specific service.
- Since :
- 2.4
Typedef Documentation
typedef struct _service_plugin_s* service_plugin_h |
The Plugn handle for Service Adaptor.
The handle can be created by service_adaptor_create_plugin()
When a handle is no longer needed, use service_plugin_destroy()
- Since :
- 2.4
Enumeration Type Documentation
Function Documentation
int service_plugin_add_property | ( | service_plugin_h | plugin, |
const char * | key, | ||
const char * | value | ||
) |
Add Plugin Property.
The plguin property is used for plugin's basic or optional requirement.
This value is not used in Adaptor layer, but it can be uesd to important Key for plugin with service provider.
- Since :
- 2.4
- Parameters:
-
[in] plugin The handle for use Plugin APIs [in] key The key of plugin property [in] value The value of plugin property that matched key
- Remarks:
- Some kind of property key(Not mandatory) is defined in this API (That is named to SERVICE_PLUGIN_PROPERTY_XXX)
- If the key already exists in the property its current value is replaced with the new value.
- plugin must be released memory using service_plugin_destroy() when you no longer needs plugin's API
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
SERVICE_ADAPTOR_ERROR_NONE Successful SERVICE_ADAPTOR_ERROR_INVALID_PARAMETER Invalid parameter SERVICE_ADAPTOR_ERROR_UNKNOWN Unknown error
- See also:
- SERVICE_PLUGIN_PROPERTY_APP_KEY
- SERVICE_PLUGIN_PROPERTY_APP_SECRET
- SERVICE_PLUGIN_PROPERTY_USER_ID
- Precondition:
- plugin must be issued by service_adaptor_create_plugin()
int service_plugin_destroy | ( | service_plugin_h | plugin | ) |
Destroy Service Adaptor.
It must called after a program no longer needs APIs of specfic plugin
- Since :
- 2.4
- Parameters:
-
[in] plugin The handle for use Plugin APIs
- See also:
- service_adaptor_create_plugin()
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
SERVICE_ADAPTOR_ERROR_NONE Successful SERVICE_ADAPTOR_ERROR_INVALID_PARAMETER Invalid parameter SERVICE_ADAPTOR_ERROR_UNKNOWN Unknown error
- Precondition:
- plugin must be issued by service_adaptor_create_plugin()
int service_plugin_get_property | ( | service_plugin_h | plugin, |
const char * | key, | ||
char ** | value | ||
) |
Gets Plugin Property.
- Since :
- 2.4
- Parameters:
-
[in] plugin The handle for use Plugin APIs [in] key The key of plugin property [out] value The value of plugin property that matched key
- Remarks:
- Some kind of property key(Not mandatory) is defined in this API (That is named to SERVICE_PLUGIN_PROPERTY_XXX)
- value must be released using free()
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
SERVICE_ADAPTOR_ERROR_NONE Successful SERVICE_ADAPTOR_ERROR_NO_DATA There is no property SERVICE_ADAPTOR_ERROR_INVALID_PARAMETER Invalid parameter SERVICE_ADAPTOR_ERROR_UNKNOWN Unknown error
- See also:
- SERVICE_PLUGIN_PROPERTY_APP_KEY
- SERVICE_PLUGIN_PROPERTY_APP_SECRET
- SERVICE_PLUGIN_PROPERTY_USER_ID
- Precondition:
- The function get property already set by service_adaptor_set_plugin_property()
int service_plugin_remove_property | ( | service_plugin_h | plugin, |
const char * | key | ||
) |
Remove Plugin Property.
- Since :
- 2.4
- Parameters:
-
[in] plugin The handle for use Plugin APIs [in] key The key of plugin property
- Remarks:
- Some kind of property key(Not mandatory) is defined in this API (That is named to SERVICE_PLUGIN_PROPERTY_XXX)
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
SERVICE_ADAPTOR_ERROR_NONE Successful SERVICE_ADAPTOR_ERROR_INVALID_PARAMETER Invalid parameter SERVICE_ADAPTOR_ERROR_UNKNOWN Unknown error
int service_plugin_start | ( | service_plugin_h | plugin, |
int | service_mask | ||
) |
Requests start initalization for service plugin.
- Since :
- 2.4
- Parameters:
-
[in] plugin The handle for use Plugin APIs [in] service_mask The flag for use service plugins, this flag can be masked multiple enum (service_plugin_service_type_e)
- Remarks:
- service_mask must be input using 'bit or' operation with service_plugin_service_type_e
- - for example,
- int service_mask |= SERVIE_PLUGIN_SERVICE_AUTH;
- service_mask |= SERVICE_PLUGIN_SERVICE_STORAGE;
- int ret = service_plugin_start(m_plugin, service_mask);
-
If a program needs to stop plugin manually, use service_plugin_stop().
But in service_plugin_destroy(), automatically stop service plugin
- Returns:
- 0 on success, otherwise a negative error value
- If return value is SERVICE_ADAPTOR_ERROR_NOT_AUTHORIZED, request authorization to signup application
- Return values:
-
SERVICE_ADAPTOR_ERROR_NONE Successful SERVICE_ADAPTOR_ERROR_INVALID_PARAMETER Invalid parameter SERVICE_ADAPTOR_ERROR_NOT_AUTHORIZED Need authorization SERVICE_ADAPTOR_ERROR_TIMED_OUT Timed out SERVICE_ADAPTOR_ERROR_IPC_UNSTABLE IPC failed with Service Adaptor Daemon SERVICE_ADAPTOR_ERROR_UNKNOWN Unknown error
int service_plugin_stop | ( | service_plugin_h | plugin | ) |
Requests stop manually for service plugin.
- Since :
- 2.4
- Parameters:
-
[in] plugin The handle for use Plugin APIs
- Remarks:
- If a program needs to stop plugin manually, use this function.
But in service_plugin_destroy(), automatically stop service plugin - plugin must be released memory using service_plugin_destroy() when you no longer needs plugin's API
- Returns:
- 0 on success, otherwise a negative error value
- Return values:
-
SERVICE_ADAPTOR_ERROR_NONE Successful SERVICE_ADAPTOR_ERROR_TIMED_OUT Timed out SERVICE_ADAPTOR_ERROR_IPC_UNSTABLE IPC failed with Service Adaptor Daemon SERVICE_ADAPTOR_ERROR_UNKNOWN Unknown error
- Precondition:
- service_plugin_start()