Pepper_47_C_interfaces
Public Attributes | List of all members
PPP_Flash_BrowserOperations_1_3 Struct Reference

#include <ppp_flash_browser_operations.h>

Collaboration diagram for PPP_Flash_BrowserOperations_1_3:
Collaboration graph

Public Attributes

PP_Bool(* ClearSiteData )(const char *plugin_data_path, const char *site, uint64_t flags, uint64_t max_age)
 
PP_Bool(* DeauthorizeContentLicenses )(const char *plugin_data_path)
 
void(* GetPermissionSettings )(const char *plugin_data_path, PP_Flash_BrowserOperations_SettingType setting_type, PPB_Flash_BrowserOperations_GetSettingsCallback callback, void *user_data)
 
PP_Bool(* SetDefaultPermission )(const char *plugin_data_path, PP_Flash_BrowserOperations_SettingType setting_type, PP_Flash_BrowserOperations_Permission permission, PP_Bool clear_site_specific)
 
PP_Bool(* SetSitePermission )(const char *plugin_data_path, PP_Flash_BrowserOperations_SettingType setting_type, uint32_t site_count, const struct PP_Flash_BrowserOperations_SiteSetting sites[])
 
void(* GetSitesWithData )(const char *plugin_data_path, char ***sites)
 
void(* FreeSiteList )(char *sites[])
 

Detailed Description

This interface allows the browser to request the plugin do things.

Definition at line 87 of file ppp_flash_browser_operations.h.

Member Data Documentation

PP_Bool(* PPP_Flash_BrowserOperations_1_3::ClearSiteData)(const char *plugin_data_path, const char *site, uint64_t flags, uint64_t max_age)

This function allows the plugin to implement the "Clear site data" feature.

Parameters
[in]plugin_data_pathString containing the directory where the plugin data is stored. On UTF16 systems (Windows), this will be encoded as UTF-8. It will be an absolute path and will not have a directory separator (slash) at the end.
[in]siteString specifying which site to clear the data for. This will be null to clear data for all sites.
[in]flagsCurrently always 0 in Chrome to clear all data. This may be extended in the future to clear only specific types of data.
[in]max_ageThe maximum age in seconds to clear data for. This allows the plugin to implement "clear past hour" and "clear past data", etc.
Returns
PP_TRUE on success, PP_FALSE on failure.

See also the NPP_ClearSiteData function in NPAPI. https://wiki.mozilla.org/NPAPI:ClearSiteData

Definition at line 109 of file ppp_flash_browser_operations.h.

PP_Bool(* PPP_Flash_BrowserOperations_1_3::DeauthorizeContentLicenses)(const char *plugin_data_path)

Requests the plugin to deauthorize content licenses. It prevents Flash from playing protected content, such as movies and music the user may have rented or purchased.

Parameters
[in]plugin_data_pathString containing the directory where the plugin settings are stored.
Returns
PP_TRUE on success, PP_FALSE on failure.

Definition at line 123 of file ppp_flash_browser_operations.h.

void(* PPP_Flash_BrowserOperations_1_3::FreeSiteList)(char *sites[])

Frees the list of sites returned by GetSitesWithData.

Parameters
[in]sitesA NULL-terminated array of strings.

Definition at line 195 of file ppp_flash_browser_operations.h.

void(* PPP_Flash_BrowserOperations_1_3::GetPermissionSettings)(const char *plugin_data_path, PP_Flash_BrowserOperations_SettingType setting_type, PPB_Flash_BrowserOperations_GetSettingsCallback callback, void *user_data)

Gets permission settings. callback will be called exactly once to return the settings.

Parameters
[in]plugin_data_pathString containing the directory where the plugin settings are stored.
[in]setting_typeWhat type of setting to retrieve.
[in]callbackThe callback to return retrieved data.
[in,out]user_dataAn opaque pointer that will be passed to callback.

Definition at line 135 of file ppp_flash_browser_operations.h.

void(* PPP_Flash_BrowserOperations_1_3::GetSitesWithData)(const char *plugin_data_path, char ***sites)

Returns a list of sites that have stored data, for use with the "Clear site data" feature.

Parameters
[in]plugin_data_pathString containing the directory where the plugin data is stored.
[out]sitesA NULL-terminated array of sites that have stored data. Use FreeSiteList on the array when done.

See also the NPP_GetSitesWithData function in NPAPI: https://wiki.mozilla.org/NPAPI:ClearSiteData

Definition at line 189 of file ppp_flash_browser_operations.h.

PP_Bool(* PPP_Flash_BrowserOperations_1_3::SetDefaultPermission)(const char *plugin_data_path, PP_Flash_BrowserOperations_SettingType setting_type, PP_Flash_BrowserOperations_Permission permission, PP_Bool clear_site_specific)

Sets default permission. It applies to all sites except those with site-specific settings.

Parameters
[in]plugin_data_pathString containing the directory where the plugin settings are stored.
[in]setting_typeWhat type of setting to set.
[in]permissionThe default permission.
[in]clear_site_specificWhether to remove all site-specific settings.
Returns
PP_TRUE on success, PP_FALSE on failure.

Definition at line 153 of file ppp_flash_browser_operations.h.

PP_Bool(* PPP_Flash_BrowserOperations_1_3::SetSitePermission)(const char *plugin_data_path, PP_Flash_BrowserOperations_SettingType setting_type, uint32_t site_count, const struct PP_Flash_BrowserOperations_SiteSetting sites[])

Sets site-specific permission. If a site has already got site-specific permission and it is not in sites, it won't be affected.

Parameters
[in]plugin_data_pathString containing the directory where the plugin settings are stored.
[in]setting_typeWhat type of setting to set.
[in]site_countHow many items are there in sites.
[in]sitesThe site-specific settings. If a site is specified with PP_FLASH_BROWSEROPERATIONS_PERMISSION_DEFAULT permission, it will be removed from the site-specific list.
Returns
PP_TRUE on success, PP_FALSE on failure.

Definition at line 172 of file ppp_flash_browser_operations.h.


The documentation for this struct was generated from the following file: