Class MacOSPrivacyAccessControlItem

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataType

    public class MacOSPrivacyAccessControlItem
    extends Object
    implements com.github.davidmoten.odata.client.ODataType
    “Represents per-process privacy preferences.”
    • Field Detail

      • contextPath

        protected com.github.davidmoten.odata.client.ContextPath contextPath
      • unmappedFields

        protected com.github.davidmoten.odata.client.internal.UnmappedFieldsImpl unmappedFields
      • odataType

        protected String odataType
      • accessibility

        protected Enablement accessibility
      • appleEventsAllowedReceiversNextLink

        protected String appleEventsAllowedReceiversNextLink
      • blockCamera

        protected Boolean blockCamera
      • blockListenEvent

        protected Boolean blockListenEvent
      • blockMicrophone

        protected Boolean blockMicrophone
      • blockScreenCapture

        protected Boolean blockScreenCapture
      • codeRequirement

        protected String codeRequirement
      • displayName

        protected String displayName
      • fileProviderPresence

        protected Enablement fileProviderPresence
      • identifier

        protected String identifier
      • speechRecognition

        protected Enablement speechRecognition
      • staticCodeValidation

        protected Boolean staticCodeValidation
      • systemPolicyAllFiles

        protected Enablement systemPolicyAllFiles
      • systemPolicyDesktopFolder

        protected Enablement systemPolicyDesktopFolder
      • systemPolicyDocumentsFolder

        protected Enablement systemPolicyDocumentsFolder
      • systemPolicyDownloadsFolder

        protected Enablement systemPolicyDownloadsFolder
      • systemPolicyNetworkVolumes

        protected Enablement systemPolicyNetworkVolumes
      • systemPolicyRemovableVolumes

        protected Enablement systemPolicyRemovableVolumes
      • systemPolicySystemAdminFiles

        protected Enablement systemPolicySystemAdminFiles
    • Constructor Detail

      • MacOSPrivacyAccessControlItem

        protected MacOSPrivacyAccessControlItem()
    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
      • getAccessibility

        public Optional<Enablement> getAccessibility()
        “Allow the app or process to control the Mac via the Accessibility subsystem.”
        Returns:
        property accessibility
      • withAccessibility

        public MacOSPrivacyAccessControlItem withAccessibility​(Enablement accessibility)
        Returns an immutable copy of this with just the accessibility field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow the app or process to control the Mac via the Accessibility subsystem.”

        Parameters:
        accessibility - new value of accessibility field (as defined in service metadata)
        Returns:
        immutable copy of this with just the accessibility field changed
      • getAddressBook

        public Optional<Enablement> getAddressBook()
        “Allow or block access to contact information managed by Contacts.”
        Returns:
        property addressBook
      • withAddressBook

        public MacOSPrivacyAccessControlItem withAddressBook​(Enablement addressBook)
        Returns an immutable copy of this with just the addressBook field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to contact information managed by Contacts.”

        Parameters:
        addressBook - new value of addressBook field (as defined in service metadata)
        Returns:
        immutable copy of this with just the addressBook field changed
      • getAppleEventsAllowedReceivers

        public com.github.davidmoten.odata.client.CollectionPage<MacOSAppleEventReceiver> getAppleEventsAllowedReceivers()
        “Allow or deny the app or process to send a restricted Apple event to another app or process. You will need to know the identifier, identifier type, and code requirement of the receiving app or process. This collection can contain a maximum of 500 elements.”
        Returns:
        property appleEventsAllowedReceivers
      • getAppleEventsAllowedReceivers

        public com.github.davidmoten.odata.client.CollectionPage<MacOSAppleEventReceiver> getAppleEventsAllowedReceivers​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Allow or deny the app or process to send a restricted Apple event to another app or process. You will need to know the identifier, identifier type, and code requirement of the receiving app or process. This collection can contain a maximum of 500 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property appleEventsAllowedReceivers
      • getBlockCamera

        public Optional<Boolean> getBlockCamera()
        “Block access to camera app.”
        Returns:
        property blockCamera
      • withBlockCamera

        public MacOSPrivacyAccessControlItem withBlockCamera​(Boolean blockCamera)
        Returns an immutable copy of this with just the blockCamera field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Block access to camera app.”

        Parameters:
        blockCamera - new value of blockCamera field (as defined in service metadata)
        Returns:
        immutable copy of this with just the blockCamera field changed
      • getBlockListenEvent

        public Optional<Boolean> getBlockListenEvent()
        “Block the app or process from listening to events from input devices such as mouse, keyboard, and trackpad.Requires macOS 10.15 or later.”
        Returns:
        property blockListenEvent
      • withBlockListenEvent

        public MacOSPrivacyAccessControlItem withBlockListenEvent​(Boolean blockListenEvent)
        Returns an immutable copy of this with just the blockListenEvent field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Block the app or process from listening to events from input devices such as mouse, keyboard, and trackpad.Requires macOS 10.15 or later.”

        Parameters:
        blockListenEvent - new value of blockListenEvent field (as defined in service metadata)
        Returns:
        immutable copy of this with just the blockListenEvent field changed
      • getBlockMicrophone

        public Optional<Boolean> getBlockMicrophone()
        “Block access to microphone.”
        Returns:
        property blockMicrophone
      • withBlockMicrophone

        public MacOSPrivacyAccessControlItem withBlockMicrophone​(Boolean blockMicrophone)
        Returns an immutable copy of this with just the blockMicrophone field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Block access to microphone.”

        Parameters:
        blockMicrophone - new value of blockMicrophone field (as defined in service metadata)
        Returns:
        immutable copy of this with just the blockMicrophone field changed
      • getBlockScreenCapture

        public Optional<Boolean> getBlockScreenCapture()
        “Block app from capturing contents of system display. Requires macOS 10.15 or later.”
        Returns:
        property blockScreenCapture
      • withBlockScreenCapture

        public MacOSPrivacyAccessControlItem withBlockScreenCapture​(Boolean blockScreenCapture)
        Returns an immutable copy of this with just the blockScreenCapture field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Block app from capturing contents of system display. Requires macOS 10.15 or later.”

        Parameters:
        blockScreenCapture - new value of blockScreenCapture field (as defined in service metadata)
        Returns:
        immutable copy of this with just the blockScreenCapture field changed
      • getCalendar

        public Optional<Enablement> getCalendar()
        “Allow or block access to event information managed by Calendar.”
        Returns:
        property calendar
      • withCalendar

        public MacOSPrivacyAccessControlItem withCalendar​(Enablement calendar)
        Returns an immutable copy of this with just the calendar field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to event information managed by Calendar.”

        Parameters:
        calendar - new value of calendar field (as defined in service metadata)
        Returns:
        immutable copy of this with just the calendar field changed
      • getCodeRequirement

        public Optional<String> getCodeRequirement()
        “Enter the code requirement, which can be obtained with the command 'codesign –display -r –' in the Terminal app. Include everything after '=&gt;'.”
        Returns:
        property codeRequirement
      • withCodeRequirement

        public MacOSPrivacyAccessControlItem withCodeRequirement​(String codeRequirement)
        Returns an immutable copy of this with just the codeRequirement field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Enter the code requirement, which can be obtained with the command 'codesign –display -r –' in the Terminal app. Include everything after '=&gt;'.”

        Parameters:
        codeRequirement - new value of codeRequirement field (as defined in service metadata)
        Returns:
        immutable copy of this with just the codeRequirement field changed
      • getDisplayName

        public Optional<String> getDisplayName()
        “The display name of the app, process, or executable.”
        Returns:
        property displayName
      • withDisplayName

        public MacOSPrivacyAccessControlItem withDisplayName​(String displayName)
        Returns an immutable copy of this with just the displayName field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “The display name of the app, process, or executable.”

        Parameters:
        displayName - new value of displayName field (as defined in service metadata)
        Returns:
        immutable copy of this with just the displayName field changed
      • getFileProviderPresence

        public Optional<Enablement> getFileProviderPresence()
        “Allow the app or process to access files managed by another app’s file provider extension. Requires macOS 10.15 or later.”
        Returns:
        property fileProviderPresence
      • withFileProviderPresence

        public MacOSPrivacyAccessControlItem withFileProviderPresence​(Enablement fileProviderPresence)
        Returns an immutable copy of this with just the fileProviderPresence field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow the app or process to access files managed by another app’s file provider extension. Requires macOS 10.15 or later.”

        Parameters:
        fileProviderPresence - new value of fileProviderPresence field (as defined in service metadata)
        Returns:
        immutable copy of this with just the fileProviderPresence field changed
      • getIdentifier

        public Optional<String> getIdentifier()
        “The bundle ID or path of the app, process, or executable.”
        Returns:
        property identifier
      • withIdentifier

        public MacOSPrivacyAccessControlItem withIdentifier​(String identifier)
        Returns an immutable copy of this with just the identifier field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “The bundle ID or path of the app, process, or executable.”

        Parameters:
        identifier - new value of identifier field (as defined in service metadata)
        Returns:
        immutable copy of this with just the identifier field changed
      • getIdentifierType

        public Optional<MacOSProcessIdentifierType> getIdentifierType()
        “A bundle ID is used to identify an app. A path is used to identify a process or executable.”
        Returns:
        property identifierType
      • withIdentifierType

        public MacOSPrivacyAccessControlItem withIdentifierType​(MacOSProcessIdentifierType identifierType)
        Returns an immutable copy of this with just the identifierType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “A bundle ID is used to identify an app. A path is used to identify a process or executable.”

        Parameters:
        identifierType - new value of identifierType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the identifierType field changed
      • getMediaLibrary

        public Optional<Enablement> getMediaLibrary()
        “Allow or block access to music and the media library.”
        Returns:
        property mediaLibrary
      • withMediaLibrary

        public MacOSPrivacyAccessControlItem withMediaLibrary​(Enablement mediaLibrary)
        Returns an immutable copy of this with just the mediaLibrary field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to music and the media library.”

        Parameters:
        mediaLibrary - new value of mediaLibrary field (as defined in service metadata)
        Returns:
        immutable copy of this with just the mediaLibrary field changed
      • getPhotos

        public Optional<Enablement> getPhotos()
        “Allow or block access to images managed by Photos.”
        Returns:
        property photos
      • withPhotos

        public MacOSPrivacyAccessControlItem withPhotos​(Enablement photos)
        Returns an immutable copy of this with just the photos field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to images managed by Photos.”

        Parameters:
        photos - new value of photos field (as defined in service metadata)
        Returns:
        immutable copy of this with just the photos field changed
      • getPostEvent

        public Optional<Enablement> getPostEvent()
        “Control access to CoreGraphics APIs, which are used to send CGEvents to the system event stream.”
        Returns:
        property postEvent
      • withPostEvent

        public MacOSPrivacyAccessControlItem withPostEvent​(Enablement postEvent)
        Returns an immutable copy of this with just the postEvent field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Control access to CoreGraphics APIs, which are used to send CGEvents to the system event stream.”

        Parameters:
        postEvent - new value of postEvent field (as defined in service metadata)
        Returns:
        immutable copy of this with just the postEvent field changed
      • getReminders

        public Optional<Enablement> getReminders()
        “Allow or block access to information managed by Reminders.”
        Returns:
        property reminders
      • withReminders

        public MacOSPrivacyAccessControlItem withReminders​(Enablement reminders)
        Returns an immutable copy of this with just the reminders field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to information managed by Reminders.”

        Parameters:
        reminders - new value of reminders field (as defined in service metadata)
        Returns:
        immutable copy of this with just the reminders field changed
      • getSpeechRecognition

        public Optional<Enablement> getSpeechRecognition()
        “Allow or block access to system speech recognition facility.”
        Returns:
        property speechRecognition
      • withSpeechRecognition

        public MacOSPrivacyAccessControlItem withSpeechRecognition​(Enablement speechRecognition)
        Returns an immutable copy of this with just the speechRecognition field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to system speech recognition facility.”

        Parameters:
        speechRecognition - new value of speechRecognition field (as defined in service metadata)
        Returns:
        immutable copy of this with just the speechRecognition field changed
      • getStaticCodeValidation

        public Optional<Boolean> getStaticCodeValidation()
        “Statically validates the code requirement. Use this setting if the process invalidates its dynamic code signature.”
        Returns:
        property staticCodeValidation
      • withStaticCodeValidation

        public MacOSPrivacyAccessControlItem withStaticCodeValidation​(Boolean staticCodeValidation)
        Returns an immutable copy of this with just the staticCodeValidation field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Statically validates the code requirement. Use this setting if the process invalidates its dynamic code signature.”

        Parameters:
        staticCodeValidation - new value of staticCodeValidation field (as defined in service metadata)
        Returns:
        immutable copy of this with just the staticCodeValidation field changed
      • getSystemPolicyAllFiles

        public Optional<Enablement> getSystemPolicyAllFiles()
        “Control access to all protected files on a device. Files might be in locations such as emails, messages, apps, and administrative settings. Apply this setting with caution.”
        Returns:
        property systemPolicyAllFiles
      • withSystemPolicyAllFiles

        public MacOSPrivacyAccessControlItem withSystemPolicyAllFiles​(Enablement systemPolicyAllFiles)
        Returns an immutable copy of this with just the systemPolicyAllFiles field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Control access to all protected files on a device. Files might be in locations such as emails, messages, apps, and administrative settings. Apply this setting with caution.”

        Parameters:
        systemPolicyAllFiles - new value of systemPolicyAllFiles field (as defined in service metadata)
        Returns:
        immutable copy of this with just the systemPolicyAllFiles field changed
      • getSystemPolicyDesktopFolder

        public Optional<Enablement> getSystemPolicyDesktopFolder()
        “Allow or block access to Desktop folder.”
        Returns:
        property systemPolicyDesktopFolder
      • withSystemPolicyDesktopFolder

        public MacOSPrivacyAccessControlItem withSystemPolicyDesktopFolder​(Enablement systemPolicyDesktopFolder)
        Returns an immutable copy of this with just the systemPolicyDesktopFolder field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to Desktop folder.”

        Parameters:
        systemPolicyDesktopFolder - new value of systemPolicyDesktopFolder field (as defined in service metadata)
        Returns:
        immutable copy of this with just the systemPolicyDesktopFolder field changed
      • getSystemPolicyDocumentsFolder

        public Optional<Enablement> getSystemPolicyDocumentsFolder()
        “Allow or block access to Documents folder.”
        Returns:
        property systemPolicyDocumentsFolder
      • withSystemPolicyDocumentsFolder

        public MacOSPrivacyAccessControlItem withSystemPolicyDocumentsFolder​(Enablement systemPolicyDocumentsFolder)
        Returns an immutable copy of this with just the systemPolicyDocumentsFolder field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to Documents folder.”

        Parameters:
        systemPolicyDocumentsFolder - new value of systemPolicyDocumentsFolder field (as defined in service metadata)
        Returns:
        immutable copy of this with just the systemPolicyDocumentsFolder field changed
      • getSystemPolicyDownloadsFolder

        public Optional<Enablement> getSystemPolicyDownloadsFolder()
        “Allow or block access to Downloads folder.”
        Returns:
        property systemPolicyDownloadsFolder
      • withSystemPolicyDownloadsFolder

        public MacOSPrivacyAccessControlItem withSystemPolicyDownloadsFolder​(Enablement systemPolicyDownloadsFolder)
        Returns an immutable copy of this with just the systemPolicyDownloadsFolder field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to Downloads folder.”

        Parameters:
        systemPolicyDownloadsFolder - new value of systemPolicyDownloadsFolder field (as defined in service metadata)
        Returns:
        immutable copy of this with just the systemPolicyDownloadsFolder field changed
      • getSystemPolicyNetworkVolumes

        public Optional<Enablement> getSystemPolicyNetworkVolumes()
        “Allow or block access to network volumes. Requires macOS 10.15 or later.”
        Returns:
        property systemPolicyNetworkVolumes
      • withSystemPolicyNetworkVolumes

        public MacOSPrivacyAccessControlItem withSystemPolicyNetworkVolumes​(Enablement systemPolicyNetworkVolumes)
        Returns an immutable copy of this with just the systemPolicyNetworkVolumes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow or block access to network volumes. Requires macOS 10.15 or later.”

        Parameters:
        systemPolicyNetworkVolumes - new value of systemPolicyNetworkVolumes field (as defined in service metadata)
        Returns:
        immutable copy of this with just the systemPolicyNetworkVolumes field changed
      • getSystemPolicyRemovableVolumes

        public Optional<Enablement> getSystemPolicyRemovableVolumes()
        “Control access to removable volumes on the device, such as an external hard drive. Requires macOS 10.15 or later.”
        Returns:
        property systemPolicyRemovableVolumes
      • withSystemPolicyRemovableVolumes

        public MacOSPrivacyAccessControlItem withSystemPolicyRemovableVolumes​(Enablement systemPolicyRemovableVolumes)
        Returns an immutable copy of this with just the systemPolicyRemovableVolumes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Control access to removable volumes on the device, such as an external hard drive. Requires macOS 10.15 or later.”

        Parameters:
        systemPolicyRemovableVolumes - new value of systemPolicyRemovableVolumes field (as defined in service metadata)
        Returns:
        immutable copy of this with just the systemPolicyRemovableVolumes field changed
      • getSystemPolicySystemAdminFiles

        public Optional<Enablement> getSystemPolicySystemAdminFiles()
        “Allow app or process to access files used in system administration.”
        Returns:
        property systemPolicySystemAdminFiles
      • withSystemPolicySystemAdminFiles

        public MacOSPrivacyAccessControlItem withSystemPolicySystemAdminFiles​(Enablement systemPolicySystemAdminFiles)
        Returns an immutable copy of this with just the systemPolicySystemAdminFiles field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Allow app or process to access files used in system administration.”

        Parameters:
        systemPolicySystemAdminFiles - new value of systemPolicySystemAdminFiles field (as defined in service metadata)
        Returns:
        immutable copy of this with just the systemPolicySystemAdminFiles field changed
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
      • builder

        public static MacOSPrivacyAccessControlItem.Builder builder()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class