Class

# MobileCircularRegion

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

The definition of an area used for geo-fencing.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                                | Type                               | Read-Only | Shared |
|-----------------------------------------------------|------------------------------------|-----------|--------|
| `Identifier<mobilecircularregion.identifier>`       | `String</api/data_types/string>`   | ✓         |        |
| `Latitude<mobilecircularregion.latitude>`           | `Double</api/data_types/double>`   | ✓         |        |
| `Longitude<mobilecircularregion.longitude>`         | `Double</api/data_types/double>`   | ✓         |        |
| `NotifyOnEntry<mobilecircularregion.notifyonentry>` | `Boolean</api/data_types/boolean>` |           |        |
| `NotifyOnExit<mobilecircularregion.notifyonexit>`   | `Boolean</api/data_types/boolean>` |           |        |
| `Radius<mobilecircularregion.radius>`               | `Double</api/data_types/double>`   | ✓         |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                            | Parameters                                                                                                                                                                              | Returns | Shared |
|-------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|--------|
| `Constructor<mobilecircularregion.constructor>` | latitude As `Double</api/data_types/double>`, longitude As `Double</api/data_types/double>`, radius As `Double</api/data_types/double>`, identifier As `String</api/data_types/string>` |         |        |
|                                                 | center As `Point</api/graphics/point>`, radius As `Double</api/data_types/double>`, identifier As `String</api/data_types/string>`                                                      |         |        |

## Property descriptions

<div id="mobilecircularregion.identifier">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MobileCircularRegion.Identifier

**Identifier** As `String</api/data_types/string>`

> A piece of data you can use to identify the purpose of this region.
>
> This property is read-only.

<div id="mobilecircularregion.latitude">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MobileCircularRegion.Latitude

**Latitude** As `Double</api/data_types/double>`

> The latitude of the region.
>
> This property is read-only.

<div id="mobilecircularregion.longitude">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MobileCircularRegion.Longitude

**Longitude** As `Double</api/data_types/double>`

> The longitude of the region.
>
> This property is read-only.

<div id="mobilecircularregion.notifyonentry">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MobileCircularRegion.NotifyOnEntry

**NotifyOnEntry** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, the `RegionEntered<mobilelocation.regionentered>` event will fire when the user enters this region.

<div id="mobilecircularregion.notifyonexit">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MobileCircularRegion.NotifyOnExit

**NotifyOnExit** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, the `RegionExited<mobilelocation.regionexited>` event will fire when the user exits this region.

<div id="mobilecircularregion.radius">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MobileCircularRegion.Radius

**Radius** As `Double</api/data_types/double>`

> The radius of the region in meters.
>
> This property is read-only.

## Method descriptions

<div id="mobilecircularregion.constructor">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

MobileCircularRegion.Constructor

**Constructor**(latitude As `Double</api/data_types/double>`, longitude As `Double</api/data_types/double>`, radius As `Double</api/data_types/double>`, identifier As `String</api/data_types/string>`)

> Creates a <span class="title-ref">MobileCircularRegion</span> based upon GPS coordinates passed.
>
> <div class="note">
>
> <div class="title">
>
> Note
>
> </div>
>
> `Constructors</api/language/constructor>` are special methods called when you create an Object With the `New</api/language/New>` keyword And pass In the parameters above.
>
> </div>

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

**Constructor**(center As `Point</api/graphics/point>`, radius As `Double</api/data_types/double>`, identifier As `String</api/data_types/string>`)

> Creates a <span class="title-ref">MobileCircularRegion</span> based upon a central point and radius.

## Compatibility

|                       |        |
|-----------------------|--------|
| **Project Types**     | Mobile |
| **Operating Systems** | iOS    |

<div class="seealso">

`Object</api/data_types/additional_types/object>` parent class

</div>