One Logo Pool Ball
CloudKit · IOS API REFERENCE

CKFetchShareMetadataOperation

class · iOS 10.0+ · SDK 27.1

class CKFetchShareMetadataOperation

Members (16)

init · iOS 10.0+

init

TypeScript
static init(): CKFetchShareMetadataOperation
Swift declaration
init()
init · iOS 10.0+

init

TypeScript
static initShareURLs(shareURLs: Array<string>): CKFetchShareMetadataOperation
Swift declaration
convenience init(shareURLs: [URL])
get · iOS 10.0+ · Deprecated in iOS 15.0

fetchShareMetadataCompletionBlock

TypeScript
get fetchShareMetadataCompletionBlock(): (((arg0: (NativeError) | null) => Promise<void>)) | null
Swift declaration
var fetchShareMetadataCompletionBlock: (((any Error)?) -> Void)? { get set }
set · iOS 10.0+ · Deprecated in iOS 15.0

fetchShareMetadataCompletionBlock

TypeScript
set fetchShareMetadataCompletionBlock(value: (((arg0: (NativeError) | null) => void)) | null)
Swift declaration
var fetchShareMetadataCompletionBlock: (((any Error)?) -> Void)? { get set }
get · iOS 10.0+ · Deprecated in iOS 15.0

perShareMetadataBlock

TypeScript
get perShareMetadataBlock(): (((arg0: string, arg1: (CKShare_Metadata) | null, arg2: (NativeError) | null) => Promise<void>)) | null
Swift declaration
var perShareMetadataBlock: ((URL, CKShare.Metadata?, (any Error)?) -> Void)? { get set }
set · iOS 10.0+ · Deprecated in iOS 15.0

perShareMetadataBlock

TypeScript
set perShareMetadataBlock(value: (((arg0: string, arg1: (CKShare_Metadata) | null, arg2: (NativeError) | null) => void)) | null)
Swift declaration
var perShareMetadataBlock: ((URL, CKShare.Metadata?, (any Error)?) -> Void)? { get set }
get · iOS 10.0+

shareURLs

TypeScript
get shareURLs(): (Array<string>) | null
Swift declaration
var shareURLs: [URL]? { get set }
set · iOS 10.0+

shareURLs

TypeScript
set shareURLs(value: (Array<string>) | null)
Swift declaration
var shareURLs: [URL]? { get set }
get · iOS 10.0+

shouldFetchRootRecord

TypeScript
get shouldFetchRootRecord(): boolean
Swift declaration
var shouldFetchRootRecord: Bool { get set }
set · iOS 10.0+

shouldFetchRootRecord

TypeScript
set shouldFetchRootRecord(value: boolean)
Swift declaration
var shouldFetchRootRecord: Bool { get set }
get · iOS 15.0+

perShareMetadataResultBlock

TypeScript
get perShareMetadataResultBlock(): (((arg0: string, arg1: SDKHandle) => Promise<void>)) | null
Swift declaration
var perShareMetadataResultBlock: ((URL, Result<CKShare.Metadata, any Error>) -> Void)? { get set }

The closure to execute as the operation fetches individual shares. The closure returns no value and takes the following parameters: - The share's URL. - A <doc://com.apple.documentation/documentation/swift/result> that contains either: - The share metadata, or - An error that contains information about a problem encountered fetching the share metadata. The operation executes this closure once for each URL in the ``CKFetchShareMetadataOperation/shareURLs`` property. Each time the closure executes, it executes serially with respect to the other closures of the operation. If you intend to use this closure to process results, set it before you execute the operation or submit the operation to a queue.

set · iOS 15.0+

perShareMetadataResultBlock

TypeScript
set perShareMetadataResultBlock(value: (((arg0: string, arg1: SDKHandle) => void)) | null)
Swift declaration
var perShareMetadataResultBlock: ((URL, Result<CKShare.Metadata, any Error>) -> Void)? { get set }

The closure to execute as the operation fetches individual shares. The closure returns no value and takes the following parameters: - The share's URL. - A <doc://com.apple.documentation/documentation/swift/result> that contains either: - The share metadata, or - An error that contains information about a problem encountered fetching the share metadata. The operation executes this closure once for each URL in the ``CKFetchShareMetadataOperation/shareURLs`` property. Each time the closure executes, it executes serially with respect to the other closures of the operation. If you intend to use this closure to process results, set it before you execute the operation or submit the operation to a queue.

get · iOS 15.0+

fetchShareMetadataResultBlock

TypeScript
get fetchShareMetadataResultBlock(): (((arg0: SDKHandle) => Promise<void>)) | null
Swift declaration
var fetchShareMetadataResultBlock: ((Result<Void, any Error>) -> Void)? { get set }

The closure to execute when the operation finishes. The closure returns no value and takes the following parameter: - A <doc://com.apple.documentation/documentation/swift/result> that contains either: - A successful `Result`, or - An error that contains information about a problem encountered fetching the share metadatas. This closure executes only once. The closure executes serially with respect to the other closures of the operation. Set this property's value before you execute the operation or submit it to a queue.

set · iOS 15.0+

fetchShareMetadataResultBlock

TypeScript
set fetchShareMetadataResultBlock(value: (((arg0: SDKHandle) => void)) | null)
Swift declaration
var fetchShareMetadataResultBlock: ((Result<Void, any Error>) -> Void)? { get set }

The closure to execute when the operation finishes. The closure returns no value and takes the following parameter: - A <doc://com.apple.documentation/documentation/swift/result> that contains either: - A successful `Result`, or - An error that contains information about a problem encountered fetching the share metadatas. This closure executes only once. The closure executes serially with respect to the other closures of the operation. Set this property's value before you execute the operation or submit it to a queue.

get · iOS 10.0+

rootRecordDesiredKeys

TypeScript
get rootRecordDesiredKeys(): (Array<string>) | null
Swift declaration
var rootRecordDesiredKeys: [CKRecord.FieldKey]? { get set }

The fields to return when fetching the root record. For a shared record hierarchy, and when ``CKFetchShareMetadataOperation/shouldFetchRootRecord`` is <doc://com.apple.documentation/documentation/swift/true>, set this property to specify which of the root record's fields the operation fetches. Use `nil` to fetch the entire record. CloudKit ignores this property for a shared record zone because, unlike a hierarchy, it doesn't have a nominated root record. The default value is `nil`.

set · iOS 10.0+

rootRecordDesiredKeys

TypeScript
set rootRecordDesiredKeys(value: (Array<string>) | null)
Swift declaration
var rootRecordDesiredKeys: [CKRecord.FieldKey]? { get set }

The fields to return when fetching the root record. For a shared record hierarchy, and when ``CKFetchShareMetadataOperation/shouldFetchRootRecord`` is <doc://com.apple.documentation/documentation/swift/true>, set this property to specify which of the root record's fields the operation fetches. Use `nil` to fetch the entire record. CloudKit ignores this property for a shared record zone because, unlike a hierarchy, it doesn't have a nominated root record. The default value is `nil`.

Skipped declarations

No declarations were skipped in this snapshot.

All CloudKit types →