BaseMessageUpdateParams

@objc(SBDBaseMessageUpdateParams)
public class BaseMessageUpdateParams : NSObject, Encodable, NSCopying

Represents the base class which has parameters to update a message.

The UserMessageUpdateParams, the FileMessageUpdateParams are derived from this class.

  • Message data. The default value is nil.

    Declaration

    Swift

    @objc
public var data: String?

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

    Declaration

    Swift

    @objc
public var customType: String?

  • Mention type

    Declaration

    Swift

    @objc
public var mentionType: MentionType { get set }

  • Mention to specific users. If sends a message with this field, the message will be arrived to mentioned users.

    Declaration

    Swift

    @objc
public var mentionedUserIds: [String]? { get set }

  • Sets the mentionedUserIds by this method either.

    Declaration

    Swift

    @objc
public func setMentionedUsers(_ mentionedUsers: [User])

    Parameters

    mentionedUsers

    The list of users will be receive mention.

  • Adds user IDs for mention

    Declaration

    Swift

    @objc
public func addMentionedUserIds(_ userIds: [String])

    Parameters

    userIds

    list of user IDs

  • Default constructor

    Declaration

    Swift

    public override init()

  • Copies this object

    Declaration

    Swift

    public func copy(with zone: NSZone? = nil) -> Any

    Parameters

    zone

    optional NSZone

    Return Value

    BaseMessageUpdateParams instance

  • Encodes this object.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws

    Parameters

    encoder

    Encoder instance