summaryrefslogtreecommitdiffstats
path: root/plugin/api.go
diff options
context:
space:
mode:
authorJason Simmons <1382389+jasimmons@users.noreply.github.com>2018-10-22 08:49:50 -0400
committerJoram Wilander <jwawilander@gmail.com>2018-10-22 08:49:50 -0400
commit1ee872578c734956acc7f5e4168638de244c3ce2 (patch)
treef0cf22a79c7b1b903ce5093479ee2cda509e7805 /plugin/api.go
parent6c6638f05e99f1463ff33983540aedb35271dbfc (diff)
downloadchat-1ee872578c734956acc7f5e4168638de244c3ce2.tar.gz
chat-1ee872578c734956acc7f5e4168638de244c3ce2.tar.bz2
chat-1ee872578c734956acc7f5e4168638de244c3ce2.zip
GH-9636 plugins api GetUsersInChannelByStatus (#9645)
* adds GetUsersInChannelByStatus to plugin api with generated rpc code. * fixed typo in comment with actual func name * replaced Response model with AppError in output of GetUsersInChannelByStatus * removed etag param from GetUsersInChannelByStatus since it is not used * plugin api for GetUsersInChannelByStatus updated to take the limit, conforming to the app api. * fixed an issue in my own logic on app/plugin integration. * adds GetUsersInChannelByStatus to plugin api with generated rpc code. * fixed typo in comment with actual func name * replaced Response model with AppError in output of GetUsersInChannelByStatus * removed etag param from GetUsersInChannelByStatus since it is not used * plugin api for GetUsersInChannelByStatus updated to take the limit, conforming to the app api. * fixed an issue in my own logic on app/plugin integration. * GetUsersInChannelByStatus changed to more generic GetUsersInChannel which takes a sortBy parameter, allowing for more granular/extensible sorting functionality in the future * GetUsersInChannel accepts sort parameter of 'username' and 'status'. Both values are consts in model pkg. * Documents minimum server version for GetUsersInChannel. * adds GetUsersInChannelByStatus to plugin api with generated rpc code. * fixed typo in comment with actual func name * replaced Response model with AppError in output of GetUsersInChannelByStatus * removed etag param from GetUsersInChannelByStatus since it is not used * plugin api for GetUsersInChannelByStatus updated to take the limit, conforming to the app api. * fixed an issue in my own logic on app/plugin integration. * adds GetUsersInChannelByStatus to plugin api with generated rpc code. * Resolved conflict on rebase * replaced Response model with AppError in output of GetUsersInChannelByStatus * removed etag param from GetUsersInChannelByStatus since it is not used * plugin api for GetUsersInChannelByStatus updated to take the limit, conforming to the app api. * fixed an issue in my own logic on app/plugin integration. * GetUsersInChannelByStatus changed to more generic GetUsersInChannel which takes a sortBy parameter, allowing for more granular/extensible sorting functionality in the future * GetUsersInChannel accepts sort parameter of 'username' and 'status'. Both values are consts in model pkg. * Documents minimum server version for GetUsersInChannel. * replaces GetUsersInChannel from #9608 / #9643 with sortBy functionality
Diffstat (limited to 'plugin/api.go')
-rw-r--r--plugin/api.go11
1 files changed, 6 insertions, 5 deletions
diff --git a/plugin/api.go b/plugin/api.go
index dc60bb57a..0f481784e 100644
--- a/plugin/api.go
+++ b/plugin/api.go
@@ -77,6 +77,12 @@ type API interface {
// The status parameter can be: "online", "away", "dnd", or "offline".
UpdateUserStatus(userId, status string) (*model.Status, *model.AppError)
+ // GetUsersInChannel returns a page of users in a channel. Page counting starts at 0.
+ // The sortBy parameter can be: "username" or "status".
+ //
+ // Minimum server version: 5.6
+ GetUsersInChannel(channelId, sortBy string, page, perPage int) ([]*model.User, *model.AppError)
+
// GetLDAPUserAttributes will return LDAP attributes for a user.
// The attributes parameter should be a list of attributes to pull.
// Returns a map with attribute names as keys and the user's attributes as values.
@@ -183,11 +189,6 @@ type API interface {
// DeleteChannelMember deletes a channel membership for a user.
DeleteChannelMember(channelId, userId string) *model.AppError
- // GetUsersInChannel gets users in given channel.
- //
- // Minimum server version: 5.6
- GetUsersInChannel(channelId string, page int, perPage int) ([]*model.User, *model.AppError)
-
// CreatePost creates a post.
CreatePost(post *model.Post) (*model.Post, *model.AppError)