Package io.getstream.chat.java.services

Interface ChannelService

public interface ChannelService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Channel.ChannelUpdateResponse>	assignRoles(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @NotNull Channel.AssignRoleRequestData assignRoleRequestData)
retrofit2.Call<Channel.ChannelDeleteResponse>	delete(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId)
retrofit2.Call<Channel.ChannelDeleteManyResponse>	deleteMany(Channel.ChannelDeleteManyRequest channelDeleteManyRequest)
retrofit2.Call<Channel.ChannelExportResponse>	export(@NotNull Channel.ChannelExportRequestData channelExportRequestData)
retrofit2.Call<Channel.ChannelExportStatusResponse>	exportStatus(@NotNull java.lang.String taskId)
retrofit2.Call<Channel.ChannelGetResponse>	getOrCreateWithId(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @Nullable Channel.ChannelGetRequestData channelGetRequestData)
retrofit2.Call<Channel.ChannelGetResponse>	getOrCreateWithoutId(@NotNull java.lang.String channelType, @Nullable Channel.ChannelGetRequestData channelGetRequestData)
retrofit2.Call<StreamResponseObject>	hide(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @NotNull Channel.ChannelHideRequestData channelHideRequestData)
retrofit2.Call<Channel.ChannelListResponse>	list(@Nullable Channel.ChannelListRequestData channelListRequestData)
retrofit2.Call<StreamResponseObject>	markAllRead(@NotNull Channel.ChannelMarkAllReadRequestData channelMarkAllReadRequestData)
retrofit2.Call<StreamResponseObject>	markDelivered(@NotNull Channel.MarkDeliveredRequestData markDeliveredOptions, java.lang.String userId)
retrofit2.Call<Channel.ChannelMarkReadResponse>	markRead(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @NotNull Channel.ChannelMarkReadRequestData channelMarkReadRequestData)
retrofit2.Call<Channel.ChannelMuteResponse>	mute(@NotNull Channel.ChannelMuteRequestData channelMuteRequestData)
retrofit2.Call<Channel.ChannelPartialUpdateResponse>	partialUpdate(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @NotNull Channel.ChannelPartialUpdateRequestData channelPartialUpdateRequestData)
retrofit2.Call<Channel.ChannelQueryMembersResponse>	queryMembers(@NotNull Channel.ChannelQueryMembersRequestData channelQueryMembersRequestData)
retrofit2.Call<StreamResponseObject>	show(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @NotNull Channel.ChannelShowRequestData channelShowRequestData)
retrofit2.Call<Channel.ChannelTruncateResponse>	truncate(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @Nullable Channel.ChannelTruncateRequestData channelTruncateRequestData)
retrofit2.Call<Channel.ChannelUnMuteResponse>	unmute(@NotNull Channel.ChannelUnMuteRequestData channelUnMuteRequestData)
retrofit2.Call<Channel.ChannelUpdateResponse>	update(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @NotNull Channel.ChannelUpdateRequestData channelUpdateRequestData)
retrofit2.Call<Channel.ChannelMemberResponse>	updateMemberPartial(@NotNull java.lang.String channelType, @NotNull java.lang.String channelId, @NotNull java.lang.String userId, @NotNull Channel.ChannelMemberPartialUpdateRequestData updateMemberPartialRequestData)

Method Detail

update

@POST("channels/{type}/{id}")
retrofit2.Call<Channel.ChannelUpdateResponse> update(@NotNull @Path("type")
                                                     @NotNull java.lang.String channelType,
                                                     @NotNull @Path("id")
                                                     @NotNull java.lang.String channelId,
                                                     @NotNull @Body
                                                     @NotNull Channel.ChannelUpdateRequestData channelUpdateRequestData)

getOrCreateWithId

@POST("channels/{type}/{id}/query")
retrofit2.Call<Channel.ChannelGetResponse> getOrCreateWithId(@NotNull @Path("type")
                                                             @NotNull java.lang.String channelType,
                                                             @NotNull @Path("id")
                                                             @NotNull java.lang.String channelId,
                                                             @Nullable @Body
                                                             @Nullable Channel.ChannelGetRequestData channelGetRequestData)

getOrCreateWithoutId

@POST("channels/{type}/query")
retrofit2.Call<Channel.ChannelGetResponse> getOrCreateWithoutId(@NotNull @Path("type")
                                                                @NotNull java.lang.String channelType,
                                                                @Nullable @Body
                                                                @Nullable Channel.ChannelGetRequestData channelGetRequestData)

delete

@DELETE("channels/{type}/{id}")
retrofit2.Call<Channel.ChannelDeleteResponse> delete(@NotNull @Path("type")
                                                     @NotNull java.lang.String channelType,
                                                     @NotNull @Path("id")
                                                     @NotNull java.lang.String channelId)

deleteMany

@POST("channels/delete")
retrofit2.Call<Channel.ChannelDeleteManyResponse> deleteMany(@NotNull @Body
                                                             Channel.ChannelDeleteManyRequest channelDeleteManyRequest)

list

@POST("channels")
retrofit2.Call<Channel.ChannelListResponse> list(@Nullable @Body
                                                 @Nullable Channel.ChannelListRequestData channelListRequestData)

truncate

@POST("channels/{type}/{id}/truncate")
retrofit2.Call<Channel.ChannelTruncateResponse> truncate(@NotNull @Path("type")
                                                         @NotNull java.lang.String channelType,
                                                         @NotNull @Path("id")
                                                         @NotNull java.lang.String channelId,
                                                         @Nullable @Body
                                                         @Nullable Channel.ChannelTruncateRequestData channelTruncateRequestData)

queryMembers

@GET("members")
retrofit2.Call<Channel.ChannelQueryMembersResponse> queryMembers(@NotNull @Query("payload")
                                                                 @NotNull Channel.ChannelQueryMembersRequestData channelQueryMembersRequestData)

export

@POST("export_channels")
retrofit2.Call<Channel.ChannelExportResponse> export(@NotNull @Body
                                                     @NotNull Channel.ChannelExportRequestData channelExportRequestData)

exportStatus

@GET("export_channels/{id}")
retrofit2.Call<Channel.ChannelExportStatusResponse> exportStatus(@NotNull @Path("id")
                                                                 @NotNull java.lang.String taskId)

hide

@POST("channels/{type}/{id}/hide")
retrofit2.Call<StreamResponseObject> hide(@NotNull @Path("type")
                                          @NotNull java.lang.String channelType,
                                          @NotNull @Path("id")
                                          @NotNull java.lang.String channelId,
                                          @NotNull @Body
                                          @NotNull Channel.ChannelHideRequestData channelHideRequestData)

markAllRead

@POST("channels/read")
retrofit2.Call<StreamResponseObject> markAllRead(@NotNull @Body
                                                 @NotNull Channel.ChannelMarkAllReadRequestData channelMarkAllReadRequestData)

markRead

@POST("channels/{type}/{id}/read")
retrofit2.Call<Channel.ChannelMarkReadResponse> markRead(@NotNull @Path("type")
                                                         @NotNull java.lang.String channelType,
                                                         @NotNull @Path("id")
                                                         @NotNull java.lang.String channelId,
                                                         @NotNull @Body
                                                         @NotNull Channel.ChannelMarkReadRequestData channelMarkReadRequestData)

mute

@POST("moderation/mute/channel")
retrofit2.Call<Channel.ChannelMuteResponse> mute(@NotNull @Body
                                                 @NotNull Channel.ChannelMuteRequestData channelMuteRequestData)

show

@POST("channels/{type}/{id}/show")
retrofit2.Call<StreamResponseObject> show(@NotNull @Path("type")
                                          @NotNull java.lang.String channelType,
                                          @NotNull @Path("id")
                                          @NotNull java.lang.String channelId,
                                          @NotNull @Body
                                          @NotNull Channel.ChannelShowRequestData channelShowRequestData)

unmute

@POST("moderation/unmute/channel")
retrofit2.Call<Channel.ChannelUnMuteResponse> unmute(@NotNull @Body
                                                     @NotNull Channel.ChannelUnMuteRequestData channelUnMuteRequestData)

partialUpdate

@PATCH("channels/{type}/{id}")
retrofit2.Call<Channel.ChannelPartialUpdateResponse> partialUpdate(@NotNull @Path("type")
                                                                   @NotNull java.lang.String channelType,
                                                                   @NotNull @Path("id")
                                                                   @NotNull java.lang.String channelId,
                                                                   @NotNull @Body
                                                                   @NotNull Channel.ChannelPartialUpdateRequestData channelPartialUpdateRequestData)

assignRoles

@POST("channels/{type}/{id}")
retrofit2.Call<Channel.ChannelUpdateResponse> assignRoles(@NotNull @Path("type")
                                                          @NotNull java.lang.String channelType,
                                                          @NotNull @Path("id")
                                                          @NotNull java.lang.String channelId,
                                                          @NotNull @Body
                                                          @NotNull Channel.AssignRoleRequestData assignRoleRequestData)

updateMemberPartial

@PATCH("channels/{type}/{id}/member/{user_id}")
retrofit2.Call<Channel.ChannelMemberResponse> updateMemberPartial(@NotNull @Path("type")
                                                                  @NotNull java.lang.String channelType,
                                                                  @NotNull @Path("id")
                                                                  @NotNull java.lang.String channelId,
                                                                  @NotNull @Path("user_id")
                                                                  @NotNull java.lang.String userId,
                                                                  @NotNull @Body
                                                                  @NotNull Channel.ChannelMemberPartialUpdateRequestData updateMemberPartialRequestData)

markDelivered

@POST("channels/delivered")
retrofit2.Call<StreamResponseObject> markDelivered(@NotNull @Body
                                                   @NotNull Channel.MarkDeliveredRequestData markDeliveredOptions,
                                                   @Query("user_id")
                                                   java.lang.String userId)