Package io.getstream.chat.java.models

Class Channel

java.lang.Object

io.getstream.chat.java.models.Channel

public class Channel
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Channel.AssignRoleRequestData
static class	Channel.ChannelDeleteManyRequest
static class	Channel.ChannelDeleteManyResponse
static class	Channel.ChannelDeleteRequest
static class	Channel.ChannelDeleteResponse
static class	Channel.ChannelExportRequestData
static class	Channel.ChannelExportRequestObject
static class	Channel.ChannelExportResponse
static class	Channel.ChannelExportStatusRequest
static class	Channel.ChannelExportStatusResponse
static class	Channel.ChannelGetRequestData
static class	Channel.ChannelGetResponse
static class	Channel.ChannelHideRequestData
static class	Channel.ChannelListRequestData
static class	Channel.ChannelListResponse
static class	Channel.ChannelMarkAllReadRequestData
static class	Channel.ChannelMarkReadRequestData
static class	Channel.ChannelMarkReadResponse
static class	Channel.ChannelMember
static class	Channel.ChannelMemberPartialUpdateRequestData
static class	Channel.ChannelMemberRequestObject
static class	Channel.ChannelMemberResponse
static class	Channel.ChannelMuteRequestData
static class	Channel.ChannelMuteResponse
static class	Channel.ChannelPartialUpdateRequestData
static class	Channel.ChannelPartialUpdateResponse
static class	Channel.ChannelPinResponse
static class	Channel.ChannelQueryMembersRequestData
static class	Channel.ChannelQueryMembersResponse
static class	Channel.ChannelRead
static class	Channel.ChannelRequestObject
static class	Channel.ChannelShowRequestData
static class	Channel.ChannelTruncateRequestData
static class	Channel.ChannelTruncateResponse
static class	Channel.ChannelUnMuteRequestData
static class	Channel.ChannelUnMuteResponse
static class	Channel.ChannelUpdateRequestData
static class	Channel.ChannelUpdateResponse
static class	Channel.ConfigOverridesRequestObject
static class	Channel.RoleAssignment

Constructor Summary

Constructors

Constructor	Description
Channel()

Method Summary

Modifier and Type	Method	Description
static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest	archive(@NotNull java.lang.String type, @NotNull java.lang.String id, @NotNull java.lang.String userId)	Creates a archive channel request
static @NotNull Channel.AssignRoleRequestData.AssignRoleRequest	assignRoles(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates an assign role request
static @NotNull Channel.ChannelDeleteRequest	delete(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates a delete request
static @NotNull Channel.ChannelDeleteManyRequest	deleteMany(@NotNull java.util.List<java.lang.String> cids)
static @NotNull Channel.ChannelExportRequestData.ChannelExportRequest	export()	Creates an export request
static @NotNull Channel.ChannelExportStatusRequest	exportStatus(java.lang.String taskId)	Creates an export status request
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalFields()
static @NotNull Channel.ChannelGetRequestData.ChannelGetRequest	getOrCreate(@NotNull java.lang.String type)	Creates a get or create request
static @NotNull Channel.ChannelGetRequestData.ChannelGetRequest	getOrCreate(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates a get or create request
static @NotNull Channel.ChannelHideRequestData.ChannelHideRequest	hide(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates a hide request
static @NotNull Channel.ChannelListRequestData.ChannelListRequest	list()	Creates a list request
static @NotNull Channel.ChannelMarkAllReadRequestData.ChannelMarkAllReadRequest	markAllRead()	Creates a mark all read request
static @NotNull Channel.ChannelMarkReadRequestData.ChannelMarkReadRequest	markRead(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates a mark read request
static @NotNull Channel.ChannelMuteRequestData.ChannelMuteRequest	mute()	Creates a mute request
static @NotNull Channel.ChannelPartialUpdateRequestData.ChannelPartialUpdateRequest	partialUpdate(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates a partial update request
static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest	pin(@NotNull java.lang.String type, @NotNull java.lang.String id, @NotNull java.lang.String userId)	Creates a pin channel request
static @NotNull Channel.ChannelQueryMembersRequestData.ChannelQueryMembersRequest	queryMembers()	Creates a query members request
void	setAdditionalField(java.lang.String name, java.lang.Object value)
static @NotNull Channel.ChannelShowRequestData.ChannelShowRequest	show(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates a show request
static @NotNull Channel.ChannelTruncateRequestData.ChannelTruncateRequest	truncate(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates a truncate request
static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest	unarchive(@NotNull java.lang.String type, @NotNull java.lang.String id, @NotNull java.lang.String userId)	Creates a unarchive channel request
static @NotNull Channel.ChannelUnMuteRequestData.ChannelUnMuteRequest	unmute()	Creates an unmute request
static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest	unpin(@NotNull java.lang.String type, @NotNull java.lang.String id, @NotNull java.lang.String userId)	Creates a unpin channel request
static @NotNull Channel.ChannelUpdateRequestData.ChannelUpdateRequest	update(@NotNull java.lang.String type, @NotNull java.lang.String id)	Creates an update request
static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest	updateMemberPartial(@NotNull java.lang.String type, @NotNull java.lang.String id, @NotNull java.lang.String userId)	Creates a update member partial request

Methods inherited from class java.lang.Object

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

Constructor Detail

Channel

public Channel()

Method Detail

getAdditionalFields

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalFields()

setAdditionalField

public void setAdditionalField(java.lang.String name,
                               java.lang.Object value)

getOrCreate

@NotNull
public static @NotNull Channel.ChannelGetRequestData.ChannelGetRequest getOrCreate(@NotNull
                                                                                   @NotNull java.lang.String type,
                                                                                   @NotNull
                                                                                   @NotNull java.lang.String id)

Creates a get or create request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

getOrCreate

@NotNull
public static @NotNull Channel.ChannelGetRequestData.ChannelGetRequest getOrCreate(@NotNull
                                                                                   @NotNull java.lang.String type)

Creates a get or create request

Parameters:

type - the channel type

Returns:

the created request

update

@NotNull
public static @NotNull Channel.ChannelUpdateRequestData.ChannelUpdateRequest update(@NotNull
                                                                                    @NotNull java.lang.String type,
                                                                                    @NotNull
                                                                                    @NotNull java.lang.String id)

Creates an update request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

delete

@NotNull
public static @NotNull Channel.ChannelDeleteRequest delete(@NotNull
                                                           @NotNull java.lang.String type,
                                                           @NotNull
                                                           @NotNull java.lang.String id)

Creates a delete request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

deleteMany

@NotNull
public static @NotNull Channel.ChannelDeleteManyRequest deleteMany(@NotNull
                                                                   @NotNull java.util.List<java.lang.String> cids)

list

@NotNull
public static @NotNull Channel.ChannelListRequestData.ChannelListRequest list()

Creates a list request

Returns:

the created request

truncate

@NotNull
public static @NotNull Channel.ChannelTruncateRequestData.ChannelTruncateRequest truncate(@NotNull
                                                                                          @NotNull java.lang.String type,
                                                                                          @NotNull
                                                                                          @NotNull java.lang.String id)

Creates a truncate request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

queryMembers

@NotNull
public static @NotNull Channel.ChannelQueryMembersRequestData.ChannelQueryMembersRequest queryMembers()

Creates a query members request

Returns:

the created request

export

@NotNull
public static @NotNull Channel.ChannelExportRequestData.ChannelExportRequest export()

Creates an export request

Returns:

the created request

exportStatus

@NotNull
public static @NotNull Channel.ChannelExportStatusRequest exportStatus(java.lang.String taskId)

Creates an export status request

Parameters:

taskId - the id of the export task

Returns:

the created request

hide

@NotNull
public static @NotNull Channel.ChannelHideRequestData.ChannelHideRequest hide(@NotNull
                                                                              @NotNull java.lang.String type,
                                                                              @NotNull
                                                                              @NotNull java.lang.String id)

Creates a hide request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

markAllRead

@NotNull
public static @NotNull Channel.ChannelMarkAllReadRequestData.ChannelMarkAllReadRequest markAllRead()

Creates a mark all read request

Returns:

the created request

markRead

@NotNull
public static @NotNull Channel.ChannelMarkReadRequestData.ChannelMarkReadRequest markRead(@NotNull
                                                                                          @NotNull java.lang.String type,
                                                                                          @NotNull
                                                                                          @NotNull java.lang.String id)

Creates a mark read request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

mute

@NotNull
public static @NotNull Channel.ChannelMuteRequestData.ChannelMuteRequest mute()

Creates a mute request

Returns:

the created request

show

@NotNull
public static @NotNull Channel.ChannelShowRequestData.ChannelShowRequest show(@NotNull
                                                                              @NotNull java.lang.String type,
                                                                              @NotNull
                                                                              @NotNull java.lang.String id)

Creates a show request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

unmute

@NotNull
public static @NotNull Channel.ChannelUnMuteRequestData.ChannelUnMuteRequest unmute()

Creates an unmute request

Returns:

the created request

partialUpdate

@NotNull
public static @NotNull Channel.ChannelPartialUpdateRequestData.ChannelPartialUpdateRequest partialUpdate(@NotNull
                                                                                                         @NotNull java.lang.String type,
                                                                                                         @NotNull
                                                                                                         @NotNull java.lang.String id)

Creates a partial update request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

assignRoles

@NotNull
public static @NotNull Channel.AssignRoleRequestData.AssignRoleRequest assignRoles(@NotNull
                                                                                   @NotNull java.lang.String type,
                                                                                   @NotNull
                                                                                   @NotNull java.lang.String id)

Creates an assign role request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

updateMemberPartial

@NotNull
public static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest updateMemberPartial(@NotNull
                                                                                                                           @NotNull java.lang.String type,
                                                                                                                           @NotNull
                                                                                                                           @NotNull java.lang.String id,
                                                                                                                           @NotNull
                                                                                                                           @NotNull java.lang.String userId)

Creates a update member partial request

Parameters:

type - the channel type

id - the channel id

userId - the user id

Returns:

the created request

pin

@NotNull
public static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest pin(@NotNull
                                                                                                           @NotNull java.lang.String type,
                                                                                                           @NotNull
                                                                                                           @NotNull java.lang.String id,
                                                                                                           @NotNull
                                                                                                           @NotNull java.lang.String userId)

Creates a pin channel request

Parameters:

type - the channel type

id - the channel id

userId - the user id

Returns:

the created request

unpin

@NotNull
public static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest unpin(@NotNull
                                                                                                             @NotNull java.lang.String type,
                                                                                                             @NotNull
                                                                                                             @NotNull java.lang.String id,
                                                                                                             @NotNull
                                                                                                             @NotNull java.lang.String userId)

Creates a unpin channel request

Parameters:

type - the channel type

id - the channel id

userId - the user id

Returns:

the created request

archive

@NotNull
public static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest archive(@NotNull
                                                                                                               @NotNull java.lang.String type,
                                                                                                               @NotNull
                                                                                                               @NotNull java.lang.String id,
                                                                                                               @NotNull
                                                                                                               @NotNull java.lang.String userId)

Creates a archive channel request

Parameters:

type - the channel type

id - the channel id

userId - the user id

Returns:

the created request

unarchive

@NotNull
public static @NotNull Channel.ChannelMemberPartialUpdateRequestData.ChannelMemberPartialUpdateRequest unarchive(@NotNull
                                                                                                                 @NotNull java.lang.String type,
                                                                                                                 @NotNull
                                                                                                                 @NotNull java.lang.String id,
                                                                                                                 @NotNull
                                                                                                                 @NotNull java.lang.String userId)

Creates a unarchive channel request

Parameters:

type - the channel type

id - the channel id

userId - the user id

Returns:

the created request