Interface Lists$SelectResource

interface Lists$SelectResource {
    accounts: Lists$SelectAccountsResource;
    fetch(meta?: HttpMetaParams<"none">): Promise<List>;
    remove(meta?: HttpMetaParams<"none">): Promise<void>;
    update(
        params: CreateListParams,
        meta?: HttpMetaParams<"json">,
    ): Promise<List>;
}

Index

Properties

Methods

fetch remove update

Properties

accounts

accounts: Lists$SelectAccountsResource

Methods

fetch

fetch(meta?: HttpMetaParams<"none">): Promise<List>
Fetch the list with the given ID. Used for verifying the title of a list.
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Promise<List>
List

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

remove

remove(meta?: HttpMetaParams<"none">): Promise<void>
Delete a list
Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Promise<void>
N/A

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

update

update(params: CreateListParams, meta?: HttpMetaParams<"json">): Promise<List>
Change the title of a list.
Parameters
- params: CreateListParams
  Parameters
- Optionalmeta: HttpMetaParams<"json">
Returns Promise<List>
List

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