Transport-Agnostic Chat Contract


[Up] [Top]

Documentation for package ‘chat.api’ version 0.1.0

Help Pages

chat.api-package Transport-agnostic chat connectivity
chat.api Transport-agnostic chat connectivity
chat_addressed Does a message address this client?
chat_attachment Construct a normalized attachment record
chat_capabilities Describe what a chat client's platform supports
chat_channels List the channels this client is in
chat_channel_create Create a channel
chat_channel_info Describe a channel
chat_config Construct a chat_config
chat_config_save Persist a configuration
chat_disconnect Close a chat client's connection
chat_download Fetch an attachment's bytes to a local file
chat_edit Replace the text of a message already sent
chat_get_state Read durable typed state from a channel
chat_history Read a channel's recent messages
chat_identity Construct an identity record
chat_invite Construct a normalized invitation record
chat_irc Create an IRC chat client
chat_join Join a channel
chat_leave Leave a channel
chat_loopback Create a loopback chat client
chat_mark_read Mark a message as read
chat_matrix Create a Matrix chat client
chat_matrix_config Load a Matrix configuration
chat_matrix_configure Configure a Matrix account interactively
chat_matrix_config_path Where a Matrix configuration lives
chat_members List a channel's members
chat_message Construct a normalized chat message
chat_pending Read standing state that is not tied to a cursor
chat_poll Poll a chat client for new messages
chat_react React to a message
chat_reaction Construct a normalized reaction record
chat_relogin Refresh this client's credentials
chat_resolve Resolve a human channel name to its identifier
chat_send Send a message through a chat client
chat_set_identity Set this client's persistent identity
chat_set_state Set durable typed state on a channel
chat_slack Create a Slack chat client
chat_telegram Create a Telegram chat client
chat_typing Signal typing state in a channel
chat_typing.chat_matrix Signal typing state in a channel
chat_whoami Who is this client logged in as?