CodemagicClient class

Client used to retrieve informations from Codemagic API

Constructors

CodemagicClient({required String authKey, String apiUrl = 'https://api.codemagic.io', int timeoutInSeconds = 30})
CodemagicClient constructor

Properties

apiUrl String
URL of Codemagic API
final
authKey String
Auth key used to authenticate API calls
final
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
timeoutInSeconds int
final

Methods

cancelBuild(String buildId) Future<ApiResponse<CancelBuildResponse>>
Cancels build by is buildId. Returns HTTP 208 if build already cancelled
getApplication(String id) Future<ApiResponse<Application>>
Retrieves information about specific Application by its id
getBuilds() Future<ApiResponse<Builds>>
Retrieves Builds object containing list of Applications and Builds
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
startBuild(String appId, String workflowId, String branch) Future<ApiResponse<BuildResponse>>
Starts new build for Application by its appId, workflowId and branch
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited