Class TweetRequests

Collection of requests related to tweets.

Index

Constructors

Methods

bulkDetails details like likers post replies retweet retweeters schedule search unlike unpost unretweet unschedule

Constructors

constructor

new TweetRequests(): TweetRequests
Returns TweetRequests

Methods

`Static`bulkDetails

bulkDetails(ids: string[]): AxiosRequestConfig
Parameters
- ids: string[]
  The IDs of the tweets whose details are to be fetched.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:19

`Static`details

details(id: string): AxiosRequestConfig
Parameters
- id: string
  The id of the tweet whose details are to be fetched.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:81

`Static`like

like(id: string): AxiosRequestConfig
Parameters
- id: string
  The id of the tweet to be liked.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:139

`Static`likers

likers(id: string, count?: number, cursor?: string): AxiosRequestConfig
Parameters
- id: string
  The id of the tweet whose likers are to be fetched.
- Optionalcount: number
  The number of likers to fetch. Only works as a lower limit when used with a cursor.
- Optionalcursor: string
  The cursor to the batch of likers to fetch.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:158

`Static`post

post(args: INewTweet): AxiosRequestConfig
Parameters
- args: INewTweet
  The configuration object for the tweet to be posted.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:212

`Static`replies

replies(
    id: string,
    cursor?: string,
    sortBy?: RawTweetRepliesSortType,
): AxiosRequestConfig
Parameters
- id: string
  The id of the tweet whose replies are to be fetched.
- Optionalcursor: string
  The cursor to the batch of replies to fetch.
- OptionalsortBy: RawTweetRepliesSortType
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:269

`Static`retweet

retweet(id: string): AxiosRequestConfig
Parameters
- id: string
  The id of the tweet which is to be retweeted.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:335

`Static`retweeters

retweeters(id: string, count?: number, cursor?: string): AxiosRequestConfig
Parameters
- id: string
  The id of the tweet whose retweeters are to be fetched.
- Optionalcount: number
  The number of retweeters to fetch. Only works as a lower limit when used with a cursor.
- Optionalcursor: string
  The cursor to the batch of retweeters to fetch.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:355

`Static`schedule

schedule(args: INewTweet): AxiosRequestConfig
Parameters
- args: INewTweet
  The configuration object for the tweet to be posted.
Returns AxiosRequestConfig
Remarks
- Only text and media.id parameters are supported.
- Defined in src/requests/Tweet.ts:411

`Static`search

search(
    filter: ITweetFilter,
    count?: number,
    cursor?: string,
): AxiosRequestConfig
Parameters
- filter: ITweetFilter
  The filter to use for searching tweets.
- Optionalcount: number
  The number of tweets to fetch. Only works as a lower limit when used with a cursor.
- Optionalcursor: string
  The cursor to the batch of tweets to fetch.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:440

`Static`unlike

unlike(id: string): AxiosRequestConfig
Parameters
- id: string
  The id of the tweet to be unliked.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:507

`Static`unpost

unpost(id: string): AxiosRequestConfig
Parameters
- id: string
  The id of the tweet to be unposted.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:524

`Static`unretweet

unretweet(id: string): AxiosRequestConfig
Parameters
- id: string
  The id of the source tweet (which was retweeted), to be unretweeted.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:541

`Static`unschedule

unschedule(id: string): AxiosRequestConfig
Parameters
- id: string
  The id of the scheduled tweet to be unscheduled.
Returns AxiosRequestConfig
- Defined in src/requests/Tweet.ts:558