ARTMessageSendStatus

Objective-C

@interface ARTMessageSendStatus : NSObject

Swift

class ARTMessageSendStatus : NSObject

Describes the result of a ProtocolMessage send operation (i.e. whether successful or error), and provides the PublishResult contained in the ACK for the message (if any).

  • The underlying status of the operation (state + errorInfo).

    Declaration

    Objective-C

    @property (nonatomic, readonly) ARTStatus *_Nonnull status;

    Swift

    var status: ARTStatus { get }

  • The publish result corresponding to the ProtocolMessage that was sent, as extracted from the ACK. This will be nil for NACK responses, error conditions, or messages that did not request acknowledgment.

    Declaration

    Objective-C

    @property (nonatomic, readonly, nullable) ARTPublishResult *publishResult;

    Swift

    var publishResult: ARTPublishResult? { get }

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Creates a new ARTMessageSendStatus with the given status and optional publish result.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithStatus:(nonnull ARTStatus *)status
                         publishResult:
                             (nullable ARTPublishResult *)publishResult;

    Swift

    init(status: ARTStatus, publishResult: ARTPublishResult?)

  • Convenience constructor for ACK responses with publish results.

    Declaration

    Objective-C

    + (nonnull instancetype)okWithPublishResult:
    (nullable ARTPublishResult *)publishResult;

    Swift

    class func ok(with publishResult: ARTPublishResult?) -> Self

  • Convenience constructor for error responses (NACK or validation errors).

    Declaration

    Objective-C

    + (nonnull instancetype)errorWithInfo:(nullable ARTErrorInfo *)errorInfo;

    Swift

    class func error(with errorInfo: ARTErrorInfo?) -> Self