Package de.infolektuell.gradle.jpackage.tasks.platform

Interface JpackageMacOSOptions

All Superinterfaces:
org.gradle.process.CommandLineArgumentProvider, JpackagePlatformOptions
public non-sealed interface JpackageMacOSOptions extends JpackagePlatformOptions

  • Method Summary

    Modifier and Type
    Method
    Description
    default Iterable<String>
    asArguments()
     
    org.gradle.api.provider.Property<@NonNull String>
    getMacAppCategory()
    String used to construct LSApplicationCategoryType in application plist.
    org.gradle.api.provider.Property<@NonNull String>
    getMacAppImageSignIdentity()
    Identity used to sign application image.
    org.gradle.api.provider.Property<@NonNull Boolean>
    getMacAppStore()
    Indicates that the jpackage output is intended for the Mac App Store.
    org.gradle.api.file.DirectoryProperty
    getMacDMGContent()
    Include all the referenced content in the dmg.
    org.gradle.api.file.RegularFileProperty
    getMacEntitlements()
    Path to file containing entitlements to use when signing executables and libraries in the bundle.
    org.gradle.api.provider.Property<@NonNull String>
    getMacInstallerSignIdentity()
    Identity used to sign "pkg" installer.
    org.gradle.api.provider.Property<@NonNull String>
    getMacPackageIdentifier()
    An identifier that uniquely identifies the application for macOS Defaults to the main class name.
    org.gradle.api.provider.Property<@NonNull String>
    getMacPackageName()
    Name of the application as it appears in the Menu Bar This can be different from the application name.
    org.gradle.api.provider.Property<@NonNull String>
    getMacPackageSigningPrefix()
    When signing the application package, this value is prefixed to all components that need to be signed that don't have an existing package identifier.
    org.gradle.api.provider.Property<@NonNull Boolean>
    getMacSign()
    Request that the package or the predefined application image be signed.
    org.gradle.api.provider.Property<@NonNull String>
    getMacSigningKeychain()
    Name of the keychain to search for the signing identity If not specified, the standard keychains are used.
    org.gradle.api.provider.Property<@NonNull String>
    getMacSigningKeyUserName()
    Team or username portion of Apple signing identities.

  • Method Details

    • getMacPackageIdentifier

      @Optional @Input org.gradle.api.provider.Property<@NonNull String> getMacPackageIdentifier()
      An identifier that uniquely identifies the application for macOS Defaults to the main class name. May only use alphanumeric (A-Z,a-z,0-9), hyphen (-), and period (.) characters.

    • getMacPackageName

      @Optional @Input org.gradle.api.provider.Property<@NonNull String> getMacPackageName()
      Name of the application as it appears in the Menu Bar This can be different from the application name. This name must be less than 16 characters long and be suitable for displaying in the menu bar and the application Info window. Defaults to the application name.

    • getMacPackageSigningPrefix

      @Optional @Input org.gradle.api.provider.Property<@NonNull String> getMacPackageSigningPrefix()
      When signing the application package, this value is prefixed to all components that need to be signed that don't have an existing package identifier.

    • getMacSign

      @Optional @Input org.gradle.api.provider.Property<@NonNull Boolean> getMacSign()
      Request that the package or the predefined application image be signed.

    • getMacSigningKeychain

      @Optional @Input org.gradle.api.provider.Property<@NonNull String> getMacSigningKeychain()
      Name of the keychain to search for the signing identity If not specified, the standard keychains are used.

    • getMacSigningKeyUserName

      @Optional @Input org.gradle.api.provider.Property<@NonNull String> getMacSigningKeyUserName()
      Team or username portion of Apple signing identities. For direct control of the signing identity used to sign application images or installers use --mac-app-image-sign-identity and/or --mac-installer-sign-identity. This option cannot be combined with --mac-app-image-sign-identity or --mac-installer-sign-identity.

    • getMacAppImageSignIdentity

      @Optional @Input org.gradle.api.provider.Property<@NonNull String> getMacAppImageSignIdentity()
      Identity used to sign application image. This value will be passed directly to --sign option of "codesign" tool. This option cannot be combined with --mac-signing-key-user-name.

    • getMacInstallerSignIdentity

      @Optional @Input org.gradle.api.provider.Property<@NonNull String> getMacInstallerSignIdentity()
      Identity used to sign "pkg" installer. This value will be passed directly to --sign option of "productbuild" tool. This option cannot be combined with --mac-signing-key-user-name.

    • getMacAppStore

      @Optional @Input org.gradle.api.provider.Property<@NonNull Boolean> getMacAppStore()
      Indicates that the jpackage output is intended for the Mac App Store.

    • getMacEntitlements

      @Optional @InputFile @PathSensitive(RELATIVE) org.gradle.api.file.RegularFileProperty getMacEntitlements()
      Path to file containing entitlements to use when signing executables and libraries in the bundle.

    • getMacAppCategory

      @Optional @Input org.gradle.api.provider.Property<@NonNull String> getMacAppCategory()
      String used to construct LSApplicationCategoryType in application plist. The default value is "utilities".

    • getMacDMGContent

      @Optional @InputDirectory @PathSensitive(RELATIVE) org.gradle.api.file.DirectoryProperty getMacDMGContent()
      Include all the referenced content in the dmg. This option can be used multiple times.

    • asArguments

      default Iterable<String> asArguments()
      Specified by:
      asArguments in interface org.gradle.process.CommandLineArgumentProvider