Interface Lists$SelectAccountsResource

interface Lists$SelectAccountsResource {
    create(
        params: AddListAccountsParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<void>;
    list(
        params?: DefaultPaginationParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
    remove(
        params: AddListAccountsParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<void>;
}

Index

Methods

create list remove

Methods

create

create(
params: AddListAccountsParams,
meta?: HttpMetaParams<"json">,
): Promise<void>
Add accounts to the given list. Note that the user must be following these accounts.
Parameters
- params: AddListAccountsParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<void>
N/A

See
https://docs.joinmastodon.org/methods/timelines/lists#accounts-add
- Defined in src/mastodon/rest/v1/lists.ts:42

list

list(
params?: DefaultPaginationParams,
meta?: HttpMetaParams<"none">,
): Paginator<mastodon.v1.Account[], DefaultPaginationParams>
View accounts in list
Parameters
- Optionalparams: DefaultPaginationParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<mastodon.v1.Account[], DefaultPaginationParams>
Array of Account

See
https://docs.joinmastodon.org/methods/timelines/lists#accounts
- Defined in src/mastodon/rest/v1/lists.ts:30

remove

remove(
params: AddListAccountsParams,
meta?: HttpMetaParams<"json">,
): Promise<void>
Remove accounts from the given list.
Parameters
- params: AddListAccountsParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<void>
N/A

See
https://docs.joinmastodon.org/methods/timelines/lists#accounts-remove
- Defined in src/mastodon/rest/v1/lists.ts:54