Skip to content

Commit

Permalink
Fix the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
hynek-urban committed Jul 12, 2024
1 parent c6856cf commit 653d773
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,9 +110,9 @@ Like `RocketChat.subscribe_to_channel_changes` except the callback gets passed t

Like `RocketChat.subscribe_to_channel_messages` except the callback gets passed the raw message object coming from the API.

#### `RocketChat.get_channels_raw(callback)`
#### `RocketChat.get_channels_raw()`

Like `RocketChat.get_channels` except the callback gets passed the list of raw channel objects coming from the API.
Like `RocketChat.get_channels` except the method returns the list of raw channel objects coming from the API.

#### `RocketChat.unsubscribe(subscription_id)`

Expand Down
8 changes: 6 additions & 2 deletions rocketchat_async/core.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,16 +86,20 @@ async def _resume(self, token):
# --> Public API methods start here. <--

async def get_channels(self):
"""Get a list of channels user is currently member of.
"""
Get a list of channels user is currently member of.
Returns a list of (channel id, channel type) pairs.
"""
return await GetChannels.call(self._dispatcher)

async def get_channels_raw(self):
"""Get a list of channels user is currently member of.
"""
Get a list of channels user is currently member of.
Returns a list of channel objects.
"""
return await GetChannelsRaw.call(self._dispatcher)

Expand Down

0 comments on commit 653d773

Please sign in to comment.