SBDMessageRetrievalParams Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in SBDMessageRetrievalParams.h

Overview

An object that represents the parameters for the getMessageWithParams:completionHandler: method. The method returns the message defined by the properties in this object.

Note: This class is available from 3.0.181

  channelUrl

Specifies the URL of the channel to retrieve the message.

@property (strong, nonnull) NSString *channelUrl

Availability

3.0.181

Declared In

SBDMessageRetrievalParams.h

  channelType

Specifies the type of the channel.

@property (atomic) SBDChannelType channelType

Availability

3.0.181

Declared In

SBDMessageRetrievalParams.h

  messageId

Specifies the unique ID of the message to retrieve.

@property (atomic) long long messageId

Availability

3.0.181

Declared In

SBDMessageRetrievalParams.h

  includeMetaArray

Determines whether the metaarray of the message is included in the results.

@property (atomic) BOOL includeMetaArray

Availability

3.0.181

Declared In

SBDMessageRetrievalParams.h

  includeParentMessageText

Determines whether to include the parent message text in the results when the message is a reply in a thread. If the type of the parent message is SBDUserMessage, the value is a message. If it is SBDFileMessage, the value is the name of the uploaded file.

@property (atomic) BOOL includeParentMessageText

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageRetrievalParams.h

  includeThreadInfo

Determines whether to include the thread information of the message when it is a parent message.

@property (atomic) BOOL includeThreadInfo

Availability

3.0.181

Discussion

Note: The default value is NO.

Declared In

SBDMessageRetrievalParams.h