react-native-alarm-scheduler
API reference

Overview

Every method exposed by the default export, grouped by what it does.

The package exposes the alarm API as its default export and as the named AlarmScheduler export:

import AlarmScheduler from 'react-native-alarm-scheduler';

// Equivalent:
import { AlarmScheduler } from 'react-native-alarm-scheduler';

All types are also exported as named exports from the same module.

Permissions

MethodReturns
getPermissionsAsync()AlarmPermissionResponse
requestPermissionsAsync()AlarmPermissionResponse
openAlarmSettingsAsync()boolean
openFullScreenIntentSettingsAsync()boolean

Scheduling

MethodReturns
scheduleAlarmAsync(alarm)ScheduledAlarm
cancelAlarmAsync(id)boolean
getScheduledAlarmsAsync()ScheduledAlarm[]

Context and actions

Completion and backup

Alarm occurrences

System Clock (Android)

Debugging

MethodReturns
getNativeAlarmDebugStateAsync(alarmId)NativeAlarmDebugState

Events

onAlarmTriggered, onAlarmAction, onAlarmStateChange