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

73 lines
2.0 KiB
Plaintext
Raw Normal View History

2023-07-08 10:36:02 +02:00
{
summary: 'ホームタイムライン (HTL) を取得します。',
description: 'ホームタイムライン (HTL) を取得します。ホームタイムラインは、自分のフォローしているユーザーのノートが含まれます。',
tags: [
'notes',
],
requireCredential: true,
req: {
type: 'object',
properties: {
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: 'ファイルが添付されたノートのみ取得するか否か',
},
},
required: [],
},
res: {
type: 'array',
optional: false,
nullable: false,
items: {
type: 'object',
optional: false,
nullable: false,
ref: 'Note',
$ref: 'misskey://Note',
},
},
errors: {},
}