RemoveTemplate

Overview

This class contains a collection of classes to represent the results of the template deletion operation.

Types

Result

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

Properties

Name	Type	Description
errorCodeDetails	Map< Int, ErrorCode>	Detailed error codes for each template removal operation.
errorCode	SummaryErrorCode	The summary error code indicating the overall result of the template removal operation.
allLogs	List<Log>	Logs related to the template removal operation.

SummaryErrorCode

Declaration

enum class SummaryErrorCode(val id: Int) {
    AllSuccess(0 + SummaryErrorCodeBaseID),
    PartialSuccess(1 + SummaryErrorCodeBaseID),
    AllFailed(2 + SummaryErrorCodeBaseID),
    InitializationFailed(3 + SummaryErrorCodeBaseID),
    InvalidArgument(4 + SummaryErrorCodeBaseID),
    UnknownError(99 + SummaryErrorCodeBaseID),
}

ErrorCode

Declaration

enum class ErrorCode(val id: Int) {
    NoError(0 + ErrorCodeBaseID),
    Unsupported(1 + ErrorCodeBaseID),
    KeyNotFound(2 + ErrorCodeBaseID),
    ConnectionFailed(3 + ErrorCodeBaseID),
    UnresponsiveState(4 + ErrorCodeBaseID),
    Aborted(5 + ErrorCodeBaseID),
    MissingCredential(6 + ErrorCodeBaseID),
    InvalidCredential(7 + ErrorCodeBaseID),
    ExpiredCredential(8 + ErrorCodeBaseID),
    MismatchedCredentialFormat(9 + ErrorCodeBaseID),
    UnknownError(99 + ErrorCodeBaseID),
}

Description

Constant	Description
NoError	The operation was successful.
Unsupported	The printer does not support this operation, or the current connection type is not supported.
KeyNotFound	The specified key was not found in the printer.
ConnectionFailed	The connection to the printer failed.
UnresponsiveState	The printer is in an unresponsive state.
Aborted	The operation was aborted due to an error or cancellation.
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.

Constants

Constant	Value	Description
SummaryErrorCodeBaseID	21000	Base ID for SummaryErrorCode values.
ErrorCodeBaseID	21100	Base ID for ErrorCode values.