One Logo Pool Ball
NearbyInteraction · IOS API REFERENCE

NIAlgorithmConvergenceStatus.Reason

struct · iOS 16.0+ · SDK 27.1

struct Reason

Reasons for the convergence state. Multiple reasons may be present simultaenously.

Members (9)

get · iOS 16.0+

insufficientLighting

TypeScript
get insufficientLighting(): NIAlgorithmConvergenceStatus_Reason
Swift declaration
static let insufficientLighting: NIAlgorithmConvergenceStatus.Reason

Tell user to turn on the light.

get · iOS 16.0+

insufficientMovement

TypeScript
get insufficientMovement(): NIAlgorithmConvergenceStatus_Reason
Swift declaration
static let insufficientMovement: NIAlgorithmConvergenceStatus.Reason

Tell user to move around.

get · iOS 16.0+

localizedDescription

TypeScript
getLocalizedDescription($self: NIAlgorithmConvergenceStatus_Reason): (string) | null
Swift declaration
var localizedDescription: String? { get }
get · iOS 16.0+

insufficientVerticalSweep

TypeScript
get insufficientVerticalSweep(): NIAlgorithmConvergenceStatus_Reason
Swift declaration
static let insufficientVerticalSweep: NIAlgorithmConvergenceStatus.Reason

Tell user to sweep device verically up and down.

get · iOS 16.0+

insufficientSignalStrength

TypeScript
get insufficientSignalStrength(): NIAlgorithmConvergenceStatus_Reason
Swift declaration
static let insufficientSignalStrength: NIAlgorithmConvergenceStatus.Reason

Indicate to the user that the devices might be too far apart.

get · iOS 16.0+

insufficientHorizontalSweep

TypeScript
get insufficientHorizontalSweep(): NIAlgorithmConvergenceStatus_Reason
Swift declaration
static let insufficientHorizontalSweep: NIAlgorithmConvergenceStatus.Reason

Tell user to sweep device horizontally from side to side.

init · iOS 16.0+

init

TypeScript
init(rawValue: string): NIAlgorithmConvergenceStatus_Reason
Swift declaration
init(rawValue: String)

Creates a new instance with the specified raw value. If there is no value of the type that corresponds with the specified raw value, this initializer returns `nil`. For example: enum PaperSize: String { case A4, A5, Letter, Legal } print(PaperSize(rawValue: "Legal")) // Prints "Optional(PaperSize.Legal)" print(PaperSize(rawValue: "Tabloid")) // Prints "nil" - Parameter rawValue: The raw value to use for the new instance.

get · iOS 16.0+

rawValue

TypeScript
getRawValue($self: NIAlgorithmConvergenceStatus_Reason): string
Swift declaration
var rawValue: String

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

set · iOS 16.0+

rawValue

TypeScript
setRawValue($self: NIAlgorithmConvergenceStatus_Reason, value: string): void
Swift declaration
var rawValue: String

The corresponding value of the raw type. A new instance initialized with `rawValue` will be equivalent to this instance. For example: enum PaperSize: String { case A4, A5, Letter, Legal } let selectedSize = PaperSize.Letter print(selectedSize.rawValue) // Prints "Letter" print(selectedSize == PaperSize(rawValue: selectedSize.rawValue)!) // Prints "true"

Skipped declarations

No declarations were skipped in this snapshot.

All NearbyInteraction types →