Wolfram Language Paclet Repository
Community-contributed installable additions to the Wolfram Language
ToneAr`RocketChat`
"
"
(Service Connection)
Interface to the Rocket.Chat REST API.
Connecting & Authenticating
Create a new connection explicitly with .
["Rocket.Chat","New",Authentication<|"Host""https://chat.example","User""username","Password""password"|>]
Username/password authentication accepts the following keys:
"Host" | required | Rocket.Chat server URL beginning with http:// or https:// | |
"User" | required | Rocket.Chat user name or login identifier | |
"Password" | required | Rocket.Chat password |
The authentication parser logs in during connection creation and stores normalized connection authentication as on the returned service object.
<|"Host"host,"AuthToken"token,"UserID"userID|>
Token-based connections can be created directly with .
["Rocket.Chat","New",Authentication<|"Host""https://chat.example","AuthToken""token","UserID""user-id"|>]
Requests
Processed request execution returns Failure on framework or HTTP-processing errors and otherwise wraps imported Rocket.Chat response data in Success.
Each implemented Rocket.Chat request is documented below. Use "Requests" and "RequestParameters" for the exact active machine-readable interface.
Disconnecting
Examples
(1)
Basic Examples
(1)
Create a new Rocket.Chat service connection using an explicit host, user name, and password:
In[1]:=
conn=ServiceConnect["Rocket.Chat","New",Authentication"Host""https://chat.example","User""username","Password""password"]
Create a connection from an existing Rocket.Chat token pair:
In[2]:=
tokenConn=ServiceConnect["Rocket.Chat","New",Authentication"Host""https://chat.example","AuthToken""token","UserID""user-id"]
Inspect the available processed request names:
In[3]:=
ServiceExecute[conn,"Requests"]
Inspect per-request parameter names:
In[4]:=
ServiceExecute[conn,"RequestParameters"]
Get profile information for the authenticated Rocket.Chat user:
In[5]:=
ServiceExecute[conn,"GetProfileInfo"]
Read basic server information:
In[6]:=
ServiceExecute[conn,"GetServerInfo"]
Log out and dispose of the service connection:
In[7]:=
ServiceDisconnect[conn]
 |
|
""