OpenChannelCreateParams

@objc(SBDOpenChannelCreateParams)
public final class OpenChannelCreateParams : NSObject, NSCopying

The OpenChannelCreateParams class contain parameters for open channel.

When you want to create a open channel or update a open channel, use this class. Add what you want to create with, add which properties you want to update, and pass this class to OpenChannel. You can use this class with apis that are OpenChannel.createChannel(params:completionHandler:) or OpenChannel,update(params:completionHandler:). For more information, see Open Channel.

Since

3.0.206

  • Channel name

    Declaration

    Swift

    @objc
public var name: String?

  • Channel URL. If nil, channel url will be determined randomly.

    Declaration

    Swift

    @objc
public var channelURL: String?

  • Channel cover image url

    Declaration

    Swift

    @objc
public var coverURL: String?

  • Channel cocer image data

    Declaration

    Swift

    @objc
public var coverImage: Data?

  • Channel cover image name

    Declaration

    Swift

    @objc
public var coverImageName: String?

  • Channel data

    Declaration

    Swift

    @objc
public var data: String?

  • Channel’s operator user IDs

    Declaration

    Swift

    @objc
public var operatorUserIds: [String]?

  • Channel custom type

    Declaration

    Swift

    @objc
public var customType: String?

  • Determines the channel is ephemeral or not. Default is false

    Since

    4.6.2

    Declaration

    Swift

    @objc
public var isEphemeral: Bool

  • Undocumented

    Declaration

    Swift

    public override convenience init()

  • Parameter constructor

    Declaration

    Swift

    @objc
public init(
    name: String? = nil,
    channelURL: String? = nil,
    coverURL: String? = nil,
    coverImage: Data? = nil,
    coverImageName: String? = nil,
    data: String? = nil,
    operatorUserIds: [String]? = nil,
    customType: String? = nil,
    isEphemeral: Bool = false
)

  • Set operators with list of user instance.

    Since

    3.0.206

    Declaration

    Swift

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

    Parameters

    operators

    The list of operators.

  • Copies this object

    Declaration

    Swift

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

    Parameters

    zone

    optional NSZone

    Return Value

    OpenChannelParams instance