appBskyFeedGetTimeline top-level constant

Map<String, dynamic> const appBskyFeedGetTimeline

app.bsky.feed.getTimeline

Implementation

const appBskyFeedGetTimeline = <String, dynamic>{
  "lexicon": 1,
  "id": "app.bsky.feed.getTimeline",
  "defs": {
    "main": {
      "type": "query",
      "description":
          "Get a view of the requesting account's home timeline. This is expected to be some form of reverse-chronological feed.",
      "parameters": {
        "type": "params",
        "properties": {
          "algorithm": {
            "type": "string",
            "description":
                "Variant 'algorithm' for timeline. Implementation-specific. NOTE: most feed flexibility has been moved to feed generator mechanism.",
          },
          "limit": {
            "type": "integer",
            "default": 50,
            "minimum": 1,
            "maximum": 100,
          },
          "cursor": {"type": "string"},
          "since": {
            "type": "string",
            "description":
                "Return only items newer than the position identified by this cursor value, newest first. Use the startCursor from a previous response. The item at that position is not returned because the caller already holds it. When the bounded range is exhausted, the returned cursor equals this value so that pagination continues below the boundary.",
          },
        },
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "type": "object",
          "required": ["feed"],
          "properties": {
            "cursor": {"type": "string"},
            "startCursor": {
              "type": "string",
              "description":
                  "Cursor identifying the newest item in this page. Pass it as since on a later request to fetch only newer content.",
            },
            "feed": {
              "type": "array",
              "items": {
                "type": "ref",
                "ref": "app.bsky.feed.defs#feedViewPost",
              },
            },
          },
        },
      },
    },
  },
};