This article covers in detail the API calls that can be performed in the Client-side and the Server-side and about the special permissions required client-side.
COMMANDS | CLIENT-SIDE | CLIENT-SIDE (WITH PERMISSIONS) | SERVER-SIDE |
User | |||
edit user role | only server-side | ||
edit user | x (only own user) | only server-side | |
mute user | x | x | |
ban user from app | only server-side | ||
ban user from a channel | x (only admin and moderators) | ||
connectuser / setguestuser / connectanonymoususer | x (advisable only on client-side) | allowed (strongly not recommended) | |
upsertUsers | only server-side | ||
shadowban | x | x | |
devtoken | x (only client-side) | ||
createtoken | only server-side | ||
partialupdateuser | x (only own user) | only server-side | |
Channel | |||
create channel | x | x (created_by_id is necessary) | |
delete channel | x | x | |
read channel | x | x | |
update channel members | x | x | |
remove own channel membership | x | x | |
update channel roles | x | ||
update channel | x | x | |
freeze / unfreeze a channel | By default, no user role is allowed to freeze channel | x with UseFrozenChannel permissions | x |
truncate channel | x | x | |
watch channel | x | ||
hide channel | x | x | |
updatechanneltype | only server-side | ||
mute channel | x | x | |
unmute channel | x | x | |
querymembers | x | x | |
multi tenant and teams | only server-side | ||
exportchannel | only server-side | ||
Messages | |||
create message | x | x | |
add links | |||
update message | x | x | |
pin message | x with pinMessage permissions | x | |
delete message |
soft delete (message is still returned in the message list and all its data is kept as it is )
|
hard delete (the message is removed from the channel and its data wiped)
|
|
flag a message | x | x | |
sendimage | x | x | |
sendfile | x | x | |
delete attachment | x | ||
markread / markallread | x | x (need to pass user_id) | |
Search | |||
channelSearch | x | x | |
clientSearch | x | x | |
Push | |||
addDevice | x | x | |
removeDevice | x | x | |
getDevice | x | x | |
edit push template | x | ||
Block List | |||
createblocklist | only server-side | ||
listblocklist | only server-side | ||
getblocklist | only server-side | ||
updateblocklist | only server-side | ||
deleteblocklist | only server-side | ||
Reactions | |||
create reaction | x | x | |
delete reaction | x | x | |
Custom commands | only sever-side | ||
listcommands | only server-side | ||
getcommand | only server-side | ||
updatecommand | only server-side | ||
deletecommand | only server-side | ||
send custom event | x | x (user must be included in the event payload) | |
GDPR | |||
deleteUser | only server-side | ||
exportUser | only server-side | ||
imagemoderation | x | x | |
App specific | |||
queryusers | x | x | |
exportuser | only server-side | ||
enable / disable slow mode | x (only admin or moderators) | x (only admin and moderators) | x |
updateappsettings | only server-side |
Comments
0 comments
Please sign in to leave a comment.