Arguments class
Comprehensive Xcrun arguments for automated iOS App Store distribution.
Extends PublisherArguments to provide Xcrun-specific configuration for
distributing iOS applications through App Store Connect. Supports advanced
features like JWT authentication, app validation, and multi-platform support.
Key capabilities:
- Xcrun altool integration
- App Store Connect API authentication
- Application validation workflows
- Bundle and version management
- Multi-platform iOS distribution
- Automated upload processes
Example usage:
final args = Arguments(
variables,
filePath: '/path/to/MyApp.ipa',
apiKey: 'ABC123DEF4',
apiIssuer: '12345678-1234-1234-1234-123456789012',
bundleId: 'com.example.myapp',
type: 'ios',
validateApp: true,
);
- Inheritance
-
- Object
- JobArguments
- PublisherArguments
- Arguments
Constructors
- Arguments(Variables variables, {required String filePath, String? username, String? password, String? apiKey, String? apiIssuer, String? appleId, String? bundleVersion, String? bundleShortVersionString, String? ascPublicId, String? type, bool validateApp = false, String? uploadPackage, String? bundleId, String? productId, String? sku, String? outputFormat})
- Creates a new Xcrun publisher arguments instance.
- Arguments.defaultConfigs(ArgResults? globalResults)
-
Creates default Xcrun configuration for basic usage.
factory
- Arguments.fromArgParser(ArgResults results, ArgResults? globalResults)
-
Creates Arguments instance from command-line arguments.
factory
-
Arguments.fromJson(Map<
String, dynamic> json, {required Variables variables}) -
Creates Arguments instance from JSON configuration.
factory
Properties
- apiIssuer → String?
-
App Store Connect API issuer identifier for JWT authentication.
final
- apiKey → String?
-
App Store Connect API key identifier for JWT authentication.
final
- appleId → String?
-
Apple ID of the target application package.
final
-
argumentBuilder
↔ List<
String> -
Builds the Xcrun altool command arguments list.
getter/setter pairinherited-setteroverride-getter
-
arguments
→ Future<
List< String> > -
Processes variables in arguments and returns the final command-line arguments.
no setterinherited
- ascPublicId → String?
-
App Store Connect public ID for multi-provider accounts.
final
- binaryType → String
-
The type of application binary being published.
finalinherited
- bundleId → String?
-
Bundle identifier (CFBundleIdentifier) of the application.
final
- bundleShortVersionString → String?
-
Bundle short version string (CFBundleShortVersionString).
final
- bundleVersion → String?
-
Bundle version (CFBundleVersion) of the application.
final
- filePath ↔ String
-
The file system path to the application binary to be published.
getter/setter pairinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- logger ↔ ColorizeLogger
-
Logger instance for outputting colored messages.
getter/setter pairinherited
- outputFormat → String?
-
Output format for command execution results.
final
- parent ↔ PublisherJob
-
Reference to the parent publisher job that contains this publisher.
getter/setter pairinherited
- password → String?
-
Password for Apple ID authentication.
final
- productId → String?
-
Product identifier for hosted content distribution.
final
- publisher → String
-
The name identifier of the publisher platform.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sku → String?
-
Stock Keeping Unit (SKU) for hosted content.
final
- type → String?
-
Platform type for the application distribution.
final
- uploadPackage → String?
-
Path to the application archive for upload operations.
final
- username → String?
-
Apple ID username for App Store Connect authentication.
final
- validateApp → bool
-
Whether to validate the application before uploading.
final
- variables → Variables
-
Variable processor for substituting placeholders in arguments.
finalinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
printJob(
) → Future -
Prints job configuration information to the console.
inherited
-
processFilesArgs(
) → Future< void> -
Processes and validates file arguments before publishing.
inherited
-
publish(
) → Future< int> -
Initiates the application publishing process.
inherited
-
toJson(
) → Map< String, dynamic> -
Serializes Arguments instance to JSON format.
override
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- parser ↔ ArgParser
-
Command-line argument parser for Xcrun publisher.
getter/setter pair