com.sendbird.android

Class OpenChannelParams

java.lang.Object

com.sendbird.android.OpenChannelParams

public final class OpenChannelParams
extends java.lang.Object

Represents a open channel params.

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

Constructor Summary

Constructors

Constructor and Description
OpenChannelParams() OpenChannelParams constructor.
OpenChannelParams(java.lang.String userId) OpenChannelParams constructor.

Method Summary

Modifier and Type	Method and Description
OpenChannelParams	addOperator(User operator) Deprecated. As of 3.0.152, replaced by setOperators(List)
OpenChannelParams	addOperatorId(java.lang.String operatorUserId) Deprecated. As of 3.0.152, replaced by setOperatorUserIds(List)
OpenChannelParams	addOperatorIds(java.util.List<java.lang.String> operatorUserIds) Deprecated. As of 3.0.152, replaced by setOperatorUserIds(List)
OpenChannelParams	addOperators(java.util.List<User> operators) Deprecated. As of 3.0.152, replaced by setOperators(List)
static OpenChannelParams	clone(OpenChannelParams params) Clones and returns a new instance of given OpenChannelParams.
OpenChannelParams	setChannelUrl(java.lang.String channelUrl) Sets channel url.
OpenChannelParams	setCoverImage(java.io.File coverImageFile) Sets cover image file.
OpenChannelParams	setCoverUrl(java.lang.String coverImageUrl) Sets cover url.
OpenChannelParams	setCustomType(java.lang.String customType) Sets custom type.
OpenChannelParams	setData(java.lang.String data) Sets data.
OpenChannelParams	setName(java.lang.String name) Sets channel name.
OpenChannelParams	setOperators(java.util.List<User> operators) Sets operators.
OpenChannelParams	setOperatorUserIds(java.util.List<java.lang.String> operatorUserIds) Sets operator user ids.
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenChannelParams

public OpenChannelParams()

OpenChannelParams constructor.

Since:

3.0.150

OpenChannelParams

public OpenChannelParams(java.lang.String userId)

OpenChannelParams constructor.

Parameters:

userId - user id to be operator. If you want to set operators, use setOperators(List), setOperatorUserIds(List)

Since:

3.0.150

Method Detail

setChannelUrl

public OpenChannelParams setChannelUrl(java.lang.String channelUrl)

Sets channel url.

Parameters:

channelUrl - channel url

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler)

setName

public OpenChannelParams setName(java.lang.String name)

Sets channel name.

Parameters:

name - channel name

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

setCoverUrl

public OpenChannelParams setCoverUrl(java.lang.String coverImageUrl)

Sets cover url.

Parameters:

coverImageUrl - cover image url

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

setCoverImage

public OpenChannelParams setCoverImage(java.io.File coverImageFile)

Sets cover image file.

Parameters:

coverImageFile - cover image file

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

setData

public OpenChannelParams setData(java.lang.String data)

Sets data.

Parameters:

data - data

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

setCustomType

public OpenChannelParams setCustomType(java.lang.String customType)

Sets custom type.

Parameters:

customType - custom type

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

addOperator

@Deprecated
public OpenChannelParams addOperator(User operator)

Deprecated. As of 3.0.152, replaced by setOperators(List)

Adds user.

Parameters:

operator - operator

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

addOperators

@Deprecated
public OpenChannelParams addOperators(java.util.List<User> operators)

Deprecated. As of 3.0.152, replaced by setOperators(List)

Adds operators.

Parameters:

operators - operators

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

addOperatorId

@Deprecated
public OpenChannelParams addOperatorId(java.lang.String operatorUserId)

Deprecated. As of 3.0.152, replaced by setOperatorUserIds(List)

Adds operator user id.

Parameters:

operatorUserId - operator user id

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

addOperatorIds

@Deprecated
public OpenChannelParams addOperatorIds(java.util.List<java.lang.String> operatorUserIds)

Deprecated. As of 3.0.152, replaced by setOperatorUserIds(List)

Adds operator user ids.

Parameters:

operatorUserIds - operator user id list

Returns:

OpenChannelParams object

Since:

3.0.150

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

setOperators

public OpenChannelParams setOperators(java.util.List<User> operators)

Sets operators.

Parameters:

operators - operators

Returns:

OpenChannelParams object

Since:

3.0.152

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

setOperatorUserIds

public OpenChannelParams setOperatorUserIds(java.util.List<java.lang.String> operatorUserIds)

Sets operator user ids.

Parameters:

operatorUserIds - operatorUserIds

Returns:

OpenChannelParams object

Since:

3.0.152

See Also:

OpenChannel.createChannel(OpenChannelParams, OpenChannel.OpenChannelCreateHandler), OpenChannel.updateChannel(OpenChannelParams, OpenChannel.OpenChannelUpdateHandler)

clone

public static OpenChannelParams clone(OpenChannelParams params)

Clones and returns a new instance of given OpenChannelParams.

Parameters:

params - OpenChannelParams to clone

Returns:

a cloned new instance of this OpenChannelParams

Since:

3.0.150

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object