DJI Mobile SDK Documentation

      class DJICustomUnlockZone

      @interface DJICustomUnlockZone : NSObject
      Header:DJICustomUnlockZone.h
      Inherits From:NSObject
      Description:

      Users can unlock areas of a restricted fly zone through http://www.dji.com/flysafe/custom-unlock. A user needs to show special authorization (usually from a third party such as a regulatory or managing agency) as part of the process to unlock the area within the restricted fly zone. Therefore each request is unique and customized to the individual. If the request is successful, the unlocked area is tied to the user's account as an Custom Unlock Zone.

      This class contains the properties of an Custom Unlock Zone.

      Class Members:
      property
      property ID
      @property(nonatomic, readonly) NSUInteger ID
      Header:DJICustomUnlockZone.h
      Description:

      The unique ID of the Custom Unlock Zone.

      property
      property type
      @property(nonatomic, readonly) DJICustomUnlockType type
      Header:DJICustomUnlockZone.h
      Description:

      The type of custom unlocking.

      See Also:

      DJICustomUnlockType

      property
      property name
      @property(nonatomic, readonly) NSString* name
      Header:DJICustomUnlockZone.h
      Description:

      Name of the Custom Unlock Zone.

      property
      property center
      @property(nonatomic, readonly) CLLocationCoordinate2D center
      Header:DJICustomUnlockZone.h
      Description:

      The coordinate of the Custom Unlock Zone's center. Only used when type is DJICustomUnlockTypeCircle.

      property
      property radius
      @property(nonatomic, readonly) double radius
      Header:DJICustomUnlockZone.h
      Description:

      The radius of the Custom Unlock Zone in meters. Valid when type is DJICustomUnlockTypeCircle.

      property
      property countryCode
      @property(nonatomic, readonly) NSString* countryCode
      Header:DJICustomUnlockZone.h
      Description:

      Check country code (https://www.iso.org/iso-3166-country-codes.html) for the custom unlock zone's shape. Valid when type is DJICustomUnlockTypeCountry.

      property maxFlightAltitude
      @property(nonatomic, readonly) float maxFlightAltitude
      Header:DJICustomUnlockZone.h
      Description:

      The unlocked max flight altitude limit in the custom unlock zone. Valid when type is DJICustomUnlockTypeMaxFlightAltitudeLimit.

      property
      property vertices
      @property(nonatomic, readonly) NSArray<NSValue *> *vertices
      Header:DJICustomUnlockZone.h
      Description:

      The vertices (locations) that make up the custom unlock zone shape. Only used when type is DJICustomUnlockTypePolygon.

      property
      property startTime
      @property(nonatomic, readonly) NSString* startTime
      Header:DJICustomUnlockZone.h
      Description:

      The timestamp of when the unlocking begins, formatted in UTC (YYYY-MM-DD hh:mm:ss). When the time is not available from the server, DJIFlyZoneInformationInvalidTimestamp will be returned.

      property
      property endTime
      @property(nonatomic, readonly) NSString* endTime
      Header:DJICustomUnlockZone.h
      Description:

      The timestamp of when the unlocking ends, formatted in UTC (YYYY-MM-DD hh:mm:ss). When the time is not available from the server, DJIFlyZoneInformationInvalidTimestamp will be returned.

      property
      property isExpired
      @property(nonatomic, readonly) BOOL isExpired
      Header:DJICustomUnlockZone.h
      Description:

      YES if the Custom Unlock Zone has expired. After a zone is expired, the location will be locked.

      enum DJICustomUnlockType
      typedef NS_ENUM(NSUInteger, DJICustomUnlockType)
      Header:DJICustomUnlockZone.h
      Description:

      An enum class represents the type of custom unlocking.

      Enum Members:
      DJICustomUnlockTypeCircleThe custom unlock zone is a circle.
      DJICustomUnlockTypeCountryThe custom unlock zone is a country.
      DJICustomUnlockTypeMaxFlightAltitudeLimitUnlock the max flight altitude limit in the custom unlock zone.
      DJICustomUnlockTypePolygonThe custom unlock zone is a polygon.
      DJICustomUnlockTypeUnknownThe custom unlock type is unknown.