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.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.ChannelMemberRequestObject
static class	Channel.ChannelMuteRequestData
static class	Channel.ChannelMuteResponse
static class	Channel.ChannelPartialUpdateRequestData
static class	Channel.ChannelPartialUpdateResponse
static class	Channel.ChannelQueryMembersRequestData
static class	Channel.ChannelQueryMembersResponse
static class	Channel.ChannelRead
static class	Channel.ChannelRequestObject
static class	Channel.ChannelShowRequestData
static class	Channel.ChannelTruncateRequest
static class	Channel.ChannelTruncateResponse
static class	Channel.ChannelUnMuteRequestData
static class	Channel.ChannelUnMuteResponse
static class	Channel.ChannelUpdateRequestData
static class	Channel.ChannelUpdateResponse
static class	Channel.ConfigOverridesRequestObject

Constructor Summary

Constructors

Constructor	Description
Channel()

Method Summary

Modifier and Type	Method	Description
static Channel.ChannelDeleteRequest	delete(java.lang.String type, java.lang.String id)	Creates a delete request
static Channel.ChannelExportRequestData.ChannelExportRequest	export()	Creates an export request
static Channel.ChannelExportStatusRequest	exportStatus(java.lang.String taskId)	Creates an export status request
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalFields()
static Channel.ChannelGetRequestData.ChannelGetRequest	getOrCreate(java.lang.String type)	Creates a get or create request
static Channel.ChannelGetRequestData.ChannelGetRequest	getOrCreate(java.lang.String type, java.lang.String id)	Creates a get or create request
static Channel.ChannelHideRequestData.ChannelHideRequest	hide(java.lang.String type, java.lang.String id)	Creates a hide request
static Channel.ChannelListRequestData.ChannelListRequest	list()	Creates a list request
static Channel.ChannelMarkAllReadRequestData.ChannelMarkAllReadRequest	markAllRead()	Creates a mark all read request
static Channel.ChannelMarkReadRequestData.ChannelMarkReadRequest	markRead(java.lang.String type, java.lang.String id)	Creates a mark read request
static Channel.ChannelMuteRequestData.ChannelMuteRequest	mute()	Creates a mute request
static Channel.ChannelPartialUpdateRequestData.ChannelPartialUpdateRequest	partialUpdate(java.lang.String type, java.lang.String id)	Creates a partial update request
static Channel.ChannelQueryMembersRequestData.ChannelQueryMembersRequest	queryMembers()	Creates a query members request
void	setAdditionalField(java.lang.String name, java.lang.Object value)
static Channel.ChannelShowRequestData.ChannelShowRequest	show(java.lang.String type, java.lang.String id)	Creates a show request
static Channel.ChannelTruncateRequest	truncate(java.lang.String type, java.lang.String id)	Creates a truncate request
static Channel.ChannelUnMuteRequestData.ChannelUnMuteRequest	unmute()	Creates an unmute request
static Channel.ChannelUpdateRequestData.ChannelUpdateRequest	update(java.lang.String type, java.lang.String id)	Creates an update 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 Channel.ChannelGetRequestData.ChannelGetRequest getOrCreate(@NotNull
                                                                          java.lang.String type,
                                                                          @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 Channel.ChannelGetRequestData.ChannelGetRequest getOrCreate(@NotNull
                                                                          java.lang.String type)

Creates a get or create request

Parameters:

type - the channel type

Returns:

the created request

update

@NotNull
public static Channel.ChannelUpdateRequestData.ChannelUpdateRequest update(@NotNull
                                                                           java.lang.String type,
                                                                           @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 Channel.ChannelDeleteRequest delete(@NotNull
                                                  java.lang.String type,
                                                  @NotNull
                                                  java.lang.String id)

Creates a delete request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request

list

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

Creates a list request

Returns:

the created request

truncate

@NotNull
public static Channel.ChannelTruncateRequest truncate(@NotNull
                                                      java.lang.String type,
                                                      @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 Channel.ChannelQueryMembersRequestData.ChannelQueryMembersRequest queryMembers()

Creates a query members request

Returns:

the created request

export

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

Creates an export request

Returns:

the created request

exportStatus

@NotNull
public static 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 Channel.ChannelHideRequestData.ChannelHideRequest hide(@NotNull
                                                                     java.lang.String type,
                                                                     @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 Channel.ChannelMarkAllReadRequestData.ChannelMarkAllReadRequest markAllRead()

Creates a mark all read request

Returns:

the created request

markRead

@NotNull
public static Channel.ChannelMarkReadRequestData.ChannelMarkReadRequest markRead(@NotNull
                                                                                 java.lang.String type,
                                                                                 @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 Channel.ChannelMuteRequestData.ChannelMuteRequest mute()

Creates a mute request

Returns:

the created request

show

@NotNull
public static Channel.ChannelShowRequestData.ChannelShowRequest show(@NotNull
                                                                     java.lang.String type,
                                                                     @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 Channel.ChannelUnMuteRequestData.ChannelUnMuteRequest unmute()

Creates an unmute request

Returns:

the created request

partialUpdate

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

Creates a partial update request

Parameters:

type - the channel type

id - the channel id

Returns:

the created request