OpenChannel

open class OpenChannel: BaseChannel

The OpenChannel class represents a open channel which is a public chat.

Any users who wants to enter the channel can join freely. This class is derived from BaseChannel. If the OpenChannelDelegate is added, the user will automatically receive all messages from the channels where the user belongs after connection. The OpenChannel does not provide the features that GroupChannel does, but it can handle much more users.

For more information, see Group Channel.

participantCount
The number of participants in this channel.
Declaration
Swift

open internal(set) var participantCount: Int = 0
operators
The operators of this channel.
Declaration
Swift

open internal(set) var operators: [User]?


                    
                    
                    isOperator(user:)

Returns the user is an operator or not.

Declaration

Swift

open func isOperator(user: User) -> Bool

Parameters


                                user

The user object.

Return Value

If true, the user is an operator.


                    
                    
                    isOperator(userId:)

Returns the user ID is an operator or not.

Declaration

Swift

open func isOperator(userId: String) -> Bool

Parameters


                                userId

The user ID.

Return Value

If true, the user ID is an operator.


                    
                    
                    init(from:)

Default constructor.

Declaration

Swift

public required init(from decoder: Decoder) throws

Parameters


                                decoder

Decoder instance


                    
                    
                    encode(to:)

Encodes this object.

Declaration

Swift

open override func encode(to encoder: Encoder) throws

Parameters


                                encoder

Encoder instance


                    
                    
                    isEqual(_:)

Compares this object with given other object.

Declaration

Swift

public override func isEqual(_ object: Any?) -> Bool

Parameters


                                object

Any instance

Return Value

true if same otherwise false

CRUD


                    
                    
                    createChannel(completionHandler:)

Creates an open channel.

Note

The name and cover URL of the channel are generated in Sendbird server.

Declaration

Swift

open class func createChannel(completionHandler: @escaping OpenChannelHandler)

Parameters


                                completionHandler

The handler block to execute.


                    
                    
                    createChannel(params:completionHandler:)

Creates a open channel with OpenChannelCreateParams class.

Since

3.0.206

Declaration

Swift

open class func createChannel(
    params: OpenChannelCreateParams,
    completionHandler: @escaping OpenChannelHandler
)

Parameters

`params`	Instance of `OpenChannelCreateParams` what has properties to create open channel.
`completionHandler`	Handler block to execute. `channel` is the open channel instance.


                    
                    
                    createChannel(params:progressHandler:completionHandler:)

Creates a open channel with OpenChannelCreateParams class.

Since

3.0.206

Declaration

Swift

open class func createChannel(
    params: OpenChannelCreateParams,
    progressHandler: ProgressHandler?,
    completionHandler: @escaping OpenChannelHandler
)

Parameters

`params`	The parameter instance of `OpenChannelCreateParams` what has properties to create open channel.
`progressHandler`	The handler block to monitor progression. `bytesSent` is the number of bytes sent since the last time this method was called. `totalBytesSent` is the total number of bytes sent so far. `totalBytesExpectedToSend` is the expected length of the body data. These parameters are the same to the declaration of `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)`.
`completionHandler`	The handler block to execute. `channel` is the open channel instance.


                    
                    
                    update(params:completionHandler:)

Updates this channel with OpenChannelUpdateParams class.

Since

3.0.206

Declaration

Swift

open func update(
    params: OpenChannelUpdateParams,
    completionHandler: @escaping OpenChannelHandler
)

Parameters

`params`	The parameter instance of OpenChannelCreateParams what has properties to update open channel.
`completionHandler`	The handler block to execute. `channel` is the open channel instance.


                    
                    
                    update(params:progressHandler:completionHandler:)

Updates this channel with OpenChannelUpdateParams class.

Since

3.0.206

Declaration

Swift

open func update(
    params: OpenChannelUpdateParams,
    progressHandler: ProgressHandler?,
    completionHandler: @escaping OpenChannelHandler
)

Parameters

`params`	The parameter instance of OpenChannelCreateParams what has properties to update open channel.
`progressHandler`	The handler block to monitor progression. `bytesSent` is the number of bytes sent since the last time this method was called. `totalBytesSent` is the total number of bytes sent so far. `totalBytesExpectedToSend` is the expected length of the body data. These parameters are the same to the declaration of `urlSession(_:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:)`.
`completionHandler`	The handler block to execute. `channel` is the open channel instance.


                    
                    
                    delete(completionHandler:)

Deletes this channel

Since

3.0.180

Declaration

Swift

open func delete(completionHandler: SBErrorHandler?)

Parameters


                                completionHandler

The handler block to execute. channel is the open channel instance which is deleted.


                    
                    
                    getChannel(url:completionHandler:)

Gets an open channel instance from channel URL.

Declaration

Swift

open class func getChannel(
    url: String,
    completionHandler: OpenChannelHandler?
)

Parameters

`url`	The channel URL.
`completionHandler`	The handler block to execute. `channel` is the open channel instance which has the `channelURL`.


                    
                    
                    refresh(completionHandler:)

Refreshes the channel information.

Declaration

Swift

open func refresh(completionHandler: SBErrorHandler?)

Parameters


                                completionHandler

The handler block to execute.

Operation


                    
                    
                    enter(completionHandler:)

Enters this channel.

Declaration

Swift

open func enter(completionHandler: SBErrorHandler?)

Parameters


                                completionHandler

The handler block to execute.


                    
                    
                    exit(completionHandler:)

Exits this channel.

Declaration

Swift

open func exit(completionHandler: SBErrorHandler?)

Parameters


                                completionHandler

The handler block to execute.

Query

createOpenChannelListQuery()
Creates a query instance for open channel list.
Declaration
Swift

open class func createOpenChannelListQuery() -> OpenChannelListQuery
Return Value

The query instance for open channel list.


                    
                    
                    createOpenChannelListQuery(paramsBuilder:)

Creates a query instance for open channel list.

Declaration

Swift

open class func createOpenChannelListQuery(paramsBuilder: (OpenChannelListQueryParams) -> Void) -> OpenChannelListQuery

Parameters


                                paramsBuilder

The builder closure for setting OpenChannelListQueryParams.

Return Value

The query instance for open channel list.


                    
                    
                    createOpenChannelListQuery(params:)

Creates a query instance for open channel list.

Declaration

Swift

open class func createOpenChannelListQuery(params: OpenChannelListQueryParams) -> OpenChannelListQuery

Parameters


                                params

The params object to change query condition.

Return Value

The query instance for open channel list.


                    
                    
                    createParticipantListQuery(channelURL:)

Creates a query instance for getting participant list of the channel with the given channel URL.

Declaration

Swift

open class func createParticipantListQuery(channelURL: String) -> ParticipantListQuery

Parameters


                                channelURL

URL of the channel to create the query with.

Return Value

ParticipantListQuery instance for the participant list of the channel instance.


                    
                    
                    createParticipantListQuery(channelURL:paramsBuilder:)

Creates a query instance for getting participant list of the channel with the given channel URL.

Declaration

Swift

open class func createParticipantListQuery(channelURL: String, paramsBuilder: (ParticipantListQueryParams) -> Void) -> ParticipantListQuery

Parameters

`channelURL`	URL of the channel to create the query with.
`paramsBuilder`	The builder closure for setting `ParticipantListQueryParams`.

Return Value

ParticipantListQuery instance for the participant list of the channel instance.


                    
                    
                    createParticipantListQuery(channelURL:params:)

Creates a query instance for getting participant list of the channel with the given channel URL.

Declaration

Swift

open class func createParticipantListQuery(channelURL: String, params: ParticipantListQueryParams) -> ParticipantListQuery

Parameters

`channelURL`	URL of the channel to create the query with.
`params`	The params object to change query condition.

Return Value

ParticipantListQuery instance for the participant list of the channel instance.

createParticipantListQuery()
Creates a participant list query for this channel.
Declaration
Swift

open func createParticipantListQuery() -> ParticipantListQuery?
Return Value

UserListQuery instance for the participant list of the channel instance.


                    
                    
                    createParticipantListQuery(paramsBuilder:)

Creates a participant list query for this channel.

Declaration

Swift

open func createParticipantListQuery(paramsBuilder: (ParticipantListQueryParams) -> Void) -> ParticipantListQuery?

Parameters


                                paramsBuilder

The builder closure for setting ParticipantListQueryParams.

Return Value

UserListQuery instance for the participant list of the channel instance.


                    
                    
                    createParticipantListQuery(params:)

Creates a participant list query for this channel.

Declaration

Swift

open func createParticipantListQuery(params: ParticipantListQueryParams) -> ParticipantListQuery?

Parameters


                                params

The params object to change query condition.

Return Value

UserListQuery instance for the participant list of the channel instance.


                    
                    
                    build(fromSerializedData:)

Deserializes and reconstructs the object

Declaration

Swift

open override class func build(fromSerializedData data: Data?) -> Self?

Parameters


                                data

Data instance

Return Value

OpenChannel if parameter is valid, otherwise nil