com.sendbird.android

Class GroupChannelParams

java.lang.Object

com.sendbird.android.GroupChannelParams

public class GroupChannelParams
extends java.lang.Object

Represents a group channel params.

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

Constructor Summary

Constructors

Constructor and Description
GroupChannelParams() GroupChannelParams constructor.

Method Summary

Modifier and Type	Method and Description
GroupChannelParams	addUser(User user) Add user.
GroupChannelParams	addUserId(java.lang.String userId) Add user id.
GroupChannelParams	addUserIds(java.util.List<java.lang.String> userIds) Add user ids.
GroupChannelParams	addUsers(java.util.List<User> users) Add users.
static GroupChannelParams	clone(GroupChannelParams params) Clones and returns a new instance of given GroupChannelParams.
GroupChannelParams	setAccessCode(java.lang.String accessCode) Sets access code for public group channel.
GroupChannelParams	setBroadcast(boolean broadcast) Sets broadcast mode channel.
GroupChannelParams	setChannelUrl(java.lang.String channelUrl) Sets channel url.
GroupChannelParams	setCoverImage(java.io.File coverImageFile) Sets cover image file.
GroupChannelParams	setCoverUrl(java.lang.String coverImageUrl) Sets cover url.
GroupChannelParams	setCustomType(java.lang.String customType) Sets custom type.
GroupChannelParams	setData(java.lang.String data) Sets data.
GroupChannelParams	setDiscoverable(boolean isDiscoverable) Sets discoverable channel for public group channel.
GroupChannelParams	setDistinct(boolean isDistinct) Sets distinct mode.
GroupChannelParams	setEphemeral(boolean isEphemeral) Sets ephemeral mode channel.
GroupChannelParams	setMessageSurvivalSeconds(int messageSurvivalSeconds) Sets the message survival seconds.
GroupChannelParams	setName(java.lang.String name) Sets channel name.
GroupChannelParams	setOperators(java.util.List<User> operators) Add operators.
GroupChannelParams	setOperatorUserIds(java.util.List<java.lang.String> operatorUserIds) Add operator user ids.
GroupChannelParams	setPublic(boolean isPublic) Sets public mode channel.
GroupChannelParams	setStrict(boolean strict) Sets strict mode.
GroupChannelParams	setSuper(boolean isSuper) Sets super mode channel.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupChannelParams

public GroupChannelParams()

GroupChannelParams constructor.

Since:

3.0.49

Method Detail

addUser

public GroupChannelParams addUser(User user)

Add user.

Parameters:

user - user

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

addUsers

public GroupChannelParams addUsers(java.util.List<User> users)

Add users.

Parameters:

users - users

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

addUserId

public GroupChannelParams addUserId(java.lang.String userId)

Add user id.

Parameters:

userId - userId

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

addUserIds

public GroupChannelParams addUserIds(java.util.List<java.lang.String> userIds)

Add user ids.

Parameters:

userIds - userIds

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

setSuper

public GroupChannelParams setSuper(boolean isSuper)

Sets super mode channel. Distinct mode must be false, if super mode is true.

Parameters:

isSuper - true if super mode channel.

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

setPublic

public GroupChannelParams setPublic(boolean isPublic)

Sets public mode channel. Distinct mode must be false, if public mode is true.

Parameters:

isPublic - true if public mode channel.

Returns:

GroupChannelParams object

Since:

3.0.50

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

setEphemeral

public GroupChannelParams setEphemeral(boolean isEphemeral)

Sets ephemeral mode channel.

Parameters:

isEphemeral - true if ephemeral mode channel.

Returns:

GroupChannelParams object

Since:

3.0.52

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

setDistinct

public GroupChannelParams setDistinct(boolean isDistinct)

Sets distinct mode. Distinct mode must be false, if super mode is true.

Parameters:

isDistinct - true if distinct mode channel.

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

setDiscoverable

public GroupChannelParams setDiscoverable(boolean isDiscoverable)

Sets discoverable channel for public group channel. It is valid only when setPublic(boolean) is set to true. If it is set to false, this channel will not appear in the result of PublicGroupChannelListQuery.

Parameters:

isDiscoverable - true if channel is discoverable in the result of PublicGroupChannelListQuery.

Returns:

GroupChannelParams object

Since:

3.0.94

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

setChannelUrl

public GroupChannelParams setChannelUrl(java.lang.String channelUrl)

Sets channel url.

Parameters:

channelUrl - channel url

Returns:

GroupChannelParams object

Since:

3.0.50

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

setName

public GroupChannelParams setName(java.lang.String name)

Sets channel name.

Parameters:

name - channel name

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

setCoverUrl

public GroupChannelParams setCoverUrl(java.lang.String coverImageUrl)

Sets cover url.

Parameters:

coverImageUrl - cover image url

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

setCoverImage

public GroupChannelParams setCoverImage(java.io.File coverImageFile)

Sets cover image file.

Parameters:

coverImageFile - cover image file.

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

setData

public GroupChannelParams setData(java.lang.String data)

Sets data.

Parameters:

data - data

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

setCustomType

public GroupChannelParams setCustomType(java.lang.String customType)

Sets custom type.

Parameters:

customType - custom type

Returns:

GroupChannelParams object

Since:

3.0.49

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler), GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler)

setOperators

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

Add operators.

Parameters:

operators - operators

Returns:

GroupChannelParams object

Since:

3.0.51

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

setOperatorUserIds

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

Add operator user ids.

Parameters:

operatorUserIds - operatorUserIds

Returns:

GroupChannelParams object

Since:

3.0.51

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

setAccessCode

public GroupChannelParams setAccessCode(java.lang.String accessCode)

Sets access code for public group channel. The access code setting is only valid for public GroupChannels. Once the access code is set, users have to accept an invitation or join the public GroupChannel with the access code to be a member of the channel. Refer to GroupChannel.join(String, GroupChannel.GroupChannelJoinHandler) and GroupChannel.acceptInvitation(String, GroupChannel.GroupChannelAcceptInvitationHandler). To delete the existing access code, pass an empty string as to this and call GroupChannel.updateChannel(GroupChannelParams, GroupChannel.GroupChannelUpdateHandler).

Parameters:

accessCode - Access code to be set.

Returns:

GroupChannelParams object

Since:

3.0.76

setStrict

public GroupChannelParams setStrict(boolean strict)

Sets strict mode. When true, the channel creation will be failed if any of the users do not exist. When false, the channel creation will be succeeded even if all the users do not exist. The default value is false.

Parameters:

strict - strict

Returns:

GroupChannelParams object

Since:

3.0.99

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

setBroadcast

public GroupChannelParams setBroadcast(boolean broadcast)

Sets broadcast mode channel. If broadcast mode is true, then super mode will be true.

Parameters:

broadcast - true if broadcast mode channel.

Returns:

GroupChannelParams object

Since:

3.0.119

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

setMessageSurvivalSeconds

public GroupChannelParams setMessageSurvivalSeconds(int messageSurvivalSeconds)

Sets the message survival seconds.

Parameters:

messageSurvivalSeconds - Time before the message should disappears, in seconds.

Returns:

GroupChannelParams object

Since:

3.0.120

See Also:

GroupChannel.createChannel(GroupChannelParams, GroupChannel.GroupChannelCreateHandler)

clone

public static GroupChannelParams clone(GroupChannelParams params)

Clones and returns a new instance of given GroupChannelParams.

Parameters:

params - GroupChannelParams to clone

Returns:

a cloned new instance of this GroupChannelParams

Since:

3.0.150

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object