Interface: CommentView
Defined in: src/types/index.ts:10
Extends
output<typeofschemas.CommentView>
Properties
| Property | Type | Default value | Description | Inherited from | Defined in |
|---|---|---|---|---|---|
banned_from_community | boolean | undefined | - | z.infer.banned_from_community | src/schemas/CommentView.ts:11 |
comment | object | Comment | - | z.infer.comment | src/schemas/CommentView.ts:12 |
comment.ap_id | string | undefined | The federated activity id / ap_id. | - | src/schemas/Comment.ts:7 |
comment.child_count | number | undefined | The total number of children in this comment branch. | - | src/schemas/Comment.ts:11 |
comment.content | string | undefined | - | - | src/schemas/Comment.ts:12 |
comment.creator_id | number | undefined | - | - | src/schemas/Comment.ts:13 |
comment.deleted | boolean | undefined | Whether the comment has been deleted by its creator. | - | src/schemas/Comment.ts:17 |
comment.distinguished | boolean | undefined | Whether the comment has been distinguished (speaking officially) by a mod. | - | src/schemas/Comment.ts:21 |
comment.downvotes | number | undefined | - | - | src/schemas/Comment.ts:22 |
comment.id | number | undefined | - | - | src/schemas/Comment.ts:23 |
comment.language_id | number | undefined | - | - | src/schemas/Comment.ts:24 |
comment.local | boolean | undefined | Whether the comment is local. | - | src/schemas/Comment.ts:28 |
comment.path | string | undefined | The path / tree location of a comment, separated by dots, ending with the comment's id. Ex: 0.24.27 | - | src/schemas/Comment.ts:33 |
comment.post_id | number | undefined | - | - | src/schemas/Comment.ts:34 |
comment.published_at | string | undefined | - | - | src/schemas/Comment.ts:35 |
comment.removed | boolean | undefined | Whether the comment has been removed. | - | src/schemas/Comment.ts:39 |
comment.score | number | undefined | - | - | src/schemas/Comment.ts:40 |
comment.updated_at? | string | undefined | - | - | src/schemas/Comment.ts:41 |
comment.upvotes | number | undefined | - | - | src/schemas/Comment.ts:42 |
community | object | Community | - | z.infer.community | src/schemas/CommentView.ts:13 |
community.ap_id | string | undefined | The federated activity id / ap_id. | - | src/schemas/Community.ts:9 |
community.banner? | string | undefined | - | - | src/schemas/Community.ts:10 |
community.comments | number | undefined | - | - | src/schemas/Community.ts:11 |
community.deleted | boolean | undefined | - | - | src/schemas/Community.ts:12 |
community.icon? | string | undefined | - | - | src/schemas/Community.ts:13 |
community.id | number | undefined | - | - | src/schemas/Community.ts:14 |
community.local | boolean | undefined | - | - | src/schemas/Community.ts:15 |
community.name | string | undefined | - | - | src/schemas/Community.ts:16 |
community.nsfw | boolean | undefined | - | - | src/schemas/Community.ts:17 |
community.posting_restricted_to_mods | boolean | undefined | - | - | src/schemas/Community.ts:18 |
community.posts | number | undefined | - | - | src/schemas/Community.ts:19 |
community.published_at | string | undefined | - | - | src/schemas/Community.ts:20 |
community.removed | boolean | undefined | - | - | src/schemas/Community.ts:21 |
community.sidebar? | string | undefined | Long-form sidebar markdown (replaced v0's description). | - | src/schemas/Community.ts:25 |
community.subscribers | number | undefined | - | - | src/schemas/Community.ts:26 |
community.subscribers_local | number | undefined | - | - | src/schemas/Community.ts:27 |
community.summary? | string | undefined | Short one-line summary. | - | src/schemas/Community.ts:31 |
community.title | string | undefined | - | - | src/schemas/Community.ts:32 |
community.updated_at? | string | undefined | - | - | src/schemas/Community.ts:33 |
community.users_active_day | number | undefined | - | - | src/schemas/Community.ts:34 |
community.users_active_half_year | number | undefined | - | - | src/schemas/Community.ts:35 |
community.users_active_month | number | undefined | - | - | src/schemas/Community.ts:36 |
community.users_active_week | number | undefined | - | - | src/schemas/Community.ts:37 |
community.visibility | | "public" | "unlisted" | "local_only_public" | "local_only_private" | "private" | CommunityVisibility | - | - | src/schemas/Community.ts:38 |
creator | object | Person | - | z.infer.creator | src/schemas/CommentView.ts:14 |
creator.ap_id | string | undefined | The federated activity id / ap_id. | - | src/schemas/Person.ts:7 |
creator.avatar? | string | undefined | - | - | src/schemas/Person.ts:8 |
creator.banner? | string | undefined | - | - | src/schemas/Person.ts:9 |
creator.bio? | string | undefined | - | - | src/schemas/Person.ts:10 |
creator.bot_account | boolean | undefined | - | - | src/schemas/Person.ts:11 |
creator.comment_count | number | undefined | - | - | src/schemas/Person.ts:12 |
creator.deleted | boolean | undefined | - | - | src/schemas/Person.ts:13 |
creator.display_name? | string | undefined | - | - | src/schemas/Person.ts:14 |
creator.id | number | undefined | - | - | src/schemas/Person.ts:15 |
creator.local | boolean | undefined | - | - | src/schemas/Person.ts:16 |
creator.name | string | undefined | - | - | src/schemas/Person.ts:17 |
creator.post_count | number | undefined | - | - | src/schemas/Person.ts:18 |
creator.published_at | string | undefined | - | - | src/schemas/Person.ts:19 |
creator_banned_from_community | boolean | undefined | - | z.infer.creator_banned_from_community | src/schemas/CommentView.ts:15 |
creator_is_admin | boolean | undefined | - | z.infer.creator_is_admin | src/schemas/CommentView.ts:16 |
creator_is_moderator | boolean | undefined | - | z.infer.creator_is_moderator | src/schemas/CommentView.ts:17 |
my_vote? | number | undefined | - | z.infer.my_vote | src/schemas/CommentView.ts:18 |
post | object | Post | - | z.infer.post | src/schemas/CommentView.ts:19 |
post.alt_text? | string | undefined | An optional alt_text, usable for image posts. | - | src/schemas/Post.ts:7 |
post.ap_id | string | undefined | The federated activity id / ap_id. | - | src/schemas/Post.ts:11 |
post.body? | string | undefined | An optional post body, in markdown. | - | src/schemas/Post.ts:15 |
post.comments | number | undefined | - | - | src/schemas/Post.ts:16 |
post.community_id | number | undefined | - | - | src/schemas/Post.ts:17 |
post.creator_id | number | undefined | - | - | src/schemas/Post.ts:18 |
post.deleted | boolean | undefined | Whether the post is deleted. | - | src/schemas/Post.ts:22 |
post.downvotes | number | undefined | - | - | src/schemas/Post.ts:23 |
post.embed_description? | string | undefined | A description for the link. | - | src/schemas/Post.ts:27 |
post.embed_title? | string | undefined | A title for the link. | - | src/schemas/Post.ts:31 |
post.featured_community | boolean | undefined | Whether the post is featured to its community. | - | src/schemas/Post.ts:35 |
post.featured_local | boolean | undefined | Whether the post is featured to its site. | - | src/schemas/Post.ts:39 |
post.id | number | undefined | - | - | src/schemas/Post.ts:40 |
post.language_id | number | undefined | - | - | src/schemas/Post.ts:41 |
post.local | boolean | undefined | Whether the post is local. | - | src/schemas/Post.ts:45 |
post.locked | boolean | undefined | Whether the post is locked. | - | src/schemas/Post.ts:49 |
post.name | string | undefined | - | - | src/schemas/Post.ts:50 |
post.newest_comment_time_at? | string | undefined | The time of the newest comment in the post. | - | src/schemas/Post.ts:54 |
post.nsfw | boolean | undefined | Whether the post is NSFW. | - | src/schemas/Post.ts:58 |
post.published_at | string | undefined | - | - | src/schemas/Post.ts:59 |
post.removed | boolean | undefined | Whether the post is removed. | - | src/schemas/Post.ts:63 |
post.score | number | undefined | - | - | src/schemas/Post.ts:64 |
post.thumbnail_url? | string | undefined | A thumbnail picture url. | - | src/schemas/Post.ts:68 |
post.updated_at? | string | undefined | - | - | src/schemas/Post.ts:69 |
post.upvotes | number | undefined | - | - | src/schemas/Post.ts:70 |
post.url? | string | undefined | An optional link / url for the post. | - | src/schemas/Post.ts:74 |
post.url_content_type? | string | undefined | - | - | src/schemas/Post.ts:75 |
saved | boolean | undefined | - | z.infer.saved | src/schemas/CommentView.ts:20 |
subscribed | "Subscribed" | "NotSubscribed" | "Pending" | "ApprovalRequired" | SubscribedType | - | z.infer.subscribed | src/schemas/CommentView.ts:21 |
