Package io.getstream.chat.java.models

Class ChannelBatchUpdater

java.lang.Object

io.getstream.chat.java.models.ChannelBatchUpdater

public class ChannelBatchUpdater
extends java.lang.Object

Provides convenience methods for batch channel operations.

Constructor Summary

Constructors

Constructor	Description
ChannelBatchUpdater()

Method Summary

Modifier and Type	Method	Description
@NotNull Channel.ChannelsBatchUpdateRequest	addFilterTags(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<java.lang.String> tags)	Adds filter tags to channels matching the filter.
@NotNull Channel.ChannelsBatchUpdateRequest	addMembers(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Adds members to channels matching the filter.
@NotNull Channel.ChannelsBatchUpdateRequest	addModerators(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Adds moderators to channels matching the filter.
@NotNull Channel.ChannelsBatchUpdateRequest	archive(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Archives channels matching the filter for the specified members.
@NotNull Channel.ChannelsBatchUpdateRequest	assignRoles(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Assigns roles to members in channels matching the filter.
@NotNull Channel.ChannelsBatchUpdateRequest	demoteModerators(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Removes moderator role from members in channels matching the filter.
@NotNull Channel.ChannelsBatchUpdateRequest	hide(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Hides channels matching the filter for the specified members.
@NotNull Channel.ChannelsBatchUpdateRequest	inviteMembers(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Invites members to channels matching the filter.
@NotNull Channel.ChannelsBatchUpdateRequest	removeFilterTags(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<java.lang.String> tags)	Removes filter tags from channels matching the filter.
@NotNull Channel.ChannelsBatchUpdateRequest	removeMembers(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Removes members from channels matching the filter.
@NotNull Channel.ChannelsBatchUpdateRequest	show(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Shows channels matching the filter for the specified members.
@NotNull Channel.ChannelsBatchUpdateRequest	unarchive(@NotNull Channel.ChannelsBatchFilters filter, @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)	Unarchives channels matching the filter for the specified members.
@NotNull Channel.ChannelsBatchUpdateRequest	updateData(@NotNull Channel.ChannelsBatchFilters filter, @NotNull Channel.ChannelDataUpdate data)	Updates data on channels matching the filter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelBatchUpdater

public ChannelBatchUpdater()

Method Detail

addMembers

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest addMembers(@NotNull
                                                              @NotNull Channel.ChannelsBatchFilters filter,
                                                              @NotNull
                                                              @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Adds members to channels matching the filter.

Parameters:

filter - the filter to match channels

members - list of members to add

Returns:

the batch update request

removeMembers

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest removeMembers(@NotNull
                                                                 @NotNull Channel.ChannelsBatchFilters filter,
                                                                 @NotNull
                                                                 @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Removes members from channels matching the filter.

Parameters:

filter - the filter to match channels

members - list of members to remove

Returns:

the batch update request

inviteMembers

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest inviteMembers(@NotNull
                                                                 @NotNull Channel.ChannelsBatchFilters filter,
                                                                 @NotNull
                                                                 @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Invites members to channels matching the filter.

Parameters:

filter - the filter to match channels

members - list of members to invite

Returns:

the batch update request

addModerators

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest addModerators(@NotNull
                                                                 @NotNull Channel.ChannelsBatchFilters filter,
                                                                 @NotNull
                                                                 @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Adds moderators to channels matching the filter.

Parameters:

filter - the filter to match channels

members - list of members to add as moderators

Returns:

the batch update request

demoteModerators

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest demoteModerators(@NotNull
                                                                    @NotNull Channel.ChannelsBatchFilters filter,
                                                                    @NotNull
                                                                    @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Removes moderator role from members in channels matching the filter.

Parameters:

filter - the filter to match channels

members - list of members to demote from moderators

Returns:

the batch update request

assignRoles

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest assignRoles(@NotNull
                                                               @NotNull Channel.ChannelsBatchFilters filter,
                                                               @NotNull
                                                               @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Assigns roles to members in channels matching the filter.

Parameters:

filter - the filter to match channels

members - list of members with roles to assign

Returns:

the batch update request

hide

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest hide(@NotNull
                                                        @NotNull Channel.ChannelsBatchFilters filter,
                                                        @NotNull
                                                        @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Hides channels matching the filter for the specified members.

Parameters:

filter - the filter to match channels

members - list of members for whom to hide channels

Returns:

the batch update request

show

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest show(@NotNull
                                                        @NotNull Channel.ChannelsBatchFilters filter,
                                                        @NotNull
                                                        @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Shows channels matching the filter for the specified members.

Parameters:

filter - the filter to match channels

members - list of members for whom to show channels

Returns:

the batch update request

archive

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest archive(@NotNull
                                                           @NotNull Channel.ChannelsBatchFilters filter,
                                                           @NotNull
                                                           @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Archives channels matching the filter for the specified members.

Parameters:

filter - the filter to match channels

members - list of members for whom to archive channels

Returns:

the batch update request

unarchive

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest unarchive(@NotNull
                                                             @NotNull Channel.ChannelsBatchFilters filter,
                                                             @NotNull
                                                             @NotNull java.util.List<Channel.ChannelBatchMemberRequest> members)

Unarchives channels matching the filter for the specified members.

Parameters:

filter - the filter to match channels

members - list of members for whom to unarchive channels

Returns:

the batch update request

updateData

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest updateData(@NotNull
                                                              @NotNull Channel.ChannelsBatchFilters filter,
                                                              @NotNull
                                                              @NotNull Channel.ChannelDataUpdate data)

Updates data on channels matching the filter.

Parameters:

filter - the filter to match channels

data - channel data to update

Returns:

the batch update request

addFilterTags

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest addFilterTags(@NotNull
                                                                 @NotNull Channel.ChannelsBatchFilters filter,
                                                                 @NotNull
                                                                 @NotNull java.util.List<java.lang.String> tags)

Adds filter tags to channels matching the filter.

Parameters:

filter - the filter to match channels

tags - list of filter tags to add

Returns:

the batch update request

removeFilterTags

@NotNull
public @NotNull Channel.ChannelsBatchUpdateRequest removeFilterTags(@NotNull
                                                                    @NotNull Channel.ChannelsBatchFilters filter,
                                                                    @NotNull
                                                                    @NotNull java.util.List<java.lang.String> tags)

Removes filter tags from channels matching the filter.

Parameters:

filter - the filter to match channels

tags - list of filter tags to remove

Returns:

the batch update request