Interface NpfPostParams

interface NpfPostParams {
    content: readonly NpfContentBlock[];
    date?: string;
    interactability_reblog?: "everyone" | "noone";
    is_private?: boolean;
    layout?: readonly NpfLayoutBlock[];
    publish_on?: string;
    slug?: string;
    source_url?: string;
    state?: PostState;
    tags?: readonly string[];
}

Hierarchy (View Summary)

Properties

content date? interactability_reblog? is_private? layout? publish_on? slug? source_url? state? tags?

Properties

content

content: readonly NpfContentBlock[]

An array of NPF content blocks to be used to make the post; in a reblog, this is any content you want to add.

See

Content blocks documentation.

Optionaldate

date?: string

The exact date and time (ISO 8601 format) in the past to backdate the post, if desired. This backdating does not apply to when the post shows up in the Dashboard.

Optionalinteractability_reblog

interactability_reblog?: "everyone" | "noone"

Who can interact with this when reblogging

Optionalis_private

is_private?: boolean

Whether this should be a private answer, if this is an answer.

Optionallayout

layout?: readonly NpfLayoutBlock[]

An array of NPF layout objects to be used to lay out the post content.

See

Layout blocks documentation.

Optionalpublish_on

publish_on?: string

The exact future date and time (ISO 8601 format) to publish the post, if desired. This parameter will be ignored unless the state parameter is "queue".

Optionalslug

slug?: string

A custom URL slug to use in the post's permalink URL.

Optionalsource_url

source_url?: string

A source attribution for the post content.

Optionalstate

state?: PostState

The initial state of the new post. Defaults to "published".

Optionaltags

tags?: readonly string[]

Tags to associate with the post.

Settings

Member Visibility

On This Page

Properties