jointrashposs/content/ja/.docs-legacy/api/endpoints/notes/state.json5

52 lines
1.3 KiB
Plaintext
Raw Normal View History

2023-07-08 10:36:02 +02:00
{
summary: 'ノートに対するログイン中のユーザによるアクション(お気に入り・ウォッチ・スレッドミュート)を取得します。',
description: 'ノートに対するログイン中のユーザによるアクション(お気に入り・ウォッチ・スレッドミュート)を取得します。',
tags: [
'notes',
],
requireCredential: true,
req: {
type: 'object',
properties: {
noteId: {
type: 'string',
format: 'misskey:id',
description: 'ートのid。',
},
},
required: [
'noteId',
],
},
res: {
type: 'object',
optional: false,
nullable: false,
properties: {
isFavorited: {
type: 'boolean',
optional: false,
nullable: false,
description: 'ートをお気に入りに登録するとtrueになります。'
},
isWatching: {
type: 'boolean',
optional: false,
nullable: false,
description: 'ートをウォッチするとtrueになります。'
},
isMutedThread: {
type: 'boolean',
optional: false,
nullable: false,
description: 'ートから始まる、またはートが属するスレッドをミュートするとtrueになります。'
},
},
required: [
'isFavorited',
'isWatching',
'isMutedThread',
],
},
errors: {},
}