TransloaditClient class - transloadit library

Constructors

TransloaditClient({String service = "api2.transloadit.com", required String authKey, required String authSecret, int duration = 300, TransloaditRequest? request})

Properties

authKey ↔ String: Transloadit auth key.
getter/setter pair
authSecret ↔ String: Transloadit auth secret.
getter/setter pair
duration ↔ int: How long in seconds for which a Transloadit request should be valid.
getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
request ↔ TransloaditRequest: An instance of the Transloadit HTTP Request object.
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
service ↔ String: URL of the Transloadit API.
getter/setter pair

Methods

assemblyFromTemplate({required String templateID, Map<String, dynamic>? params}) → TransloaditAssembly: Creates an Assembly object from a template.
cancelAssembly({String assemblyID = '', String assemblyURL = ''}) → Future<TransloaditResponse>: Cancels a running Assembly.
deleteTemplate({required String templateID}) → Future<TransloaditResponse>: Deletes a Template of a given templateID.
getAssembly({String assemblyID = '', String assemblyURL = ''}) → Future<TransloaditResponse>: Gets a Transloadit assembly from an assemblyID or assemblyURL
getAssemblyID(String assemblyID, String assemblyURL) → String: Utility function to get the assembly ID either from the one supplied or from a URL
getAssemblyNotifications({Map<String, dynamic>? params}) → Future<TransloaditResponse>: Retrieves a list of recent Assembly Notifications
getBill({required DateTime date}) → Future<TransloaditResponse>: Gets the bill for a given date Example response body: https://transloadit.com/docs/api/#response
getJobSlots() → Future<TransloaditResponse>: Retrieves the sum of priority job slots that are currently in use in the count field of the response
getTemplate({required String templateID}) → Future<TransloaditResponse>: Gets a Transloadit template from a templateID
listAssemblies({Map<String, dynamic>? params}) → Future<TransloaditResponse>: Gets a list of Transloadit assemblies
newAssembly({Map<String, dynamic>? params}) → TransloaditAssembly: Creates an Assembly object with optional params.
newTemplate({required String name, Map<String, dynamic>? params}) → TransloaditTemplate: Creates an Template object with optional params.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
replayAssembly({required String assemblyID, Map<String, dynamic>? params}) → Future<TransloaditResponse>: Attempts to recover the input files and retry the execution of an Assembly Specify params to change details of the Assembly https://transloadit.com/docs/api/#supported-keys-inside-the-params-field
replayAssemblyNotification({required String assemblyID, Map<String, dynamic>? params}) → Future<TransloaditResponse>: Replays an Assembly Notification of a given assemblyID
toString() → String: A string representation of this object.
inherited
updateTemplate({required String templateID, required Map<String, dynamic> template, Map<String, dynamic>? params}) → Future<TransloaditResponse>: Updates a Transloadit template from a templateID merge is still being implemented (does nothing currently)

Operators

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