Class ListRequests

Collection of requests related to lists.

Index

Constructors

Methods

addMember create delete details members mute removeMember tweets unmute update

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:15

`Static`create

create(list: INewList): AxiosRequestConfig
Parameters
- list: INewList
  The details of the list to create.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:43

`Static`delete

delete(id: string): AxiosRequestConfig
Parameters
- id: string
  The ID of the list to delete.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:74

`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:91

`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:117

`Static`mute

mute(id: string): AxiosRequestConfig
Parameters
- id: string
  The ID of the list to mute.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:172

`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:190

`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:220

`Static`unmute

unmute(id: string): AxiosRequestConfig
Parameters
- id: string
  The ID of the list to unmute.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:276

`Static`update

update(id: string, updates: IListUpdates): AxiosRequestConfig
Parameters
- id: string
  The ID of the list to update.
- updates: IListUpdates
  The updates to apply.
Returns AxiosRequestConfig
- Defined in src/requests/List.ts:294