Channel

Table of Contents

• syncopate.models.channel
  • Channel
    • send
    • fetch_messages
    • fetch_members
    • fetch_presence
    • trigger_typing
    • from_data

syncopate.models.channel

Channel model with action methods.

Channel Objects

@dataclass(slots=True)
class Channel()

A Syncopate channel with methods for sending messages and managing members.

send

async def send(content: str,
               *,
               type: str = "text",
               parent_id: str | None = None,
               idempotency_key: str | None = None) -> Message

Send a message to this channel.

fetch_messages

async def fetch_messages(*,
                         limit: int = 50,
                         after_sequence: int | None = None,
                         before_sequence: int | None = None) -> list[Message]

Fetch messages from this channel.

fetch_members

async def fetch_members() -> list[dict[str, object]]

Fetch members of this channel.

fetch_presence

async def fetch_presence() -> list[str]

Fetch online user IDs in this channel.

trigger_typing

async def trigger_typing() -> None

Send a typing indicator to this channel.

from_data

@classmethod
def from_data(cls, data: dict[str, object]) -> Channel

Construct from an API response payload.