TransloaditAssembly class

Object representation of a new Assembly to be created.

Inheritance

Constructors

TransloaditAssembly({required TransloaditClient client, Map<String, XFile>? files, Map<String, dynamic>? options})

Properties

client TransloaditClient
An instance of the Transloadit class.
getter/setter pairoverride
files Map<String, XFile>
Storage of files to be uploaded. Each file is stored with a key corresponding to its field name when it is being uploaded.
getter/setter pairoverride
hashCode int
The hash code for this object.
no setterinherited
options Map<String, dynamic>
Returns the Assembly options in a Transloadit-ready format.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
steps Map<String, dynamic>
Temporary storage of steps, later converted to options.
getter/setter pairinherited

Methods

addFile({required File file, String? fieldName}) → void
Add a file to be uploaded along with the Assembly.
addStep(String name, String robot, Map<String, dynamic> options) → void
Adds a step to the Assembly/Template, with the given robot and options
inherited
clearFiles() → void
Removes all files
createAssembly({dynamic onProgress(double)?, dynamic onComplete()?}) Future<TransloaditResponse>
Creates the Assembly using the options specified. onProgress returns the progress of the file upload onComplete will call when the file is uploaded and the assembly is processing
getFieldName() String
Creates a unique field-name for each file.
isAssemblyFinished(TransloaditResponse response) bool
Returns whether the assembly has finished, whether successful or not
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
removeFile({required String fieldName}) → void
Removes a file with the given fieldName
removeStep(String name) → void
Removes a step from the Assembly/Template with this name
inherited
toString() String
A string representation of this object.
inherited
tusUpload(String assemblyURL, String tusURL, {dynamic onProgress(double)?, dynamic onComplete()?}) Future<void>
Uploads files to the Assembly via the Tus protocol.

Operators

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