SBDBaseMessageParams Class Reference

Inherits from NSObject
Conforms to NSCopying
Declared in SBDBaseMessageParams.h

Overview

The SBDBaseMessageParams class represents the base class which has parameters to create a channel or update a channel. The SBDUserMessageParams, the SBDFileMessageParams are derived from this class.

  data

Message data. The default value is nil.

@property (copy, nonatomic, nullable) NSString *data

Availability

3.0.90

Declared In

SBDBaseMessageParams.h

  customType

Customize message’s type to filter. The default value is nil.

@property (copy, nonatomic, nullable) NSString *customType

Availability

3.0.90

Declared In

SBDBaseMessageParams.h

  pushNotificationDeliveryOption

The push notification delivery option that determines how to deliver the push notification when sending a user or a file message. The default value is SBDPushNotificationDeliveryOptionDefault.

@property (nonatomic) SBDPushNotificationDeliveryOption pushNotificationDeliveryOption

Declared In

SBDBaseMessageParams.h

  metaArrayKeys

Meta array keys. (Deprecated: 3.0.179. (Use metaArrays instead))

@property (copy, nonatomic, nullable) NSArray<NSString*> *metaArrayKeys

Declared In

SBDBaseMessageParams.h

  metaArrays

Meta array with keys and values

@property (copy, nonatomic, nullable) NSArray<SBDMessageMetaArray*> *metaArrays

Availability

3.0.179

Declared In

SBDBaseMessageParams.h

  mentionType

3.0.103

@property (nonatomic) SBDMentionType mentionType

Availability

3.0.103

Declared In

SBDBaseMessageParams.h

  mentionedUserIds

Can mention to specific users. If sends a message with this field, the message will be arrived to mentioned users. The default value is nil.

@property (copy, nonatomic, nullable) NSArray<NSString*> *mentionedUserIds

Availability

3.0.90

Declared In

SBDBaseMessageParams.h

– setMentionedUsers:

Can set the mentionedUserIds by this method either.

- (void)setMentionedUsers:(nonnull NSArray<SBDUser*> *)mentionedUsers

Parameters

mentionedUsers

The list of users will be receive mention.

Availability

3.0.90

Declared In

SBDBaseMessageParams.h

  parentMessageId

The unique ID of a parent message. A parent message is a message that has a thread of replies. If the message sent through the sendUserMessageWithParams:completionHandler: or sendFileMessageWithParams:completionHandler: method is a parent message, the value of this property is 0. If the message is a reply to a parent message, the value is the message ID of the parent message.

@property (atomic) long long parentMessageId

Availability

3.0.181

Discussion

Note: The default value is 0.

Declared In

SBDBaseMessageParams.h

  appleCriticalAlertOptions

Push notification options for the Apple critical alert. The default value is nil.

@property (strong, nullable) SBDAppleCriticalAlertOptions *appleCriticalAlertOptions

Availability

3.0.221

Declared In

SBDBaseMessageParams.h