GroupChannelCreateParams

@objc(SBDGroupChannelCreateParams)
public class GroupChannelCreateParams : NSObject, Codable
extension GroupChannelCreateParams: NSCopying

An object contains set of options to create a group channel

  • Represents the channel is to be updated.

    Declaration

    Swift

    @objc
    public var channelURL: String?
  • Determines the channel is super channel or not. Default is false

    Declaration

    Swift

    @objc
    public var isSuper: Bool
  • Determines the channel is broadcast channel or not. Default is false

    Since

    3.0.171

    Declaration

    Swift

    @objc
    public var isBroadcast: Bool
  • Determines the channel is exclusive channel or not. Default is false

    Since

    4.0.0

    Declaration

    Swift

    @objc
    public var isExclusive: Bool
  • Determines the channel is public channel or not. Default is false

    Declaration

    Swift

    @objc
    public var isPublic: Bool
  • Determines the channel is distinct or not. If true, the channel which has the same users is returned. Default is false

    Declaration

    Swift

    @objc
    public var isDistinct: Bool
  • Determines the channel is ephemeral or not. Default is false

    Since

    3.0.90

    Declaration

    Swift

    @objc
    public var isEphemeral: Bool
  • Determines whether the public group channel is discoverable. It is only for creating or updating a public group channel. If the value is true and isPublic is false, you will get an error from call-back of creating/updateing channel. The default is true.

    Since

    3.0.136

    Declaration

    Swift

    @objc
    public var isDiscoverable: Bool
  • The boolean that can cause an error if any of the users is not valid when creating the channel. If you have two valid users and strict is true, the channel is created successfully when you create a channel with users. If one valid user, one invalid user, and strict are true, you will get an error creating the channel. However, if you have one valid user, one invalid user, and strict is false, you can create a channel without errors without a user.

    Since

    3.0.148

    Declaration

    Swift

    @objc
    public var isStrict: Bool
  • Custom type of group channel.

    Declaration

    Swift

    @objc
    public var customType: String?
  • Custom data of group channel.

    Declaration

    Swift

    @objc
    public var data: String?
  • Cover image url of group channel.

    Declaration

    Swift

    @objc
    public var coverURL: String?
  • Cover image data of group channel.

    Declaration

    Swift

    @objc
    public var coverImage: Data?
  • Name of group channel.

    Declaration

    Swift

    @objc
    public var name: String?
  • Channel’s operators’s user ID.

    Since

    3.0.89

    Declaration

    Swift

    @objc
    public var operatorUserIds: [String]? { get set }
  • User IDs who will be invited to the channel

    Declaration

    Swift

    @objc
    public var userIds: [String]? { get set }
  • A string that allows access to the public group channel. ONLY use for public group channel.

    Since

    3.0.116

    Declaration

    Swift

    @objc
    public var accessCode: String?
  • A value that sets the message survival time in seconds. In the channel that is created or updated with this option, the read messages are automatically deleted after a determined amount of time. The default value is -1 that represents the disappearing message is disabled.

    Note

    This feature is available in a 1-on-1 group channel.

    Since

    3.0.172

    Declaration

    Swift

    @objc
    public var messageSurvivalSeconds: Int
  • Default constructor.

    Declaration

    Swift

    public override init()
  • Encodes this object.

    Declaration

    Swift

    public func encode(to encoder: Encoder) throws

    Parameters

    encoder

    Encoder instance

  • Default constructor.

    Declaration

    Swift

    public required init(from decoder: Decoder) throws

    Parameters

    decoder

    Decoder instance

  • Adds user with User class to be member of the group channel.

    Declaration

    Swift

    @objc
    public func addUser(_ user: User)

    Parameters

    user

    The user to be member of a group channel.

  • Adds user with user ID to be member of the group channel.

    Declaration

    Swift

    @objc
    public func addUserId(_ userId: String)

    Parameters

    userId

    The user ID to be member of a group channel.

  • Adds users with User class array to be member of the group channel.

    Declaration

    Swift

    @objc
    public func addUsers(_ users: [User])

    Parameters

    users

    The users to be member of a group channel.

  • Adds users with user IDs to be member of the group channel.

    Declaration

    Swift

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

    Parameters

    userIds

    The user IDs to be member of a group channel.

  • Sets operators with list of user instance.

    Since

    3.0.89

    Declaration

    Swift

    @objc
    public func setOperators(_ operators: [User])

    Parameters

    operators

    The list of operators.

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    GroupChannelParams instance