query

优质

小牛编辑

127浏览

2023-12-01

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

Fields

action (Action)

动作查询接口

Argument	Type	Description
`actionId`	`String!`	动作ID作为唯一的查询参数

endpoints ([Endpoint])

获取终端列表

homes ([Home])

获取家庭列表

Argument	Type	Description
`page`	`Int`	当前页数
`per`	`Int`	分页大小

models ([Model])

列出所有设备类型

Argument	Type	Description
`type`	`ModelType`	类型，与 `typeRaw` 可填其中一个。当均为空时默认为 `LIGHT`，否则 `type` 优先 (`typeRaw` 将被覆盖)
`typeRaw`	`String`	类型，用于扩展 `type` 参数未涉及的类型
`page`	`Int`	分页，从 `1` 开始
`per`	`Int`	分页大小

rooms ([Room])

列出指定 Home 下的所有 Room

search (Search)

查询 Search 终端同步结果

Argument	Type	Description
`searchId`	`String!`	`Search` ID

skills ([Skill])

与 Home 关联的所有 Skill

skillAccounts ([SkillAccount])

获取与 Home 及 Skill 相关的所有 SkillAccount

skillAuthURL (SkillAuthURL)

获取技能授权地址，要求 Skill#authType 为 RFC6749。查看技能授权时序图

Argument Type Description

skillId

String!

技能/驱动 ID

callbackUri

String!

授权结果回调地址，用于定制授权结果显示页面。将从 query 获取以下字段，如授权成功后，用户将被跳转到 <callbackUri>?ok=true&authType=rfc6749&homeId=xxx&driverAccountId=yyy

Name	Type	Mandatory	Description
`ok`	`true \| false`	Mandatory	授权成功或失败
`authType`	`string`	Mandatory	授权类型，固定为 `rfc6749`
`homeId`	`string`	Mandatory	home ID，与传入的 `homeId` 一致
`driverAccountId`	`string`	Optional	如果授权成功，返回授权创建的 `driverAccountId` (即`skillAccountId`)
`error`	`string`	Optional	如果授权失败，返回短简的错误信息

homeId

String!

指定在某个家庭下的 Skill

rokidId

String