Class ListRequests

Collection of requests related to lists.

Index

Constructors

Methods

addMember details members removeMember tweets

Constructors

constructor

new ListRequests(): ListRequests
Returns ListRequests

Methods

`Static`addMember

addMember(listId: string, userId: string): AxiosRequestConfig
Parameters
- listId: string
  The ID of the target list.
- userId: string
  The ID of the user to be added as a member.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:13

`Static`details

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

`Static`members

members(id: string, count?: number, cursor?: string): AxiosRequestConfig
Parameters
- id: string
  The id of the list whose members are to be fetched.
- Optionalcount: number
  The number of members to fetch. Must be <= 100.
- Optionalcursor: string
  The cursor to the batch of members to fetch.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:66

`Static`removeMember

removeMember(listId: string, userId: string): AxiosRequestConfig
Parameters
- listId: string
  The ID of the target list.
- userId: string
  The ID of the user to remove as a member.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:119

`Static`tweets

tweets(id: string, count?: number, cursor?: string): AxiosRequestConfig
Parameters
- id: string
  The id of the list whose tweets are to be fetched.
- Optionalcount: number
  The number of tweets to fetch. Must be <= 100.
- Optionalcursor: string
  The cursor to the batch of tweets to fetch.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:149