Platforms to show: All Mac Windows Linux Cross-Platform

CKContainerMBS.accountStatus(tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Reports whether the current user’s iCloud account can be accessed.
Notes: This method determines the status of the current user’s iCloud account asynchronously, reporting the results to the block in the completionHandler parameter. Call this method before accessing the private database to determine whether that database is available. While your app is running, use the NSUbiquityIdentityDidChangeNotification notification to detect account changes and call this method again to retrieve the status for the new account.
CKContainerMBS.addOperation(operation as CKOperationMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Queues an operation for execution in the current container.
Notes:
operation: The CKOperationMBS to enqueue. Make sure the operation object you provide is fully configured and ready to be enqueued. Do not change the settings of this object after calling this method.

This method adds the operation object to an operation queue managed by the container itself. Operation objects in the container’s queue execute concurrently with default priorities in background threads.

This method changes the operation object’s container (if any) to the current container.
CKContainerMBS.Constructor
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: The constructor.

See also:

CKContainerMBS.Constructor(Container as CKContainerMBS)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 21.2 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Creates a new object for an container reference.
Notes: Allows you to initialize with your subclass to fill events.

See also:

CKContainerMBS.discoverAllContactUserInfos(tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Retrieves information about all discoverable users that are known to the current user.
Notes:
Use this method to retrieve information about other users of the app. This method returns information about those users who meet the following criteria:

  • There is contact information for the user in the current user’s address book.
  • The user has run the app.
  • The user has granted the CKApplicationPermissionUserDiscoverability permission to your app for this container.

This method searches for the users asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKDiscoverAllContactsOperationMBS object and configure the desired priority.
CKContainerMBS.discoverAllIdentities(tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Fetches all user records that match an entry in the user’s address book.
Notes: This method searches for the user asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKDiscoverAllContactsOperation object and configure the desired priority.
CKContainerMBS.discoverUserIdentityWithEmailAddress(emailAddress as string, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Returns the user record ID associated in the user’s contacts with the email address.
Notes:
email: The email address used to locate the user.

Use this method to retrieve the ID of a user that is known to the current user. The user you are searching for must meet the following criteria:

  • The user must be in the current user’s address book.
  • The user must have run the app.
  • The user must have granted the userDiscoverability permission for this container.

This method searches for the user asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKDiscoverUserInfosOperationMBS object and configure the desired priority.
CKContainerMBS.discoverUserIdentityWithPhoneNumber(phoneNumber as string, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Returns the user record ID associated in the user’s contacts with the phone number.
Notes:
phoneNumber: The phone number used to locate the user.

Use this method to retrieve the ID of a user that is known to the current user. The user you are searching for must meet the following criteria:

  • The user must be in the current user’s address book.
  • The user must have run the app.
  • The user must have granted the userDiscoverability permission for this container.

This method searches for the user asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKDiscoverUserInfosOperationMBS object and configure the desired priority.
CKContainerMBS.discoverUserIdentityWithUserRecordID(userRecordID as CKRecordIDMBS, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Retrieves information about a single user based on the ID of the corresponding user record.
Notes:
userRecordID: The ID of the user record.

Use this method to retrieve information about a user for which you already have a user record ID. The user you are searching for must meet the following criteria:

  • The user must have run the app.
  • The user must have granted the userDiscoverability permission for this container.

This method searches for the user asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKDiscoverUserInfosOperationMBS object and configure the desired priority.
CKContainerMBS.discoverUserInfoWithEmailAddress(emailAddress as string, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Retrieves information about a single user based on that user’s email address.
Notes:
email: The iCloud email address of the user you want to locate.

Use this method to retrieve the ID of a user that is known to the current user. The user you are searching for must meet the following criteria:

  • The user must be in the current user’s address book.
  • The user must have run the app.
  • The user must have granted the CKApplicationPermissionUserDiscoverability permission for this container.

This method searches for the user asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKDiscoverUserInfosOperationMBS object and configure the desired priority.
CKContainerMBS.discoverUserInfoWithUserRecordID(userRecordID as CKRecordIDMBS, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Retrieves information about a single user based on the ID of the corresponding user record.
Notes:
userRecordID: The ID of the user record.

Use this method to retrieve information about a user for which you already have a user record ID. The user you are searching for must meet the following criteria:

  • The user must have run the app.
  • The user must have granted the CKApplicationPermissionUserDiscoverability permission for this container.

This method searches for the user asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKDiscoverUserInfosOperationMBS object and configure the desired priority.
CKContainerMBS.fetchAllLongLivedOperationIDs(tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Returns the identifiers of the running or recently completed long-lived operations.
Notes: A long-lived operation is an operation that continues to run after the app exits, described in CKOperationMBS. To get the operation object for an identifier, use the fetchLongLivedOperationWithID method.
CKContainerMBS.fetchLongLivedOperationWithID(operationID as string, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Returns the running or recently completed long-lived operation specified by the operation identifier.
Notes:
operationID: The identifier of the long-lived operation you want to fetch.

A long-lived operation is an operation that continues to run after the app exits, described in CKOperationMBS. To receive the callbacks for a long-lived operations, set its completion block and add it to an operation queue.
CKContainerMBS.fetchShareParticipantWithEmailAddress(emailAddress as string, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Retrieves information about a single share participant (a person who accepted a shared record) based on that participant’s email address.
Notes:
emailAddress: The iCloud email address of the share participant you want to locate.

This method searches for the share participant asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKFetchShareParticipantsOperationMBS object and configure the desired priority.
CKContainerMBS.fetchShareParticipantWithPhoneNumber(phoneNumber as string, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Retrieves information about a single share participant (a person who accepted a shared record) based on that participant’s phone number.
Notes:
phoneNumber: The phone number used to locate the share participant.

This method searches for the share participant asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKFetchShareParticipantsOperationMBS object and configure the desired priority.
CKContainerMBS.fetchShareParticipantWithUserRecordID(userRecordID as CKRecordIDMBS, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Retrieves information about a single share participant based on the ID of the corresponding user record.
Notes:
userRecordID: The ID of the user record.

This method searches for the share participant asynchronously and with a low priority. If you want the task to execute with a higher priority, create a CKFetchShareParticipantsOperationMBS object and configure the desired priority.
CKContainerMBS.fetchUserRecordID(tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Returns the user record ID associated with the current user.
Notes: At startup time, fetching the user record ID may take longer while CloudKit makes the initial iCloud account request. After the initial fetch, accessing the user record ID should take less time. If no iCloud account is associated with the device, or if access to the user’s iCloud account is restricted, this method returns an error of type CKErrorNotAuthenticated.
CKContainerMBS.registerCloudKitShare(Share as CKShareMBS, ServiceItems as Variant)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 21.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Registers a CloudKit share for the user to modify.
Example:
// The following example shows how to create an item provider with an existing share. It then invokes the cloud-sharing service with the provider and presents the share’s configuration to the user.

Public Sub modifyShare(share as CKShareMBS, container as CKContainerMBS)
// Create an item provider and register a share that
// already exists on the server.

Dim itemProvider As New NSSharingServiceItemsMBS
container.registerCloudKitShare(share, itemProvider)

// Create and invoke the cloud-sharing service to
// present the share configuration to the user.
Dim service As NSSharingServiceMBS
service = NSSharingServiceMBS.sharingServiceNamed(NSSharingServiceMBS.NSSharingServiceNameCloudSharing)

If service <> Nil Then
If service.canPerformWithItems(itemProvider) then
service.performWithItems(itemProvider)
end if
End If

End Sub
Notes:
share: The CloudKit share to modify.
self: The CloudKit container that stores the shared records.
ServiceItems: the NSSharingServiceItemsMBS object to add the item provider.

Use this method when the CloudKit share already exists on the server and you want to update it. The behavior of the sharing service depends on the role of the current user. An owner can edit the share’s configuration, which includes managing participants and their permissions. A participant can view the share’s configuration and choose to stop participating.
If you’re unsure which container to use, fetch the share’s metadata using CKFetchShareMetadataOperationMBS. Then initialize an instance of CKContainer using the metadata’s containerIdentifier property.
Use the NSCloudSharingServiceMBS events to respond to any changes the sharing service makes.

To create a new share, use the registerCloudKitShareWithPreparationHandler method instead.
CKContainerMBS.registerCloudKitShareWithPreparationHandler(ServiceItems as Variant, tag as variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 21.3 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Registers a handler that prepares a new CloudKit share.
Notes:
Calls registerCloudKitShareWithPreparationHandler event to let you fill in code.

ServiceItems: the NSSharingServiceItemsMBS object to add the item provider.
Tag: Variant passed through.

Use this method to share a hierarchy of CloudKit records with other iCloud users. When the service invokes the handler, create an instance of CKShare with a root record. Save the share to the server using CKModifyRecordsOperationMBS. The root record (and its hierarchy) must already exist on the server or be part of the same save operation. After the share saves, call preparationCompletionHandler with the saved share and its container. If the save fails, pass the error to the completion handler instead. Invoking the sharing service with a share you register using this method prompts the user to begin sharing.
Use the NSCloudSharingServiceMBS events to respond to any changes the sharing service makes.

See also:

CKContainerMBS.requestApplicationPermission(applicationPermission as Integer, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Requests the specified permission from the user to make the user’s identity discoverable.
Notes:
applicationPermission: The requested permission. This requested permission applies to the current container only and will not impact permissions granted for other containers. For a list of possible values, see CKApplicationPermissions.

To implement social features in your app, it is possible to correlate a user record with the user’s actual name, but your app must get permission from the user to do so. Making a user record discoverable to the friends (contacts) of that user involves calling the the requestApplicationPermission method and asking for the CKApplicationPermissionUserDiscoverability permission. When you call that method, CloudKit asks the user on your behalf whether the user record should be made discoverable. If the user grants the request, that user’s contacts can discover that user’s true identity when running the app. To discover the contacts of the current user, you use the discoverAllContactUserInfos method or one of several other methods to get the related user information.

The first time you request a permission on any of the user’s devices, the user is prompted to grant or deny the request. Once the user grants or denies a permission, subsequent requests for the same permission (on the same or separate devices), do not prompt the user again.

This method runs asynchronously and delivers the results to the block you provide.
CKContainerMBS.statusForApplicationPermission(applicationPermission as Integer, tag as Variant = nil)
Type Topic Plugin Version macOS Windows Linux iOS Targets
method CloudKit MBS Mac64bit Plugin 16.5 ✅ Yes ❌ No ❌ No ✅ Yes All
Function: Checks the status of the specified permission asynchronously.
Notes:
applicationPermission: The permission whose status you want to check. For a list of possible values, see CKApplicationPermissions.

Use this method to determine the extra capabilities granted to your app by the user. If your app has not yet requested a specific permission, calling this method may yield the value CKApplicationPermissionStatusInitialState for the permission. When that value is returned, call the requestApplicationPermission method to request the permission from the user.

The items on this page are in the following plugins: MBS Mac64bit Plugin.

Feedback: Report problem or ask question.

The biggest plugin in space...


Start Chat