BRLMRemoveTemplateResult

Overview

The BRLMRemoveTemplateResult 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

errorCode

The summary error code indicating the overall result of the template removal operation.

Declaration

@property (nonatomic, readonly) BRLMRemoveTemplateSummaryErrorCode errorCode;

errorCodeDetails

A dictionary containing detailed error codes for each template removal operation. The key (NSNumber*/*int*/) represents the key of the template that was attempted to be removed. The value (NSNumber*/*BRLMRemoveTemplateErrorCode*/) is an NSNumber containing the BRLMRemoveTemplateErrorCode enum value.

Declaration

@property (nonatomic, readonly, nonnull) NSDictionary<NSNumber*/*int*/, NSNumber*/*BRLMRemoveTemplateErrorCode*/>* errorCodeDetails;

allLogs

An array of BRLMLog objects containing logs related to the template removal operation.

Declaration

@property (nonatomic, readonly, nonnull) NSArray<BRLMLog*>* allLogs;

Types

BRLMRemoveTemplateSummaryErrorCode

Declaration

typedef NS_ENUM(NSUInteger, BRLMRemoveTemplateSummaryErrorCode) {
    BRLMRemoveTemplateSummaryErrorCodeAllSuccess = 21000,
    BRLMRemoveTemplateSummaryErrorCodePartialSuccess,
    BRLMRemoveTemplateSummaryErrorCodeAllFailed,
    BRLMRemoveTemplateSummaryErrorCodeInitializationFailed,
    BRLMRemoveTemplateSummaryErrorCodeInvalidArgument,
    BRLMRemoveTemplateSummaryErrorCodeUnknownError = 21099,
};

BRLMRemoveTemplateErrorCode

Declaration

typedef NS_ENUM(NSInteger, BRLMRemoveTemplateErrorCode) {
    BRLMRemoveTemplateErrorCodeNoError = 21100,
    BRLMRemoveTemplateErrorCodeUnsupported,
    BRLMRemoveTemplateErrorCodeKeyNotFound,
    BRLMRemoveTemplateErrorCodeConnectionFailed,
    BRLMRemoveTemplateErrorCodeUnresponsiveState,
    BRLMRemoveTemplateErrorCodeAborted,
    BRLMRemoveTemplateErrorCodeMissingCredential,
    BRLMRemoveTemplateErrorCodeInvalidCredential,
    BRLMRemoveTemplateErrorCodeExpiredCredential,
    BRLMRemoveTemplateErrorCodeMismatchedCredentialFormat,
    BRLMRemoveTemplateErrorCodeUnknownError = 21199,
};

Description

Constant	Description
BRLMRemoveTemplateErrorCodeNoError	The operation was successful.
BRLMRemoveTemplateErrorCodeUnsupported	The printer does not support this operation, or the current connection type is not supported.
BRLMRemoveTemplateErrorCodeKeyNotFound	The specified key was not found in the printer.
BRLMRemoveTemplateErrorCodeConnectionFailed	The connection to the printer failed.
BRLMRemoveTemplateErrorCodeUnresponsiveState	The printer is in an unresponsive state.
BRLMRemoveTemplateErrorCodeAborted	The operation was aborted due to an error or cancellation.
BRLMRemoveTemplateErrorCodeMissingCredential	Required credential was not provided.
BRLMRemoveTemplateErrorCodeInvalidCredential	The provided credential is invalid.
BRLMRemoveTemplateErrorCodeExpiredCredential	The provided credential has expired. This may also include cases where the operation is rejected due to the initial password being set.
BRLMRemoveTemplateErrorCodeMismatchedCredentialFormat	The credential format does not match the expected format.
BRLMRemoveTemplateErrorCodeUnknownError	An unknown error occurred.