Interface CreateInlineCommentModel

interface CreateInlineCommentModel {
    blogPostId?: string;
    body?: CommentBodyWrite | CommentNestedBodyWrite;
    inlineCommentProperties?: {
        textSelection?: string;
        textSelectionMatchCount?: number;
        textSelectionMatchIndex?: number;
    } & {
        [key: string]: unknown;
    };
    pageId?: string;
    parentCommentId?: string;
}

Hierarchy

  • Record<string, unknown>
    • CreateInlineCommentModel

Properties

blogPostId? body? inlineCommentProperties? pageId? parentCommentId?

Properties

OptionalblogPostId

blogPostId?: string

ID of the containing blog post, if intending to create a top level footer comment. Do not provide if creating a reply.

Optionalbody

body?: CommentBodyWrite | CommentNestedBodyWrite

OptionalinlineCommentProperties

inlineCommentProperties?: {
    textSelection?: string;
    textSelectionMatchCount?: number;
    textSelectionMatchIndex?: number;
} & {
    [key: string]: unknown;
}

Object describing the text to highlight on the page/blog post. Only applicable for top level inline comments (not replies) and required in that case.

Type declaration

  • OptionaltextSelection?: string

    The text to highlight

  • OptionaltextSelectionMatchCount?: number

    The number of matches for the selected text on the page (should be strictly greater than textSelectionMatchIndex)

  • OptionaltextSelectionMatchIndex?: number

    The match index to highlight. This is zero-based. E.g. if you have 3 occurrences of "hello world" on a page and you want to highlight the second occurrence, you should pass 1 for textSelectionMatchIndex and 3 for textSelectionMatchCount.

OptionalpageId

pageId?: string

ID of the containing page, if intending to create a top level footer comment. Do not provide if creating a reply.

OptionalparentCommentId

parentCommentId?: string

ID of the parent comment, if intending to create a reply. Do not provide if creating a top level comment.

Settings

Member Visibility

On This Page

Properties