itd-api / CommentBuilder

Interface: CommentBuilder

Defined in: builders/comment.ts:57

Билдер комментария и ответа на комментарий.

Неизменяемый: каждый вызов возвращает новый экземпляр. Создаётся функцией comment.

Implements

• ItdBuilder<CreateCommentInput>

Methods

attach()

attach(file): CommentBuilder;

Defined in: builders/comment.ts:74

Прикладывает файл — он будет загружен перед отправкой.

Parameters

file

FileInput

Returns

CommentBuilder

---

attachId()

attachId(attachmentId): CommentBuilder;

Defined in: builders/comment.ts:79

Прикладывает уже загруженное вложение.

Parameters

attachmentId

string

Returns

CommentBuilder

---

build()

build(): CreateCommentInput;

Defined in: builders/comment.ts:113

Собирает и проверяет результат.

Returns

CreateCommentInput

Throws

если нарушены требования к данным

Implementation of

ItdBuilder.build

---

content()

content(text): CommentBuilder;

Defined in: builders/comment.ts:69

Задаёт текст комментария.

Parameters

text

string

Returns

CommentBuilder

---

replyTo()

replyTo(userId): CommentBuilder;

Defined in: builders/comment.ts:109

Кому адресован ответ.

Имеет смысл только в itd.comments.reply(); при отправке комментария к посту это поле вызовет ошибку.

Parameters

userId

string

Returns

CommentBuilder

---

toJSON()

toJSON(): CreateCommentInput;

Defined in: builders/comment.ts:126

Чтобы билдер корректно вёл себя внутри JSON.stringify.

Returns

CreateCommentInput

Implementation of

ItdBuilder.toJSON

---

voice()

voice(audio): CommentBuilder;

Defined in: builders/comment.ts:99

Делает комментарий голосовым.

Текста у такого комментария быть не должно, а вложение ровно одно — аудио в формате audio/ogg. Так его принимает API.

Parameters

audio

FileInput

Returns

CommentBuilder

Example

import { fromPath } from 'itd-api/node';

await itd.posts.comment(postId, (c) => c.voice(fromPath('./answer.ogg')));