Skip to content

Latest commit

 

History

History
99 lines (88 loc) · 4.86 KB

comment.md

File metadata and controls

99 lines (88 loc) · 4.86 KB

Comment

A Comment object represents a comment on a Notion page or block. Comments contain rich text content and are associated with discussion threads.

This model accepts additional fields of type Object.

Structure

Comment

Fields

Name Type Tags Description Getter Setter
Object Object11 Required Always "comment" for comment objects. Object11 getObject() setObject(Object11 object)
Id UUID Required Unique identifier for the comment. UUID getId() setId(UUID id)
Parent Parent1 Required The parent page or block the comment belongs to. Parent1 getParent() setParent(Parent1 parent)
DiscussionId UUID Required The ID of the discussion thread the comment belongs to. UUID getDiscussionId() setDiscussionId(UUID discussionId)
CreatedTime LocalDateTime Required Date and time when the comment was created (ISO 8601). LocalDateTime getCreatedTime() setCreatedTime(LocalDateTime createdTime)
LastEditedTime LocalDateTime Required Date and time when the comment was last edited (ISO 8601). LocalDateTime getLastEditedTime() setLastEditedTime(LocalDateTime lastEditedTime)
CreatedBy PartialUser Required A partial User object containing only the object type and ID. Used in created_by and last_edited_by fields. PartialUser getCreatedBy() setCreatedBy(PartialUser createdBy)
RichText List<RichText> Required Rich text content of the comment. List getRichText() setRichText(List richText)
AdditionalProperties Map<String, Object> Optional - Object getAdditionalProperty(String key) additionalProperty(String key, Object value)

Example

import com.notion.api.ApiHelper;
import com.notion.api.DateTimeHelper;
import com.notion.api.models.Annotations;
import com.notion.api.models.Comment;
import com.notion.api.models.Equation;
import com.notion.api.models.Link;
import com.notion.api.models.Object11;
import com.notion.api.models.Object2;
import com.notion.api.models.Parent1;
import com.notion.api.models.PartialUser;
import com.notion.api.models.RichText;
import com.notion.api.models.Text;
import com.notion.api.models.Type11;
import com.notion.api.models.Type2;
import java.io.IOException;
import java.util.Arrays;
import java.util.UUID;

Comment comment = new Comment.Builder(
    Object11.COMMENT,
    UUID.fromString("00002144-0000-0000-0000-000000000000"),
    new Parent1.Builder()
        .type(Type11.PAGE_ID)
        .pageId(UUID.fromString("00001234-0000-0000-0000-000000000000"))
        .blockId(UUID.fromString("00001a0c-0000-0000-0000-000000000000"))
    .additionalProperty("exampleAdditionalProperty", ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
        .build(),
    UUID.fromString("0000150e-0000-0000-0000-000000000000"),
    DateTimeHelper.fromRfc8601DateTime("2016-03-13T12:52:32.123Z"),
    DateTimeHelper.fromRfc8601DateTime("2016-03-13T12:52:32.123Z"),
    new PartialUser.Builder(
        Object2.USER,
        UUID.fromString("00001f9c-0000-0000-0000-000000000000")
    )
    .additionalProperty("exampleAdditionalProperty", ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
    .build(),
    Arrays.asList(
        new RichText.Builder(
            Type2.EQUATION,
            "plain_text4"
        )
        .text(new Text.Builder()
                .content("content4")
                .link(new Link.Builder()
                    .url("url4")
                .additionalProperty("exampleAdditionalProperty", ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
                    .build())
            .additionalProperty("exampleAdditionalProperty", ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
                .build())
        .mention(ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
        .equation(new Equation.Builder()
                .expression("expression2")
            .additionalProperty("exampleAdditionalProperty", ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
                .build())
        .annotations(new Annotations.Builder()
                .bold(false)
                .italic(false)
                .strikethrough(false)
                .underline(false)
                .code(false)
            .additionalProperty("exampleAdditionalProperty", ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
                .build())
        .href("href4")
        .additionalProperty("exampleAdditionalProperty", ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
        .build()
    )
)
.additionalProperty("exampleAdditionalProperty", ApiHelper.deserialize("{\"key1\":\"val1\",\"key2\":\"val2\"}"))
.build();