Package io.getstream.chat.java.services
Interface ChannelService
public interface ChannelService
-
Method Summary
Modifier and TypeMethodDescriptionretrofit2.Call<Channel.ChannelUpdateResponse>assignRoles(String channelType, String channelId, Channel.AssignRoleRequestData assignRoleRequestData) retrofit2.Call<Channel.ChannelDeleteResponse>retrofit2.Call<Channel.ChannelDeleteManyResponse>deleteMany(Channel.ChannelDeleteManyRequest channelDeleteManyRequest) retrofit2.Call<Channel.ChannelExportResponse>export(Channel.ChannelExportRequestData channelExportRequestData) retrofit2.Call<Channel.ChannelExportStatusResponse>exportStatus(String taskId) retrofit2.Call<Channel.ChannelGetResponse>getOrCreateWithId(String channelType, String channelId, Channel.ChannelGetRequestData channelGetRequestData) retrofit2.Call<Channel.ChannelGetResponse>getOrCreateWithoutId(String channelType, Channel.ChannelGetRequestData channelGetRequestData) retrofit2.Call<StreamResponseObject>hide(String channelType, String channelId, Channel.ChannelHideRequestData channelHideRequestData) retrofit2.Call<Channel.ChannelListResponse>list(Channel.ChannelListRequestData channelListRequestData) retrofit2.Call<StreamResponseObject>markAllRead(Channel.ChannelMarkAllReadRequestData channelMarkAllReadRequestData) retrofit2.Call<Channel.ChannelMarkReadResponse>markRead(String channelType, String channelId, Channel.ChannelMarkReadRequestData channelMarkReadRequestData) retrofit2.Call<Channel.ChannelMuteResponse>mute(Channel.ChannelMuteRequestData channelMuteRequestData) retrofit2.Call<Channel.ChannelPartialUpdateResponse>partialUpdate(String channelType, String channelId, Channel.ChannelPartialUpdateRequestData channelPartialUpdateRequestData) retrofit2.Call<Channel.ChannelQueryMembersResponse>queryMembers(Channel.ChannelQueryMembersRequestData channelQueryMembersRequestData) retrofit2.Call<StreamResponseObject>show(String channelType, String channelId, Channel.ChannelShowRequestData channelShowRequestData) retrofit2.Call<Channel.ChannelTruncateResponse>truncate(String channelType, String channelId, Channel.ChannelTruncateRequestData channelTruncateRequestData) retrofit2.Call<Channel.ChannelUnMuteResponse>unmute(Channel.ChannelUnMuteRequestData channelUnMuteRequestData) retrofit2.Call<Channel.ChannelUpdateResponse>update(String channelType, String channelId, Channel.ChannelUpdateRequestData channelUpdateRequestData)
-
Method Details
-
update
@POST("channels/{type}/{id}") retrofit2.Call<Channel.ChannelUpdateResponse> update(@NotNull @Path("type") String channelType, @NotNull @Path("id") String channelId, @NotNull @Body Channel.ChannelUpdateRequestData channelUpdateRequestData) -
getOrCreateWithId
@POST("channels/{type}/{id}/query") retrofit2.Call<Channel.ChannelGetResponse> getOrCreateWithId(@NotNull @Path("type") String channelType, @NotNull @Path("id") String channelId, @Nullable @Body Channel.ChannelGetRequestData channelGetRequestData) -
getOrCreateWithoutId
@POST("channels/{type}/query") retrofit2.Call<Channel.ChannelGetResponse> getOrCreateWithoutId(@NotNull @Path("type") String channelType, @Nullable @Body Channel.ChannelGetRequestData channelGetRequestData) -
delete
@DELETE("channels/{type}/{id}") retrofit2.Call<Channel.ChannelDeleteResponse> delete(@NotNull @Path("type") String channelType, @NotNull @Path("id") 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 Channel.ChannelListRequestData channelListRequestData) -
truncate
@POST("channels/{type}/{id}/truncate") retrofit2.Call<Channel.ChannelTruncateResponse> truncate(@NotNull @Path("type") String channelType, @NotNull @Path("id") String channelId, @Nullable @Body Channel.ChannelTruncateRequestData channelTruncateRequestData) -
queryMembers
@GET("members") retrofit2.Call<Channel.ChannelQueryMembersResponse> queryMembers(@NotNull @Query("payload") Channel.ChannelQueryMembersRequestData channelQueryMembersRequestData) -
export
@POST("export_channels") retrofit2.Call<Channel.ChannelExportResponse> export(@NotNull @Body Channel.ChannelExportRequestData channelExportRequestData) -
exportStatus
@GET("export_channels/{id}") retrofit2.Call<Channel.ChannelExportStatusResponse> exportStatus(@NotNull @Path("id") String taskId) -
hide
@POST("channels/{type}/{id}/hide") retrofit2.Call<StreamResponseObject> hide(@NotNull @Path("type") String channelType, @NotNull @Path("id") String channelId, @NotNull @Body Channel.ChannelHideRequestData channelHideRequestData) -
markAllRead
@POST("channels/read") retrofit2.Call<StreamResponseObject> markAllRead(@NotNull @Body Channel.ChannelMarkAllReadRequestData channelMarkAllReadRequestData) -
markRead
@POST("channels/{type}/{id}/read") retrofit2.Call<Channel.ChannelMarkReadResponse> markRead(@NotNull @Path("type") String channelType, @NotNull @Path("id") String channelId, @NotNull @Body Channel.ChannelMarkReadRequestData channelMarkReadRequestData) -
mute
@POST("moderation/mute/channel") retrofit2.Call<Channel.ChannelMuteResponse> mute(@NotNull @Body Channel.ChannelMuteRequestData channelMuteRequestData) -
show
@POST("channels/{type}/{id}/show") retrofit2.Call<StreamResponseObject> show(@NotNull @Path("type") String channelType, @NotNull @Path("id") String channelId, @NotNull @Body Channel.ChannelShowRequestData channelShowRequestData) -
unmute
@POST("moderation/unmute/channel") retrofit2.Call<Channel.ChannelUnMuteResponse> unmute(@NotNull @Body Channel.ChannelUnMuteRequestData channelUnMuteRequestData) -
partialUpdate
@PATCH("channels/{type}/{id}") retrofit2.Call<Channel.ChannelPartialUpdateResponse> partialUpdate(@NotNull @Path("type") String channelType, @NotNull @Path("id") String channelId, @NotNull @Body Channel.ChannelPartialUpdateRequestData channelPartialUpdateRequestData) -
assignRoles
@POST("channels/{type}/{id}") retrofit2.Call<Channel.ChannelUpdateResponse> assignRoles(@NotNull @Path("type") String channelType, @NotNull @Path("id") String channelId, @NotNull @Body Channel.AssignRoleRequestData assignRoleRequestData)
-