jointrashposs/content/ja/.docs-legacy/api/endpoints/notes/user-list-timeline.json5

86 lines
2.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: {
listId: {
type: 'string',
format: 'misskey:id',
description: 'リストのid。',
},
limit: {
type: 'integer',
minimum: 1,
maximum: 100,
default: 10,
description: '取得するリストの最大数。',
},
sinceId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも大きいートを返します。',
},
untilId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも小さいートを返します。',
},
sinceDate: {
type: 'integer',
description: 'エポック秒で日時を指定すると、その日時より後に作成されたノートを返します。',
},
untilDate: {
type: 'integer',
description: 'エポック秒で日時を指定すると、その日時より前に作成されたノートを返します。',
},
includeMyRenotes: {
type: 'boolean',
default: true,
description: 'trueにすると、ログイン中のユーザーが行ったRenoteを含めます。',
},
includeRenotedMyNotes: {
type: 'boolean',
default: true,
description: 'trueにすると、Renoteされたログイン中のユーザーのートを含めます。'
},
includeLocalRenotes: {
type: 'boolean',
default: true,
description: 'trueにすると、Renoteされたローカルの投稿を含めます。',
},
withFiles: {
type: 'boolean',
default: false,
description: 'trueにすると、ファイルが添付されたートだけを返します。',
},
},
required: [
'listId',
],
},
res: {
type: 'array',
optional: false,
nullable: false,
items: {
type: 'object',
optional: false,
nullable: false,
ref: 'Note',
$ref: 'misskey://Note',
},
},
errors: {
'8fb1fbd5-e476-4c37-9fb0-43d55b63a2ff': {
id: '8fb1fbd5-e476-4c37-9fb0-43d55b63a2ff',
code: 'NO_SUCH_LIST',
description: 'リストが存在しません。',
},
},
}