Interface TwitterV2NodeParameters

Source
interface TwitterV2NodeParameters {
    additionalFields?:
        | { attachments?: string }
        | {
            attachments?: string;
            inQuoteToStatusId?: {
                mode: "id" | "url";
                value: string;
            };
            inReplyToStatusId?: {
                mode: "id"
                | "url";
                value: string;
            };
            location?: string;
        }
        | {
            endTime?: string;
            sortOrder?: "recency"
            | "relevancy";
            startTime?: string;
            tweetFieldsObject?: (
                | "id"
                | "text"
                | "created_at"
                | "source"
                | "attachments"
                | "author_id"
                | "context_annotations"
                | "conversation_id"
                | "edit_controls"
                | "entities"
                | "geo"
                | "in_reply_to_user_id"
                | "lang"
                | "non_public_metrics"
                | "public_metrics"
                | "organic_metrics"
                | "promoted_metrics"
                | "possibly_sensitive"
                | "referenced_tweets"
                | "reply_settings"
                | "withheld"
            )[];
        };
    limit?: number;
    list?: { mode: "id"
    | "url"; value: string };
    me?: boolean;
    operation?:
        | "create"
        | "add"
        | "delete"
        | "search"
        | "like"
        | "retweet"
        | "searchUser";
    resource?: "list"
    | "user"
    | "directMessage"
    | "tweet";
    returnAll?: boolean;
    searchText?: string;
    text?: string;
    tweetDeleteId?: { mode: "id" | "url"; value: string };
    tweetId?: { mode: "id" | "url"; value: string };
    user?: { mode: "id" | "username"; value: string };
}

Properties§

Source§

readonly additionalFields?:
    | { attachments?: string }
    | {
        attachments?: string;
        inQuoteToStatusId?: {
            mode: "id" | "url";
            value: string;
        };
        inReplyToStatusId?: {
            mode: "id"
            | "url";
            value: string;
        };
        location?: string;
    }
    | {
        endTime?: string;
        sortOrder?: "recency"
        | "relevancy";
        startTime?: string;
        tweetFieldsObject?: (
            | "id"
            | "text"
            | "created_at"
            | "source"
            | "attachments"
            | "author_id"
            | "context_annotations"
            | "conversation_id"
            | "edit_controls"
            | "entities"
            | "geo"
            | "in_reply_to_user_id"
            | "lang"
            | "non_public_metrics"
            | "public_metrics"
            | "organic_metrics"
            | "promoted_metrics"
            | "possibly_sensitive"
            | "referenced_tweets"
            | "reply_settings"
            | "withheld"
        )[];
    }

Default: {}

Source§

readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

Source§

readonly list?: { mode: "id" | "url"; value: string }

The list you want to add the user to Default: {"mode":"id","value":""}

Source§

readonly me?: boolean

Whether you want to search the authenticated user

Source§

readonly operation?:
    | "create"
    | "add"
    | "delete"
    | "search"
    | "like"
    | "retweet"
    | "searchUser"

Default: "create"

Source§

readonly resource?: "list" | "user" | "directMessage" | "tweet"

Default: "tweet"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly searchText?: string

A UTF-8, URL-encoded search query of 500 characters maximum, including operators. Queries may additionally be limited by complexity. Check the searching examples here.

Source§

readonly text?: string

The text of the direct message. URL encoding is required. Max length of 10,000 characters. Type options: {"rows":2}

Source§

readonly tweetDeleteId?: { mode: "id" | "url"; value: string }

The tweet to delete Default: {"mode":"id","value":""}

Source§

readonly tweetId?: { mode: "id" | "url"; value: string }

The tweet to like Default: {"mode":"id","value":""}

Source§

readonly user?: { mode: "id" | "username"; value: string }

The user you want to send the message to Default: {"mode":"username","value":""}