Skip to content

Commit

Permalink
Fix doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
grdsdev committed Aug 13, 2024
1 parent 314c031 commit ec038c1
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions supabase/_async/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -200,17 +200,21 @@ def functions(self):
return self._functions

def channel(self, topic: str, params: RealtimeChannelOptions = {}) -> Channel:
"""Return a channel object."""
"""Creates a Realtime channel with Broadcast, Presence, and Postgres Changes."""
return self.realtime.channel(topic, params)

def get_channels(self) -> List[Channel]:
"""Return all channels the client is subscribed to."""
"""Returns all realtime channels."""
return self.realtime.get_channels()

async def remove_channel(self, channel: Channel) -> None:
"""Remove a channel from the client."""
"""Unsubscribes and removes Realtime channel from Realtime client."""
await self.realtime.remove_channel(channel)

async def remove_all_channels(self) -> None:
"""Unsubscribes and removes all Realtime channels from Realtime client."""
await self.realtime.remove_all_channels()

@staticmethod
def _init_realtime_client(
realtime_url: str, supabase_key: str, options: Optional[Dict[str, Any]]
Expand Down

0 comments on commit ec038c1

Please sign in to comment.