protocol/json/keybase1/favorite.json - master - githubmirror/client

protocol/json/keybase1/favorite.json
242 строки5 KB
Song Gao
plumb actions and redux store for new conflict protocol changes (#17885)
20 июн 2019, 02:22
20 июн 2019, 02:22612947d
{
  "protocol": "favorite",
  "imports": [
    {
      "path": "common.avdl",
      "type": "idl"
    }
  ],
  "types": [
    {
      "type": "enum",
      "name": "FolderType",
      "symbols": [
        "UNKNOWN_0",
        "PRIVATE_1",
        "PUBLIC_2",
        "TEAM_3"
      ]
    },
    {
      "type": "enum",
      "name": "FolderConflictType",
      "symbols": [
        "NONE_0",
        "IN_CONFLICT_1",
        "IN_CONFLICT_AND_STUCK_2",
        "CLEARED_CONFLICT_3"
      ]
    },
    {
      "type": "enum",
      "name": "ConflictStateType",
      "symbols": [
        "NormalView_1",
        "ManualResolvingLocalView_2"
      ]
    },
    {
      "type": "record",
      "name": "FolderNormalView",
      "fields": [
        {
          "type": "boolean",
          "name": "resolvingConflict"
        },
        {
          "type": "boolean",
          "name": "stuckInConflict"
        },
        {
          "type": {
            "type": "array",
            "items": "Path"
          },
          "name": "localViews"
        }
      ]
    },
    {
      "type": "record",
      "name": "FolderConflictManualResolvingLocalView",
      "fields": [
        {
          "type": "Path",
          "name": "normalView"
        }
      ]
    },
    {
      "type": "variant",
      "name": "ConflictState",
      "switch": {
        "type": "ConflictStateType",
        "name": "conflictStateType"
      },
      "cases": [
        {
          "label": {
            "name": "NormalView",
            "def": false
          },
          "body": "FolderNormalView"
        },
        {
          "label": {
            "name": "ManualResolvingLocalView",
            "def": false
          },
          "body": "FolderConflictManualResolvingLocalView"
        }
      ]
    },
    {
      "type": "record",
      "name": "Folder",
      "fields": [
        {
          "type": "string",
          "name": "name"
        },
        {
          "type": "boolean",
          "name": "private"
        },
        {
          "type": "boolean",
          "name": "created"
        },
        {
          "type": "FolderType",
          "name": "folderType"
        },
        {
          "type": [
            null,
            "TeamID"
          ],
          "name": "teamID",
          "jsonkey": "team_id",
          "mpackkey": "team_id"
        },
        {
          "type": {
            "type": "array",
            "items": "User"
          },
          "name": "resetMembers",
          "jsonkey": "reset_members",
          "mpackkey": "reset_members"
        },
        {
          "type": [
            null,
            "Time"
          ],
          "name": "mtime"
        },
        {
          "type": [
            null,
            "ConflictState"
          ],
          "name": "conflictState"
        },
        {
          "type": [
            null,
            "FolderSyncConfig"
          ],
          "name": "syncConfig"
        }
      ],
      "doc": "Folder represents a favorite top-level folder in kbfs.\n    This type is likely to change significantly as all the various parts are\n    connected and tested."
    },
    {
      "type": "record",
      "name": "FolderHandle",
      "fields": [
        {
          "type": "string",
          "name": "name"
        },
        {
          "type": "FolderType",
          "name": "folderType"
        },
        {
          "type": "boolean",
          "name": "created"
        }
      ]
    },
    {
      "type": "record",
      "name": "FavoritesResult",
      "fields": [
        {
          "type": {
            "type": "array",
            "items": "Folder"
          },
          "name": "favoriteFolders"
        },
        {
          "type": {
            "type": "array",
            "items": "Folder"
          },
          "name": "ignoredFolders"
        },
        {
          "type": {
            "type": "array",
            "items": "Folder"
          },
          "name": "newFolders"
        }
      ]
    }
  ],
  "messages": {
    "favoriteAdd": {
      "request": [
        {
          "name": "sessionID",
          "type": "int"
        },
        {
          "name": "folder",
          "type": "FolderHandle"
        }
      ],
      "response": null,
      "doc": "Adds a folder to a user's list of favorite folders."
    },
    "favoriteIgnore": {
      "request": [
        {
          "name": "sessionID",
          "type": "int"
        },
        {
          "name": "folder",
          "type": "FolderHandle"
        }
      ],
      "response": null,
      "doc": "Removes a folder from a user's list of favorite folders."
    },
    "getFavorites": {
      "request": [
        {
          "name": "sessionID",
          "type": "int"
        }
      ],
      "response": "FavoritesResult",
      "doc": "Returns all of a user's favorite folders."
    }
  },
  "namespace": "keybase.1"
}