Struct iOSNotificationLocationTrigger

A trigger condition that causes a notification to be delivered when the user's device enters or exits the specified geographic region.

Implements

iOSNotificationTrigger

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Notifications.iOS

Assembly: Unity.Notifications.iOS.dll

Syntax

public struct iOSNotificationLocationTrigger : iOSNotificationTrigger

Remarks

Create a UNLocationNotificationTrigger instance when you want to schedule the delivery of a local notification when the device enters or leaves a specific geographic region. The system limits the number of location-based triggers that may be scheduled at the same time. Before scheduling any notifications using this trigger, your app must have authorization to use Core Location and must have when-in-use permissions. Use the Unity LocationService API to request for this authorization. Region-based notifications aren't always triggered immediately when the edge of the boundary is crossed. The system applies heuristics to ensure that the boundary crossing represents a deliberate event and is not the result of spurious location data. See https://developer.apple.com/documentation/corelocation/clregion?language=objc for additional information.

Properties

Center

The center point of the geographic area.

Declaration

[Obsolete("Use Latitude and Longitude", false)]
public Vector2 Center { get; set; }

Property Value

Type	Description
Vector2

Latitude

The latitude of the center point of the geographic area.

Declaration

public double Latitude { readonly get; set; }

Property Value

Type	Description
double	Latitude in degrees

Longitude

The longitude of the center point of the geographic area.

Declaration

public double Longitude { readonly get; set; }

Property Value

Type	Description
double	Longitude in degrees

NotifyOnEntry

When this property is enabled, a device crossing from outside the region to inside the region triggers the delivery of a notification

Declaration

public bool NotifyOnEntry { readonly get; set; }

Property Value

Type	Description
bool	If true, a notification triggers when entering the region.

NotifyOnExit

When this property is enabled, a device crossing from inside the region to outside the region triggers the delivery of a notification

Declaration

public bool NotifyOnExit { readonly get; set; }

Property Value

Type	Description
bool	If true, a notification triggers when leaving the region.

Radius

The radius (measured in meters) that defines the geographic area’s outer boundary.

Declaration

public float Radius { readonly get; set; }

Property Value

Type	Description
float	Radius in meters

Repeats

Whether the notification should repeat.

Declaration

public bool Repeats { readonly get; set; }

Property Value

Type	Description
bool	If true, the notification repeats.

Type

The type of notification trigger. For internal use.

Declaration

public iOSNotificationTriggerType Type { get; }

Property Value

Type	Description
iOSNotificationTriggerType	The type of the trigger

Implements

iOSNotificationTrigger