One Logo Pool Ball
ContactProvider · IOS API REFERENCE

ContactItemPage

struct · iOS 18.0+ · SDK 27.1

struct ContactItemPage

A fixed offset into enumerating all contact items. You can break an enumeration of all contact items into multiple pages to reduce the memory constraints on the system. During the enumeration, the ``generationMarker`` must not change. Update the ``offset`` to reflect progress so you can resume the enumeration.

Members (6)

get · iOS 18.0+

initialPage

TypeScript
static get initialPage(): ContactItemPage
Swift declaration
static let initialPage: ContactItemPage

A static value the system uses to indicate the start of a new content enumeration.

get · iOS 18.0+

generationMarker

TypeScript
get generationMarker(): ArrayBuffer
Swift declaration
var generationMarker: Data

A value specific to your data source identifying the database generation when enumeration of content started. When a content enumeration is underway, you must use the same `generationMarker` until the enumeration completes. If you restart content enumeration, you can use a new `generationMarker` value from that point onward.

set · iOS 18.0+

generationMarker

TypeScript
set generationMarker(value: ArrayBuffer)
Swift declaration
var generationMarker: Data

A value specific to your data source identifying the database generation when enumeration of content started. When a content enumeration is underway, you must use the same `generationMarker` until the enumeration completes. If you restart content enumeration, you can use a new `generationMarker` value from that point onward.

init · iOS 18.0+

init

TypeScript
static init(generationMarker: ArrayBuffer, offset: number): ContactItemPage
Swift declaration
init(generationMarker: Data, offset: Int)

Creates a contact item page with the given generation marker and offset. - Parameters: - generationMarker: A marker that indicates when enumeration of content started. - offset: An offset from the generation marker.

get · iOS 18.0+

offset

TypeScript
get offset(): number
Swift declaration
var offset: Int

An offset from the page's generation marker. You can use the offset to track a contiguous number of contact items which have been successfully enumerated for that database generation.

set · iOS 18.0+

offset

TypeScript
set offset(value: number)
Swift declaration
var offset: Int

An offset from the page's generation marker. You can use the offset to track a contiguous number of contact items which have been successfully enumerated for that database generation.

Skipped declarations

No declarations were skipped in this snapshot.

All ContactProvider types →