net.bis5.mattermost.client4.api

Interface ChannelApi

All Known Implementing Classes:

MattermostClient

public interface ChannelApi

Channel API.

Author:

Takayuki Maruyama

Method Summary

Modifier and Type	Method and Description
ApiResponse<ChannelMember>	addChannelMember(String channelId, String userId)
ApiResponse<Channel>	createChannel(Channel channel)
ApiResponse<Channel>	createDirectChannel(String userId1, String userId2)
default ApiResponse<Channel>	createGroupChannel(Collection<String> userIds)
ApiResponse<Channel>	createGroupChannel(String... userIds)
ApiResponse<Boolean>	deleteChannel(String channelId)
default ApiResponse<Channel>	getChannel(String channelId)
ApiResponse<Channel>	getChannel(String channelId, String etag)
default ApiResponse<Channel>	getChannelByName(String channelName, String teamId)
ApiResponse<Channel>	getChannelByName(String channelName, String teamId, String etag)
default ApiResponse<Channel>	getChannelByNameForTeamName(String channelName, String teamName)
ApiResponse<Channel>	getChannelByNameForTeamName(String channelName, String teamName, String etag)
default ApiResponse<ChannelMember>	getChannelMember(String channelId, String userId)
ApiResponse<ChannelMember>	getChannelMember(String channelId, String userId, String etag)
default ApiResponse<ChannelMembers>	getChannelMembers(String channelId)
default ApiResponse<ChannelMembers>	getChannelMembers(String channelId, Pager pager)
ApiResponse<ChannelMembers>	getChannelMembers(String channelId, Pager pager, String etag)
default ApiResponse<ChannelMembers>	getChannelMembersByIds(String channelId, Collection<String> userIds)
ApiResponse<ChannelMembers>	getChannelMembersByIds(String channelId, String... userIds)
default ApiResponse<ChannelMembers>	getChannelMembersForUser(String userId, String teamId)
ApiResponse<ChannelMembers>	getChannelMembersForUser(String userId, String teamId, String etag)
default ApiResponse<ChannelList>	getChannelsForTeamForUser(String teamId, String userId)
ApiResponse<ChannelList>	getChannelsForTeamForUser(String teamId, String userId, String etag)
default ApiResponse<ChannelStats>	getChannelStats(String channelId)
ApiResponse<ChannelStats>	getChannelStats(String channelId, String etag)
ApiResponse<ChannelUnread>	getChannelUnread(String channelId, String userId)
default ApiResponse<ChannelList>	getDeletedChannels(String teamId)
ApiResponse<ChannelList>	getDeletedChannels(String teamId, Pager pager)
default ApiResponse<PostList>	getPinnedPosts(String channelId)
ApiResponse<PostList>	getPinnedPosts(String channelId, String etag)
default ApiResponse<ChannelList>	getPublicChannelsByIdsForTeam(String teamId, Collection<String> channelIds)
ApiResponse<ChannelList>	getPublicChannelsByIdsForTeam(String teamId, String... channelIds)
default ApiResponse<ChannelList>	getPublicChannelsForTeam(String teamId)
default ApiResponse<ChannelList>	getPublicChannelsForTeam(String teamId, Pager pager)
ApiResponse<ChannelList>	getPublicChannelsForTeam(String teamId, Pager pager, String etag)
ApiResponse<Channel>	patchChannel(String channelId, ChannelPatch patch)
ApiResponse<Boolean>	removeUserFromChannel(String channelId, String userId)
ApiResponse<Channel>	restoreChannel(String channelId)
ApiResponse<ChannelList>	searchChannels(String teamId, ChannelSearch search)
ApiResponse<Channel>	updateChannel(Channel channel)
ApiResponse<Boolean>	updateChannelNotifyProps(String channeLId, String userId, Map<String,String> props)
default ApiResponse<Boolean>	updateChannelRoles(String channelId, String userId, Collection<Role> roles)
ApiResponse<Boolean>	updateChannelRoles(String channelId, String userId, Role... roles)
ApiResponse<ChannelViewResponse>	viewChannel(String userId, ChannelView view)

Method Detail

createChannel

ApiResponse<Channel> createChannel(Channel channel)

updateChannel

ApiResponse<Channel> updateChannel(Channel channel)

patchChannel

ApiResponse<Channel> patchChannel(String channelId,
                                  ChannelPatch patch)

createDirectChannel

ApiResponse<Channel> createDirectChannel(String userId1,
                                         String userId2)

createGroupChannel

default ApiResponse<Channel> createGroupChannel(Collection<String> userIds)

createGroupChannel

ApiResponse<Channel> createGroupChannel(String... userIds)

getChannel

default ApiResponse<Channel> getChannel(String channelId)

getChannel

ApiResponse<Channel> getChannel(String channelId,
                                String etag)

getChannelStats

default ApiResponse<ChannelStats> getChannelStats(String channelId)

getChannelStats

ApiResponse<ChannelStats> getChannelStats(String channelId,
                                          String etag)

getPinnedPosts

default ApiResponse<PostList> getPinnedPosts(String channelId)

getPinnedPosts

ApiResponse<PostList> getPinnedPosts(String channelId,
                                     String etag)

getPublicChannelsForTeam

default ApiResponse<ChannelList> getPublicChannelsForTeam(String teamId)

getPublicChannelsForTeam

default ApiResponse<ChannelList> getPublicChannelsForTeam(String teamId,
                                                          Pager pager)

getPublicChannelsForTeam

ApiResponse<ChannelList> getPublicChannelsForTeam(String teamId,
                                                  Pager pager,
                                                  String etag)

getPublicChannelsByIdsForTeam

default ApiResponse<ChannelList> getPublicChannelsByIdsForTeam(String teamId,
                                                               Collection<String> channelIds)

getPublicChannelsByIdsForTeam

ApiResponse<ChannelList> getPublicChannelsByIdsForTeam(String teamId,
                                                       String... channelIds)

getChannelsForTeamForUser

default ApiResponse<ChannelList> getChannelsForTeamForUser(String teamId,
                                                           String userId)

getChannelsForTeamForUser

ApiResponse<ChannelList> getChannelsForTeamForUser(String teamId,
                                                   String userId,
                                                   String etag)

searchChannels

ApiResponse<ChannelList> searchChannels(String teamId,
                                        ChannelSearch search)

deleteChannel

ApiResponse<Boolean> deleteChannel(String channelId)

getChannelByName

default ApiResponse<Channel> getChannelByName(String channelName,
                                              String teamId)

getChannelByName

ApiResponse<Channel> getChannelByName(String channelName,
                                      String teamId,
                                      String etag)

getChannelByNameForTeamName

default ApiResponse<Channel> getChannelByNameForTeamName(String channelName,
                                                         String teamName)

getChannelByNameForTeamName

ApiResponse<Channel> getChannelByNameForTeamName(String channelName,
                                                 String teamName,
                                                 String etag)

getChannelMembers

default ApiResponse<ChannelMembers> getChannelMembers(String channelId)

getChannelMembers

default ApiResponse<ChannelMembers> getChannelMembers(String channelId,
                                                      Pager pager)

getChannelMembers

ApiResponse<ChannelMembers> getChannelMembers(String channelId,
                                              Pager pager,
                                              String etag)

getChannelMembersByIds

default ApiResponse<ChannelMembers> getChannelMembersByIds(String channelId,
                                                           Collection<String> userIds)

getChannelMembersByIds

ApiResponse<ChannelMembers> getChannelMembersByIds(String channelId,
                                                   String... userIds)

getChannelMember

default ApiResponse<ChannelMember> getChannelMember(String channelId,
                                                    String userId)

getChannelMember

ApiResponse<ChannelMember> getChannelMember(String channelId,
                                            String userId,
                                            String etag)

getChannelMembersForUser

default ApiResponse<ChannelMembers> getChannelMembersForUser(String userId,
                                                             String teamId)

getChannelMembersForUser

ApiResponse<ChannelMembers> getChannelMembersForUser(String userId,
                                                     String teamId,
                                                     String etag)

viewChannel

ApiResponse<ChannelViewResponse> viewChannel(String userId,
                                             ChannelView view)

getChannelUnread

ApiResponse<ChannelUnread> getChannelUnread(String channelId,
                                            String userId)

updateChannelRoles

default ApiResponse<Boolean> updateChannelRoles(String channelId,
                                                String userId,
                                                Collection<Role> roles)

updateChannelRoles

ApiResponse<Boolean> updateChannelRoles(String channelId,
                                        String userId,
                                        Role... roles)

updateChannelNotifyProps

ApiResponse<Boolean> updateChannelNotifyProps(String channeLId,
                                              String userId,
                                              Map<String,String> props)

addChannelMember

ApiResponse<ChannelMember> addChannelMember(String channelId,
                                            String userId)

removeUserFromChannel

ApiResponse<Boolean> removeUserFromChannel(String channelId,
                                           String userId)

restoreChannel

ApiResponse<Channel> restoreChannel(String channelId)

getDeletedChannels

default ApiResponse<ChannelList> getDeletedChannels(String teamId)

getDeletedChannels

ApiResponse<ChannelList> getDeletedChannels(String teamId,
                                            Pager pager)