Platforms to show: All Mac Windows Linux Cross-Platform
CKShareParticipantMBS class
Type | Topic | Plugin | Version | macOS | Windows | Linux | iOS | Targets |
class | CloudKit | MBS Mac64bit Plugin | 16.5 | ✅ Yes | ❌ No | ❌ No | ✅ Yes | All |
This is an abstract class. You can't create an instance, but you can get one from various plugin functions.
- 6 properties
- property acceptanceStatus as Integer
- property Handle as Integer
- property permission as Integer
- property role as Integer
- property userIdentity as CKUserIdentityMBS
- 2 methods
- method Constructor Private
- method copy as CKShareParticipantMBS
- shared method Available as Boolean
- 16 constants
Acceptance Status
Constant | Value | Description |
---|---|---|
CKShareParticipantAcceptanceStatusAccepted | 2 |
The participant has accepted the share request. |
CKShareParticipantAcceptanceStatusPending | 1 |
The participant has not accepted the share request. |
CKShareParticipantAcceptanceStatusRemoved | 3 |
The participant was removed from the share. |
CKShareParticipantAcceptanceStatusUnknown | 0 |
The participant’s status is unknown. |
Permissions
Constant | Value | Description |
---|---|---|
CKShareParticipantPermissionNone | 1 |
The participant does not have any permissions for this share. |
CKShareParticipantPermissionReadOnly | 2 |
The participant has read only permissions for this share. |
CKShareParticipantPermissionReadWrite | 3 |
The participant has full read and write permissions for this share. |
CKShareParticipantPermissionUnknown | 0 |
The current status of the participant’s permissions is unknown. |
Participant Roles.
Constant | Value | Description |
---|---|---|
CKShareParticipantRoleOwner | 1 |
The participant is the owner of the share. As owner, the user can add private users to the share. |
CKShareParticipantRolePrivateUser | 3 |
The participant is a private user and can access the share. |
CKShareParticipantRolePublicUser | 4 |
The participant is a private user and can access the share. |
CKShareParticipantRoleUnknown | 0 |
The type of the participant cannot be determined. |
Participant Types.
Constant | Value | Description |
---|---|---|
CKShareParticipantTypeOwner | 1 |
The participant is the owner of the share. As owner, the user can add private users to the share. |
CKShareParticipantTypePrivateUser | 3 |
The participant is a private user and can access the share. |
CKShareParticipantTypePublicUser | 4 |
The participant is a public user. Public users are “self-added” when the participant accesses the shareURL. Owners cannot add public users. |
CKShareParticipantTypeUnknown | 0 |
The type of the participant cannot be determined. |
This class has no sub classes.
Some methods using this class:
- CKShareMBS.addParticipant(participant as CKShareParticipantMBS)
- CKShareMBS.participants as CKShareParticipantMBS()
- CKShareMBS.removeParticipant(participant as CKShareParticipantMBS)
Some properties using for this class:
- CKShareMBS.currentUserParticipant as CKShareParticipantMBS
- CKShareMBS.owner as CKShareParticipantMBS
Some events using this class:
- CKContainerMBS.fetchShareParticipantWithEmailAddressCompleted(emailAddress as String, shareParticipant as CKShareParticipantMBS, error as NSErrorMBS, tag as Variant)
- CKContainerMBS.fetchShareParticipantWithPhoneNumberCompleted(phoneNumber as String,shareParticipant as CKShareParticipantMBS, error as NSErrorMBS, tag as Variant)
- CKContainerMBS.fetchShareParticipantWithUserRecordIDCompleted(userRecordID as CKRecordIDMBS, shareParticipant as CKShareParticipantMBS, error as NSErrorMBS, tag as Variant)
- CKFetchShareParticipantsOperationMBS.shareParticipantFetched(participant as CKShareParticipantMBS)
Blog Entries
Release notes
- Version 21.5
- Added role property to CKShareParticipantMBS class.
The items on this page are in the following plugins: MBS Mac64bit Plugin.
CKShareMetadataMBS - CKSubscriptionMBS