BRLMTransferResult

Overview

The BRLMTransferResult class provides the result of a transfer operation. This includes the overall success or failure status, detailed error codes for each operation, and logs.

Properties

Name	Type	Description
errorDetails	NSDictionary< ObjectType, NSNumber/BRLMTransferErrorCode*/>	Detailed error codes for each transfer operation, where ObjectType represents the value of the transfer operation's argument.
code	BRLMTransferSummaryErrorCode	The summary error code indicating the overall result of the transfer operation.
allLogs	NSArray<BRLMLog>	Logs related to the transfer operation.

BRLMTransferSummaryErrorCode

Declaration

typedef NS_ENUM(NSUInteger, BRLMTransferSummaryErrorCode) {
    BRLMTransferSummaryErrorAllSuccess = 21100,
    BRLMTransferSummaryErrorPartialSuccess,
    BRLMTransferSummaryErrorAllFailed,
    BRLMTransferSummaryErrorInitializationFailed,
    BRLMTransferSummaryErrorInvalidArgument,
    BRLMTransferSummaryErrorUnknownError = 21199,
};

Description

Constant	Description
AllSuccess	All operations were successful.
PartialSuccess	Some operations were successful, while others failed.
AllFailed	All operations failed.
InitializationFailed	The initialization of the operation failed.
InvalidArgument	An invalid argument was provided.
UnknownError	An unknown error occurred.

BRLMTransferErrorCode

Declaration

typedef NS_ENUM(NSUInteger, BRLMTransferErrorCode) {
    BRLMTransferErrorCodeNoError = 10100,
    BRLMTransferErrorCodeUnsupportedFunction,
    BRLMTransferErrorCodeUnsupportedFunctionByCurrentConnectionInterface,
    BRLMTransferErrorCodeFileNotFound,
    BRLMTransferErrorCodeUnsupportedFile,
    BRLMTransferErrorCodeFileNotForSelectedPrinter,
    BRLMTransferErrorCodePrinterStatusError,
    BRLMTransferErrorCodeConnectionFailed,
    BRLMTransferErrorCodeAborted,
    BRLMTransferErrorCodeMissingCredential,
    BRLMTransferErrorCodeInvalidCredential,
    BRLMTransferErrorCodeExpiredCredential,
    BRLMTransferErrorCodeMismatchedCredentialFormat,
    BRLMTransferErrorCodeUnknownError = 10199,
};

Description

Constant	Description
NoError	The operation was successful.
UnsupportedFunction	The function is not supported by the printer.
UnsupportedFunctionByCurrentConnectionInterface	The function is not supported by the current connection interface, but may be supported by other interfaces.
FileNotFound	The specified file was not found.
UnsupportedFile	The file format is not supported, or the file is corrupted.
FileNotForSelectedPrinter	The file is not compatible with the selected printer.
PrinterStatusError	The printer is in an unresponsive state.
ConnectionFailed	The connection to the printer failed.
Aborted	The operation was aborted due to cancellation or an error.
MissingCredential	Required credential was not provided.
InvalidCredential	The provided credential is invalid.
ExpiredCredential	The provided credential has expired. This may also include cases where the operation is rejected due to the initial password being set.
MismatchedCredentialFormat	The credential format does not match the expected format.
UnknownError	An unknown error occurred.