getFileDataUploadStatus method
Check FileData Upload Status Retrieves the upload status for file upload. Can currently only be accessed when `status` is `waiting`. Trying to access it on a file version already uploaded currently times out.
Parameters:
fileId
- Must be a valid file ID.versionId
- Version ID of the asset.fileType
- Type of file.cancelToken
- ACancelToken
that can be used to cancel the operationheaders
- Can be used to add additional headers to the requestextras
- Can be used to add flags to the requestvalidateStatus
- AValidateStatus
callback that can be used to determine request success based on the HTTP status of the responseonSendProgress
- AProgressCallback
that can be used to get the send progressonReceiveProgress
- AProgressCallback
that can be used to get the receive progress
Returns a Future containing a Response
with a FileVersionUploadStatus as data
Throws DioException
if API call or serialization fails
Implementation
Future<Response<FileVersionUploadStatus>> getFileDataUploadStatus({
required String fileId,
required int versionId,
required String fileType,
CancelToken? cancelToken,
Map<String, dynamic>? headers,
Map<String, dynamic>? extra,
ValidateStatus? validateStatus,
ProgressCallback? onSendProgress,
ProgressCallback? onReceiveProgress,
}) async {
final _path = r'/file/{fileId}/{versionId}/{fileType}/status'
.replaceAll('{' r'fileId' '}', fileId.toString())
.replaceAll('{' r'versionId' '}', versionId.toString())
.replaceAll('{' r'fileType' '}', fileType.toString());
final _options = Options(
method: r'GET',
headers: <String, dynamic>{
...?headers,
},
extra: <String, dynamic>{
'secure': <Map<String, String>>[
{
'type': 'apiKey',
'name': 'authCookie',
'keyName': 'auth',
'where': '',
},
],
...?extra,
},
validateStatus: validateStatus,
);
final _response = await _dio.request<Object>(
_path,
options: _options,
cancelToken: cancelToken,
onSendProgress: onSendProgress,
onReceiveProgress: onReceiveProgress,
);
FileVersionUploadStatus? _responseData;
try {
final rawData = _response.data;
_responseData = rawData == null
? null
: deserialize<FileVersionUploadStatus, FileVersionUploadStatus>(
rawData, 'FileVersionUploadStatus',
growable: true);
} catch (error, stackTrace) {
throw DioException(
requestOptions: _response.requestOptions,
response: _response,
type: DioExceptionType.unknown,
error: error,
stackTrace: stackTrace,
);
}
return Response<FileVersionUploadStatus>(
data: _responseData,
headers: _response.headers,
isRedirect: _response.isRedirect,
requestOptions: _response.requestOptions,
redirects: _response.redirects,
statusCode: _response.statusCode,
statusMessage: _response.statusMessage,
extra: _response.extra,
);
}