Class: EKAlarm
Overview
An EKAlarm object represents an alarm in Event Kit. Use the alarmWithAbsoluteDate: and alarmWithRelativeOffset: class methods to create an alarm and use the properties to set information about an alarm. In OS X Mountain Lion, you can specify an action to trigger when the alarm fires via the emailAddress, soundName, or url property.
Instance Attribute Summary (collapse)
-
- absoluteDate
The absolute date for the alarm.
-
- proximity
A value indicating how a location-based alarm is triggered.
-
- relativeOffset
The offset from the start of an event, at which the alarm fires.
-
- structuredLocation
The location to trigger an alarm.
Class Method Summary (collapse)
-
+ alarmWithAbsoluteDate:
Creates and returns an alarm with an absolute date.
-
+ alarmWithRelativeOffset:
Creates and returns an alarm with a relative offset.
Methods inherited from EKObject
#hasChanges, #isNew, #refresh, #reset, #rollback
Methods inherited from NSObject
#!, #!=, #!~, #, #==, #===, #=~, #Rational, #__callee__, #__method__, #__send__, #__type__, `, alloc, allocWithZone:, #autoContentAccessingProxy, autoload, autoload?, autorelease_pool, #awakeAfterUsingCoder:, binding, block_given?, caller, cancelPreviousPerformRequestsWithTarget:, cancelPreviousPerformRequestsWithTarget:selector:object:, catch, class, classFallbacksForKeyedArchiver, #classForCoder, #classForKeyedArchiver, classForKeyedUnarchiver, #clone, conformsToProtocol:, #copy, copyWithZone:, #dealloc, #define_singleton_method, description, display, #doesNotRecognizeSelector:, #dup, #enum_for, #eql?, #equal?, #extend, fail, #finalize, format, #forwardInvocation:, #forwardingTargetForSelector:, framework, #freeze, #frozen?, getpass, gets, global_variables, #init, initialize, #initialize_clone, #initialize_copy, #initialize_dup, #inspect, instanceMethodForSelector:, instanceMethodSignatureForSelector:, #instance_eval, #instance_exec, #instance_of?, #instance_variable_defined?, #instance_variable_get, #instance_variable_set, #instance_variables, instancesRespondToSelector:, isSubclassOfClass:, #is_a?, iterator?, #kind_of?, lambda, load, load_bridge_support_file, load_plist, local_variables, loop, #method, #methodForSelector:, #methodSignatureForSelector:, #methods, #mutableCopy, mutableCopyWithZone:, new, #nil?, open, p, #performSelector:onThread:withObject:waitUntilDone:, #performSelector:onThread:withObject:waitUntilDone:modes:, #performSelector:withObject:afterDelay:, #performSelector:withObject:afterDelay:inModes:, #performSelectorInBackground:withObject:, #performSelectorOnMainThread:withObject:waitUntilDone:, #performSelectorOnMainThread:withObject:waitUntilDone:modes:, print, printf, #private_methods, proc, #protected_methods, #public_method, #public_methods, #public_send, putc, puts, raise, rand, readline, readlines, #replacementObjectForCoder:, #replacementObjectForKeyedArchiver:, require, resolveClassMethod:, resolveInstanceMethod:, #respond_to?, #respond_to_missing?, select, #send, setVersion:, #singleton_methods, sprintf, srand, superclass, #taint, #tainted?, #tap, test, throw, #to_plist, #to_s, trace_var, trap, #trust, #untaint, untrace_var, #untrust, #untrusted?, version
Constructor Details
This class inherits a constructor from NSObject
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class NSObject
Instance Attribute Details
- (NSDate) absoluteDate
The absolute date for the alarm. If you set this property for a relative offset alarm, it loses the relative offset and becomes an absolute alarm.
- (EKAlarmProximity) proximity
A value indicating how a location-based alarm is triggered. Alarms can be set to trigger when entering or exiting a location specified by structuredLocation. By default, alarms are not affected by location.
- (NSTimeInterval) relativeOffset
The offset from the start of an event, at which the alarm fires. If you set this value for an absolute alarm, it loses its absolute date and becomes a relative offset alarm.
- (EKStructuredLocation) structuredLocation
The location to trigger an alarm. This property is used in conjunction with proximity to perform geofence-based triggering of reminders.
Class Method Details
+ (EKAlarm) alarmWithAbsoluteDate(date)
Creates and returns an alarm with an absolute date.
+ (EKAlarm) alarmWithRelativeOffset(offset)
Creates and returns an alarm with a relative offset. Negative offset values fire before the start of the event, while positive values fire after the start.