EMOobProviderToUserMessage Protocol Reference

Conforms to EMOobIncomingMessage
EMOobMessageMeta
Declared in EMOobProviderToUserMessage.h

Overview

Interface of an incoming user message from the server.

  locale required method

Gets the locale the message content is for.

@property (nonatomic, copy, readonly) NSString *locale

Return Value

The locale.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  contentType required method

Gets the content type of the generic message.

@property (nonatomic, copy, readonly) NSString *contentType

Return Value

The content type.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  content required method

Gets message content as secure byte array.

@property (nonatomic, strong, readonly) id<EMSecureByteArray> content

Return Value

The content.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  contentString required method

Gets message content in form of secure string.

@property (nonatomic, strong, readonly) id<EMSecureString> contentString

Return Value

The content.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  subject required method

Gets message subject

@property (nonatomic, copy, readonly) id<EMSecureString> subject

Return Value

The subject.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  createTime required method

Gets the message creation date.

@property (nonatomic, assign, readonly) NSTimeInterval createTime

Return Value

The creation date.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  from required method

Gets the message originator.

@property (nonatomic, copy, readonly) NSString *from

Return Value

The originator.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  to required method

Gets the message recipient.

@property (nonatomic, copy, readonly) NSString *to

Return Value

The recipient.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  replyTo required method

Gets the recipient to use for a response.

@property (nonatomic, copy, readonly) NSString *replyTo

Return Value

The response’s recipient.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  threadId required method

Gets the message thread identifier.

@property (nonatomic, copy, readonly) NSString *threadId

Return Value

The thread identifier.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

  attachments required method

Gets messages attachments.

@property (nonatomic, copy, readonly) NSArray *attachments

Return Value

The attachments.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

– contentStringWithEncoding: required method

Gets message content in form of secure string in specific encoding format.

- (id<EMSecureString>)contentStringWithEncoding:(NSStringEncoding)encoding

Parameters

encoding

A string encoding.

Return Value

The content.

Availability

3.0

Declared In

EMOobProviderToUserMessage.h

– createResponseWithLocale:createTime:subject:from:contentType:content:attachments:meta: required method

Create an outgoing response for the current message.

- (id<EMOobUserToProviderMessage>)createResponseWithLocale:(NSString *)aLocale createTime:(NSTimeInterval)aCreateTime subject:(id<EMSecureString>)aSubject from:(NSString *)aFrom contentType:(NSString *)aContentType content:(id<EMSecureByteArray>)aContent attachments:(NSArray *)anAttachments meta:(NSDictionary *)aMeta

Parameters

aLocale

Locale to use to handle messages.
aCreateTime

Message creation time. If nil the default system time is used.
aSubject

Message subject.
aFrom

Message originator. Can be nil.
aContentType

Message content-type.
aContent

Message content.
anAttachments

Array of attachments to the message. Can be nil.
aMeta

Meta data for the message. Can be nil.

Return Value

The outgoing message ready to be sent.

Availability

3.0

Discussion

The recipient field (to) of the created message is set to the value of the response recipient (replyTo) of the incoming message.

The response thread identifier field (threadId) is set to the same value than the incoming message.

Declared In

EMOobProviderToUserMessage.h