Returns the initial view of a channel: recent messages, the read cursor, and unseen notifications.
Parameters
Output
Encoding
application/jsoncursor
string
Optional
No description available.
messages
array
Required
No description available.
readCursor
reflex:social.colibri.channel.defs#readCursor
Optional
No description available.
unseen
array
Required
No description available.
Errors
AuthRequired
Missing, malformed, or unverifiable service auth. InvalidRequest
A parameter or body field was missing or malformed. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "query",
"errors": [
{
"name": "AuthRequired",
"description": "Missing, malformed, or unverifiable service auth."
},
{
"name": "InvalidRequest",
"description": "A parameter or body field was missing or malformed."
}
],
"output": {
"schema": {
"type": "object",
"required": [
"messages",
"unseen"
],
"properties": {
"cursor": {
"type": "string"
},
"unseen": {
"type": "array",
"items": {
"ref": "lex:social.colibri.notification.defs#unseenNotification",
"type": "ref"
}
},
"messages": {
"type": "array",
"items": {
"ref": "lex:social.colibri.channel.defs#message",
"type": "ref"
}
},
"readCursor": {
"ref": "lex:social.colibri.channel.defs#readCursor",
"type": "ref"
}
}
},
"encoding": "application/json"
},
"parameters": {
"type": "params",
"required": [
"channel"
],
"properties": {
"limit": {
"type": "integer"
},
"channel": {
"type": "string",
"format": "at-uri"
}
}
},
"description": "Returns the initial view of a channel: recent messages, the read cursor, and unseen notifications."
}