PPB_Ext_Alarms_Dev_0_1 Struct Reference

#include <ppb_ext_alarms_dev.h>

Collaboration diagram for PPB_Ext_Alarms_Dev_0_1:

Public Attributes
void(*	Create )(PP_Instance instance, struct PP_Var name, PP_Ext_Alarms_AlarmCreateInfo_Dev alarm_info)
int32_t(*	Get )(PP_Instance instance, struct PP_Var name, PP_Ext_Alarms_Alarm_Dev *alarm, struct PP_CompletionCallback callback)
int32_t(*	GetAll )(PP_Instance instance, PP_Ext_Alarms_Alarm_Dev_Array *alarms, struct PP_CompletionCallback callback)
void(*	Clear )(PP_Instance instance, struct PP_Var name)
void(*	ClearAll )(PP_Instance instance)

Detailed Description

Definition at line 83 of file ppb_ext_alarms_dev.h.

Member Data Documentation

void(* PPB_Ext_Alarms_Dev_0_1::Clear)(PP_Instance instance, struct PP_Var name)

Clears the alarm with the given name.

Parameters

[in]	instance	A PP_Instance.
[in]	name	A string or undefined PP_Var. The name of the alarm to clear. Defaults to the empty string.

Definition at line 159 of file ppb_ext_alarms_dev.h.

void(* PPB_Ext_Alarms_Dev_0_1::ClearAll)(PP_Instance instance)

Clears all alarms.

Parameters

[in]

instance

A PP_Instance.

Definition at line 165 of file ppb_ext_alarms_dev.h.

void(* PPB_Ext_Alarms_Dev_0_1::Create)(PP_Instance instance, struct PP_Var name, PP_Ext_Alarms_AlarmCreateInfo_Dev alarm_info)

Creates an alarm. Near the time(s) specified by alarm_info, the PP_Ext_Alarms_OnAlarm_Dev event is fired. If there is another alarm with the same name (or no name if none is specified), it will be cancelled and replaced by this alarm.

In order to reduce the load on the user's machine, Chrome limits alarms to at most once every 1 minute but may delay them an arbitrary amount more. That is, setting $ref:[PP_Ext_Alarms_AlarmCreateInfo_Dev.delayInMinutes delayInMinutes] or $ref:[PP_Ext_Alarms_AlarmCreateInfo_Dev.periodInMinutes periodInMinutes] to less than 1 will not be honored and will cause a warning. $ref:[PP_Ext_Alarms_AlarmCreateInfo_Dev.when when] can be set to less than 1 minute after "now" without warning but won't actually cause the alarm to fire for at least 1 minute.

To help you debug your app or extension, when you've loaded it unpacked, there's no limit to how often the alarm can fire.

Parameters

[in]	instance	A PP_Instance.
[in]	name	A string or undefined PP_Var. Optional name to identify this alarm. Defaults to the empty string.
[in]	alarm_info	A PP_Var whose contents conform to the description of PP_Ext_Alarms_AlarmCreateInfo_Dev. Describes when the alarm should fire. The initial time must be specified by either when or delayInMinutes (but not both). If periodInMinutes is set, the alarm will repeat every periodInMinutes minutes after the initial event. If neither when or delayInMinutes is set for a repeating alarm, periodInMinutes is used as the default for delayInMinutes.

Definition at line 118 of file ppb_ext_alarms_dev.h.

int32_t(* PPB_Ext_Alarms_Dev_0_1::Get)(PP_Instance instance, struct PP_Var name, PP_Ext_Alarms_Alarm_Dev *alarm, struct PP_CompletionCallback callback)

Retrieves details about the specified alarm.

Parameters

[in]	instance	A PP_Instance.
[in]	name	A string or undefined PP_Var. The name of the alarm to get. Defaults to the empty string.
[out]	alarm	A PP_Var whose contents conform to the description of PP_Ext_Alarms_Alarm_Dev.
[in]	callback	A PP_CompletionCallback to be called upon completion.

Returns

An error code from pp_errors.h

Definition at line 134 of file ppb_ext_alarms_dev.h.

int32_t(* PPB_Ext_Alarms_Dev_0_1::GetAll)(PP_Instance instance, PP_Ext_Alarms_Alarm_Dev_Array *alarms, struct PP_CompletionCallback callback)

Gets an array of all the alarms.

Parameters

[in]	instance	A PP_Instance.
[out]	alarms	A PP_Var whose contents conform to the description of PP_Ext_Alarms_Alarm_Dev_Array.
[in]	callback	A PP_CompletionCallback to be called upon completion.

Returns

An error code from pp_errors.h

Definition at line 149 of file ppb_ext_alarms_dev.h.

---

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

• extensions/dev/ppb_ext_alarms_dev.h