EMOobIncomingMessage Protocol Reference

Conforms to EMOobMessage
Declared in EMOobIncomingMessage.h

Overview

Interface of an incoming message from the OOB server.

  messageType required method

Gets the underlying incoming message type.

@property (nonatomic, copy) NSString *messageType

Return Value

The incoming message type.

Availability

3.0

Declared In

EMOobIncomingMessage.h

  isAcknowledgmentRequested required method

The server acknowledgment state of the message.

@property (nonatomic, assign, readonly) BOOL isAcknowledgmentRequested

Return Value

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

Availability

3.0

Declared In

EMOobIncomingMessage.h

  expirationDate required method

Gets the message expiration date.

@property (nonatomic, assign, readonly) NSTimeInterval expirationDate

Return Value

The expiration date in NSTimeInterval.

Availability

3.0

Declared In

EMOobIncomingMessage.h

– createOobError:errorDescription:exception:externalRef:meta: required method

Creates an outgoing error response for the current message.

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

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.

Availability

3.0

Declared In

EMOobIncomingMessage.h

– createOobError:errorDescription:errorStackTrace:externalRef:meta: required method

Creates an outgoing error response for the current message.

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

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.

Availability

3.0

Declared In

EMOobIncomingMessage.h