EMOobIncomingMessage Protocol Reference


                    
                    
                    messageType

Gets the underlying incoming message type.

Since

3.0

Declaration

Objective-C

@required
@property (nonatomic, copy, readwrite) NSString *messageType;

Swift

var messageType: String! { get set }

Return Value

The incoming message type.


                    
                    
                    isAcknowledgmentRequested

The server acknowledgment state of the message.

Since

3.0

Declaration

Objective-C

@required
@property (nonatomic, assign, unsafe_unretained, readonly)
    BOOL isAcknowledgmentRequested;

Swift

var isAcknowledgmentRequested: Bool { get }

Return Value

YES if the server has requested an acknowledgment, NO otherwise.


                    
                    
                    expirationDate

Gets the message expiration date.

Since

3.0

Declaration

Objective-C

@required
@property (nonatomic, assign, unsafe_unretained, readonly)
    NSTimeInterval expirationDate;

Swift

var expirationDate: TimeInterval { get }

Return Value

The expiration date in NSTimeInterval.


                    
                    
                    -createOobError:errorDescription:exception:externalRef:meta:

Creates an outgoing error response for the current message.

Since

3.0

Declaration

Objective-C

- (id<EMOobErrorMessage>)createOobError:(int)anErrorCode
                       errorDescription:(NSString *)anErrorDescription
                              exception:(NSException *)anException
                            externalRef:(NSString *)anExternalRef
                                   meta:(NSDictionary *)aMeta;

Swift

func createOobError(_ anErrorCode: Int32, errorDescription anErrorDescription: String!, exception anException: NSException!, externalRef anExternalRef: String!, meta aMeta: [AnyHashable : Any]!) -> (any EMOobErrorMessage)!

Parameters

`anErrorCode`	Error code.
`anErrorDescription`	Error description.
`anException`	Exception object. Can be `nil`.
`anExternalRef`	Any external reference. Can be `nil`.
`aMeta`	Meta data for the message. Can be `nil`.

Return Value

The error message ready to be sent.


                    
                    
                    -createOobError:errorDescription:errorStackTrace:externalRef:meta:

Creates an outgoing error response for the current message.

Since

3.0

Declaration

Objective-C

- (id<EMOobErrorMessage>)createOobError:(int)anErrorCode
                       errorDescription:(NSString *)anErrorDescription
                        errorStackTrace:(NSString *)anErrorStackTrace
                            externalRef:(NSString *)anExternalRef
                                   meta:(NSDictionary *)aMeta;

Swift

func createOobError(_ anErrorCode: Int32, errorDescription anErrorDescription: String!, errorStackTrace anErrorStackTrace: String!, externalRef anExternalRef: String!, meta aMeta: [AnyHashable : Any]!) -> (any EMOobErrorMessage)!

Parameters

`anErrorCode`	Error code.
`anErrorDescription`	Error description.
`anErrorStackTrace`	Error stack trace. Can be `nil`.
`anExternalRef`	Any external reference. Can be `nil`.
`aMeta`	Meta data for the message. Can be `nil`.

Return Value

The error message ready to be sent.