Package: chat.api 0.1.0

Troy Hernandez

chat.api: Transport-Agnostic Chat Contract

A transport-agnostic contract for chat-room connectivity: connect, poll, and send against one interface, with adapters for 'Matrix' <https://spec.matrix.org/>, 'Slack' <https://api.slack.com/>, 'Telegram' <https://core.telegram.org/bots/api>, and Internet Relay Chat (IRC). An in-memory adapter supports local testing. Capability flags describe support for threads, markup dialects, encryption, and per-message identity. Platform clients are supplied by optional packages; the core interface uses only base R.

Authors:Troy Hernandez [aut, cre], cornball.ai [cph]

chat.api_0.1.0.tar.gz
chat.api_0.1.0.zip(r-4.7-any)chat.api_0.1.0.zip(r-4.6-any)
chat.api_0.1.0.tar.gz(r-4.7-any)chat.api_0.1.0.tar.gz(r-4.6-any)
chat.api_0.1.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
chat.api/json (API)

# Install 'chat.api' in R:
install.packages('chat.api', repos = c('https://cran.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/cornball-ai/chat.api/issues

On CRAN:

Conda:

1.70 score 39 exports 0 dependencies

Last updated from:d1a693fcd4. Checks:6 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-develOK131
source / vignettesOK166
linux-releaseOK138
windows-develOK70
windows-releaseOK82
wasm-releaseOK89

Exports:chat_addressedchat_attachmentchat_capabilitieschat_channel_createchat_channel_infochat_channelschat_configchat_config_savechat_disconnectchat_downloadchat_editchat_get_statechat_historychat_identitychat_invitechat_ircchat_joinchat_leavechat_loopbackchat_mark_readchat_matrixchat_matrix_configchat_matrix_config_pathchat_matrix_configurechat_memberschat_messagechat_pendingchat_pollchat_reactchat_reactionchat_reloginchat_resolvechat_sendchat_set_identitychat_set_statechat_slackchat_telegramchat_typingchat_whoami

Dependencies:

Readme and manuals

Help Manual

Help pageTopics
Transport-agnostic chat connectivitychat.api-package chat.api
Does a message address this client?chat_addressed
Construct a normalized attachment recordchat_attachment
Describe what a chat client's platform supportschat_capabilities
Create a channelchat_channel_create
Describe a channelchat_channel_info
List the channels this client is inchat_channels
Construct a chat_configchat_config
Persist a configurationchat_config_save
Close a chat client's connectionchat_disconnect
Fetch an attachment's bytes to a local filechat_download
Replace the text of a message already sentchat_edit
Read durable typed state from a channelchat_get_state
Read a channel's recent messageschat_history
Construct an identity recordchat_identity
Construct a normalized invitation recordchat_invite
Create an IRC chat clientchat_irc
Join a channelchat_join
Leave a channelchat_leave
Create a loopback chat clientchat_loopback
Mark a message as readchat_mark_read
Create a Matrix chat clientchat_matrix
Load a Matrix configurationchat_matrix_config
Where a Matrix configuration liveschat_matrix_config_path
Configure a Matrix account interactivelychat_matrix_configure
List a channel's memberschat_members
Construct a normalized chat messagechat_message
Read standing state that is not tied to a cursorchat_pending
Poll a chat client for new messageschat_poll
React to a messagechat_react
Construct a normalized reaction recordchat_reaction
Refresh this client's credentialschat_relogin
Resolve a human channel name to its identifierchat_resolve
Send a message through a chat clientchat_send
Set this client's persistent identitychat_set_identity
Set durable typed state on a channelchat_set_state
Create a Slack chat clientchat_slack
Create a Telegram chat clientchat_telegram
Signal typing state in a channelchat_typing chat_typing.chat_matrix
Who is this client logged in as?chat_whoami