Tizen Native API  5.0
Privilege Info

Requires Header

#include <privilege_information.h>

Overview

A library for reading privilege information of the given privilege and API issue version. It provides the display name or description of privileges. If there's no matching privilege then it shows last token of given privilege or description string for undefined privileges.

Related Features

This API is related with the following features:

Functions

int privilege_info_get_display_name (const char *api_version, const char *privilege, char **display_name)
 Gets the display name of the given privilege.
int privilege_info_get_display_name_by_pkgtype (const char *package_type, const char *api_version, const char *privilege, char **display_name)
 Gets the display name of the given privilege.
int privilege_info_get_description (const char *api_version, const char *privilege, char **description)
 Gets the description of the given privilege.
int privilege_info_get_description_by_pkgtype (const char *package_type, const char *api_version, const char *privilege, char **description)
 Gets the description of the given privilege.
int privilege_info_get_privacy_display_name (const char *privilege, char **privacy_name)
 Gets the display name of the privacy group in which the given privilege is included.
int privilege_info_get_privacy_privilege_status (const char *privilege, bool *status)
 Gets the status of the given privacy related privilege.

Enumeration Type Documentation

Enumeration for error code for Privilege Information.

Since :
2.3
Enumerator:
PRVINFO_ERROR_NONE 

Successful

PRVINFO_ERROR_INVALID_PARAMETER 

Invalid function parameter

PRVINFO_ERROR_OUT_OF_MEMORY 

Out of memory

PRVINFO_ERROR_INTERNAL_ERROR 

Unknown error

PRVINFO_ERROR_NOT_SUPPORTED 

Not supported (Since 5.0)


Function Documentation

int privilege_info_get_description ( const char *  api_version,
const char *  privilege,
char **  description 
)

Gets the description of the given privilege.

Since :
2.3
Remarks:
description must be released using free().
Parameters:
[in]api_versionThe API version of the application to get privilege information
[in]privilegeThe privilege
[out]descriptionThe description of the privilege
Returns:
0 on success, otherwise a negative error value
Return values:
PRVINFO_ERROR_NONESuccessful
PRVINFO_ERROR_OUT_OF_MEMORYOut of memory
PRVINFO_ERROR_INVALID_PARAMETERInvalid function parameter
PRVINFO_ERROR_INTERNAL_ERRORUnknown error
int privilege_info_get_description_by_pkgtype ( const char *  package_type,
const char *  api_version,
const char *  privilege,
char **  description 
)

Gets the description of the given privilege.

Since :
2.3
Remarks:
description must be released using free().
package_type must be one of followings: PRVINFO_PACKAGE_TYPE_NATIVE, PRVINFO_PACKAGE_TYPE_WEB
Parameters:
[in]package_typeThe type of application package
[in]api_versionThe API version of the application to get privilege information
[in]privilegeThe privilege
[out]descriptionThe description of the privilege
Returns:
0 on success, otherwise a negative error value
Return values:
PRVINFO_ERROR_NONESuccessful
PRVINFO_ERROR_OUT_OF_MEMORYOut of memory
PRVINFO_ERROR_INVALID_PARAMETERInvalid function parameter
PRVINFO_ERROR_INTERNAL_ERRORUnknown error
int privilege_info_get_display_name ( const char *  api_version,
const char *  privilege,
char **  display_name 
)

Gets the display name of the given privilege.

Since :
2.3
Remarks:
display_name must be released using free().
Parameters:
[in]api_versionThe API version of the application to get privilege information
[in]privilegeThe privilege
[out]display_nameThe display name of the privilege
Returns:
0 on success, otherwise a negative error value
Return values:
PRVINFO_ERROR_NONESuccessful
PRVINFO_ERROR_OUT_OF_MEMORYOut of memory
PRVINFO_ERROR_INVALID_PARAMETERInvalid function parameter
PRVINFO_ERROR_INTERNAL_ERRORUnknown error
int privilege_info_get_display_name_by_pkgtype ( const char *  package_type,
const char *  api_version,
const char *  privilege,
char **  display_name 
)

Gets the display name of the given privilege.

Since :
2.3
Remarks:
display_name must be released using free().
package_type must be one of followings: PRVINFO_PACKAGE_TYPE_NATIVE, PRVINFO_PACKAGE_TYPE_WEB
Parameters:
[in]package_typeThe type of application package
[in]api_versionThe API version of the application to get privilege information
[in]privilegeThe privilege
[out]display_nameThe display name of the privilege
Returns:
0 on success, otherwise a negative error value
Return values:
PRVINFO_ERROR_NONESuccessful
PRVINFO_ERROR_OUT_OF_MEMORYOut of memory
PRVINFO_ERROR_INVALID_PARAMETERInvalid function parameter
PRVINFO_ERROR_INTERNAL_ERRORUnknown error
int privilege_info_get_privacy_display_name ( const char *  privilege,
char **  privacy_name 
)

Gets the display name of the privacy group in which the given privilege is included.

Since :
3.0
Remarks:
privacy_name must be released using free().
privilege must be privacy related, otherwise PRVINFO_ERROR_INVALID_PARAMETER is returned.
Parameters:
[in]privilegeThe privilege
[out]privacy_nameThe privacy group's display name that the given privilege is included in
Returns:
0 on success, otherwise a negative error value
Return values:
PRVINFO_ERROR_NONESuccessful
PRVINFO_ERROR_OUT_OF_MEMORYOut of memory
PRVINFO_ERROR_INVALID_PARAMETERInvalid function parameter
PRVINFO_ERROR_INTERNAL_ERRORUnknown error
PRVINFO_ERROR_NOT_SUPPORTEDNot supported
int privilege_info_get_privacy_privilege_status ( const char *  privilege,
bool *  status 
)

Gets the status of the given privacy related privilege.

Deprecated:
Deprecated since 5.0. Use ppm_check_permission() instead. You can refer to Privacy Privilege Manager.
Since :
3.0
Remarks:
privilege must be privacy related, otherwise PRVINFO_ERROR_INVALID_PARAMETER is returned. In case of errors, status is set to true.
Parameters:
[in]privilegeThe privilege
[out]statustrue if the privilege is on, and false if the privilege is off
Returns:
0 on success, otherwise a negative error value
Return values:
PRVINFO_ERROR_NONESuccessful
PRVINFO_ERROR_INVALID_PARAMETERInvalid function parameter
PRVINFO_ERROR_INTERNAL_ERRORUnknown error
PRVINFO_ERROR_NOT_SUPPORTEDNot supported