Skip to content

Commit cade9aa

Browse files
authored
Add optional messages for members (#75)
fixes #74
1 parent 865d51d commit cade9aa

File tree

3 files changed

+60
-25
lines changed

3 files changed

+60
-25
lines changed

stream_chat/async_chat/channel.py

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -147,50 +147,65 @@ async def truncate(self):
147147
"""
148148
return await self.client.post(f"{self.url}/truncate")
149149

150-
async def add_members(self, user_ids):
150+
async def add_members(self, user_ids, message=None):
151151
"""
152152
Adds members to the channel
153153
154154
:param user_ids: user IDs to add as members
155+
:param message: An optional to show
155156
:return:
156157
"""
157-
return await self.client.post(self.url, data={"add_members": user_ids})
158+
return await self.client.post(
159+
self.url, data={"add_members": user_ids, "message": message}
160+
)
158161

159-
async def invite_members(self, user_ids):
162+
async def invite_members(self, user_ids, message=None):
160163
"""
161164
invite members to the channel
162165
163166
:param user_ids: user IDs to invite
167+
:param message: An optional to show
164168
:return:
165169
"""
166-
return await self.client.post(self.url, data={"invites": user_ids})
170+
return await self.client.post(
171+
self.url, data={"invites": user_ids, "message": message}
172+
)
167173

168-
async def add_moderators(self, user_ids):
174+
async def add_moderators(self, user_ids, message=None):
169175
"""
170176
Adds moderators to the channel
171177
172178
:param user_ids: user IDs to add as moderators
179+
:param message: An optional to show
173180
:return:
174181
"""
175-
return await self.client.post(self.url, data={"add_moderators": user_ids})
182+
return await self.client.post(
183+
self.url, data={"add_moderators": user_ids, "message": message}
184+
)
176185

177-
async def remove_members(self, user_ids):
186+
async def remove_members(self, user_ids, message=None):
178187
"""
179188
Remove members from the channel
180189
181190
:param user_ids: user IDs to remove from the member list
191+
:param message: An optional to show
182192
:return:
183193
"""
184-
return await self.client.post(self.url, data={"remove_members": user_ids})
194+
return await self.client.post(
195+
self.url, data={"remove_members": user_ids, "message": message}
196+
)
185197

186-
async def demote_moderators(self, user_ids):
198+
async def demote_moderators(self, user_ids, message=None):
187199
"""
188200
Demotes moderators from the channel
189201
190202
:param user_ids: user IDs to demote
203+
:param message: An optional to show
191204
:return:
192205
"""
193-
return await self.client.post(self.url, data={"demote_moderators": user_ids})
206+
return await self.client.post(
207+
self.url, data={"demote_moderators": user_ids, "message": message}
208+
)
194209

195210
async def mark_read(self, user_id, **data):
196211
"""

stream_chat/base/channel.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -148,51 +148,56 @@ def truncate(self):
148148
pass
149149

150150
@abc.abstractmethod
151-
def add_members(self, user_ids):
151+
def add_members(self, user_ids, message=None):
152152
"""
153153
Adds members to the channel
154154
155155
:param user_ids: user IDs to add as members
156+
:param message: An optional to show
156157
:return:
157158
"""
158159
pass
159160

160161
@abc.abstractmethod
161-
def invite_members(self, user_ids):
162+
def invite_members(self, user_ids, message=None):
162163
"""
163164
invite members to the channel
164165
165166
:param user_ids: user IDs to invite
167+
:param message: An optional to show
166168
:return:
167169
"""
168170
pass
169171

170172
@abc.abstractmethod
171-
def add_moderators(self, user_ids):
173+
def add_moderators(self, user_ids, message=None):
172174
"""
173175
Adds moderators to the channel
174176
175177
:param user_ids: user IDs to add as moderators
178+
:param message: An optional to show
176179
:return:
177180
"""
178181
pass
179182

180183
@abc.abstractmethod
181-
def remove_members(self, user_ids):
184+
def remove_members(self, user_ids, message=None):
182185
"""
183186
Remove members from the channel
184187
185188
:param user_ids: user IDs to remove from the member list
189+
:param message: An optional to show
186190
:return:
187191
"""
188192
pass
189193

190194
@abc.abstractmethod
191-
def demote_moderators(self, user_ids):
195+
def demote_moderators(self, user_ids, message=None):
192196
"""
193197
Demotes moderators from the channel
194198
195199
:param user_ids: user IDs to demote
200+
:param message: An optional to show
196201
:return:
197202
"""
198203
pass

stream_chat/channel.py

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -145,50 +145,65 @@ def truncate(self):
145145
"""
146146
return self.client.post(f"{self.url}/truncate")
147147

148-
def add_members(self, user_ids):
148+
def add_members(self, user_ids, message=None):
149149
"""
150150
Adds members to the channel
151151
152152
:param user_ids: user IDs to add as members
153+
:param message: An optional to show
153154
:return:
154155
"""
155-
return self.client.post(self.url, data={"add_members": user_ids})
156+
return self.client.post(
157+
self.url, data={"add_members": user_ids, "message": message}
158+
)
156159

157-
def invite_members(self, user_ids):
160+
def invite_members(self, user_ids, message=None):
158161
"""
159162
invite members to the channel
160163
161164
:param user_ids: user IDs to invite
165+
:param message: An optional to show
162166
:return:
163167
"""
164-
return self.client.post(self.url, data={"invites": user_ids})
168+
return self.client.post(
169+
self.url, data={"invites": user_ids, "message": message}
170+
)
165171

166-
def add_moderators(self, user_ids):
172+
def add_moderators(self, user_ids, message=None):
167173
"""
168174
Adds moderators to the channel
169175
170176
:param user_ids: user IDs to add as moderators
177+
:param message: An optional to show
171178
:return:
172179
"""
173-
return self.client.post(self.url, data={"add_moderators": user_ids})
180+
return self.client.post(
181+
self.url, data={"add_moderators": user_ids, "message": message}
182+
)
174183

175-
def remove_members(self, user_ids):
184+
def remove_members(self, user_ids, message=None):
176185
"""
177186
Remove members from the channel
178187
179188
:param user_ids: user IDs to remove from the member list
189+
:param message: An optional to show
180190
:return:
181191
"""
182-
return self.client.post(self.url, data={"remove_members": user_ids})
192+
return self.client.post(
193+
self.url, data={"remove_members": user_ids, "message": message}
194+
)
183195

184-
def demote_moderators(self, user_ids):
196+
def demote_moderators(self, user_ids, message=None):
185197
"""
186198
Demotes moderators from the channel
187199
188200
:param user_ids: user IDs to demote
201+
:param message: An optional to show
189202
:return:
190203
"""
191-
return self.client.post(self.url, data={"demote_moderators": user_ids})
204+
return self.client.post(
205+
self.url, data={"demote_moderators": user_ids, "message": message}
206+
)
192207

193208
def mark_read(self, user_id, **data):
194209
"""

0 commit comments

Comments
 (0)