chat.yakka.getSnapshot

yakka.chat

Documentation

Everything needed for first paint, in one round trip: the viewer's servers, the active server's channels and roster, and one channel's newest timeline page. One method rather than five because this is the server-rendered path — every extra round trip here is latency a reader sees before anything appears. Warm navigations do not call it at all; the client's store already holds the answer.

main query

Everything needed for first paint, in one round trip: the viewer's servers, the active server's channels and roster, and one channel's newest timeline page. One method rather than five because this is the server-rendered path — every extra round trip here is latency a reader sees before anything appears. Warm navigations do not call it at all; the client's store already holds the answer.

Parameters

channel string Optional

Which channel's timeline to include. Omit for the server's default.

server string did Optional

Which server to open. Omit to let the appview choose the viewer's first.

Output

Encodingapplication/json
Schema#output
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Which channel's timeline to include. Omit for the server's default.
Which server to open. Omit to let the appview choose the viewer's first.
View raw schema 
{
  "description": "Everything needed for first paint, in one round trip: the viewer's servers, the active server's channels and roster, and one channel's newest timeline page.\n\nOne method rather than five because this is the server-rendered path — every extra round trip here is latency a reader sees before anything appears. Warm navigations do not call it at all; the client's store already holds the answer.",
  "output": {
    "encoding": "application/json",
    "schema": {
      "ref": "#output",
      "type": "ref"
    }
  },
  "parameters": {
    "properties": {
      "channel": {
        "description": "Which channel's timeline to include. Omit for the server's default.",
        "type": "string"
      },
      "server": {
        "description": "Which server to open. Omit to let the appview choose the viewer's first.",
        "format": "did",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}
output object

No description available.

Properties

activeChannelId string Optional

No description available.

activeServerDid string did Optional

A decentralized identifier (DID).

View raw schema 
{
  "properties": {
    "activeChannelId": {
      "type": "string"
    },
    "activeServerDid": {
      "format": "did",
      "type": "string"
    },
    "channels": {
      "items": {
        "ref": "chat.yakka.defs#channelView",
        "type": "ref"
      },
      "type": "array"
    },
    "members": {
      "items": {
        "ref": "chat.yakka.defs#memberView",
        "type": "ref"
      },
      "type": "array"
    },
    "readState": {
      "items": {
        "ref": "chat.yakka.defs#channelReadState",
        "type": "ref"
      },
      "type": "array"
    },
    "servers": {
      "items": {
        "ref": "chat.yakka.defs#serverView",
        "type": "ref"
      },
      "type": "array"
    },
    "timeline": {
      "ref": "chat.yakka.defs#timelinePage",
      "type": "ref"
    },
    "viewer": {
      "ref": "chat.yakka.defs#memberView",
      "type": "ref"
    }
  },
  "required": [
    "servers",
    "channels",
    "members"
  ],
  "type": "object"
}

Lexicon Garden

@