Interface ListRepository

interface ListRepository {
    $select(id): {
        accounts: {
            create(params, meta?): Promise<void>;
            list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
            remove(params, meta?): Promise<void>;
        };
        fetch(meta?): Promise<List>;
        remove(meta?): Promise<void>;
        update(params, meta?): Promise<List>;
    };
    create(params, meta?): Promise<List>;
    list(meta?): Paginator<List[], undefined>;
}

Index

Methods

$select create list

Methods

$select

$select(id): {
    accounts: {
        create(params, meta?): Promise<void>;
        list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
        remove(params, meta?): Promise<void>;
    };
    fetch(meta?): Promise<List>;
    remove(meta?): Promise<void>;
    update(params, meta?): Promise<List>;
}
Parameters
- id: string
Returns {
    accounts: {
        create(params, meta?): Promise<void>;
        list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
        remove(params, meta?): Promise<void>;
    };
    fetch(meta?): Promise<List>;
    remove(meta?): Promise<void>;
    update(params, meta?): Promise<List>;
}
- accounts: {
      create(params, meta?): Promise<void>;
      list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
      remove(params, meta?): Promise<void>;
  }
  - create:function
    - create(params, meta?): Promise<void>
    - Add accounts to the given list. Note that the user must be following these accounts.
      Parameters
      params: AddListAccountsParams
      Parameters
      
      Optional meta: HttpMetaParams<"json">
      Returns Promise<void>
      N/A
      
      See
      https://docs.joinmastodon.org/methods/timelines/lists#accounts-add
      Defined in src/mastodon/rest/v1/list-repository.ts:70
  - list:function
    - list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>
    - View accounts in list
      Parameters
      Optional params: DefaultPaginationParams
      Parameters
      
      Optional meta: 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/list-repository.ts:58
  - remove:function
    - remove(params, meta?): Promise<void>
    - Remove accounts from the given list.
      Parameters
      params: AddListAccountsParams
      Parameters
      
      Optional meta: HttpMetaParams<"json">
      Returns Promise<void>
      N/A
      
      See
      https://docs.joinmastodon.org/methods/timelines/lists#accounts-remove
      Defined in src/mastodon/rest/v1/list-repository.ts:82
- fetch:function
  - fetch(meta?): Promise<List>
  - Fetch the list with the given ID. Used for verifying the title of a list.
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<List>
    List
    
    See
    https://docs.joinmastodon.org/methods/timelines/lists/
    - Defined in src/mastodon/rest/v1/list-repository.ts:29
- remove:function
  - remove(meta?): Promise<void>
  - Delete a list
    Parameters
    - Optional meta: HttpMetaParams<"none">
    Returns Promise<void>
    N/A
    
    See
    https://docs.joinmastodon.org/methods/timelines/lists/
    - Defined in src/mastodon/rest/v1/list-repository.ts:48
- update:function
  - update(params, meta?): Promise<List>
  - Change the title of a list.
    Parameters
    - params: CreateListParams
      Parameters
    - Optional meta: HttpMetaParams<"json">
    Returns Promise<List>
    List
    
    See
    https://docs.joinmastodon.org/methods/timelines/lists/
    - Defined in src/mastodon/rest/v1/list-repository.ts:37
- Defined in src/mastodon/rest/v1/list-repository.ts:23

create

create(params, meta?): Promise<List>
Create a new list.
Parameters
- params: CreateListParams
  Parameters
- Optional meta: HttpMetaParams<"json">
Returns Promise<List>
List

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

list

list(meta?): Paginator<List[], undefined>
Fetch all lists that the user owns.
Parameters
- Optional meta: HttpMetaParams<"none">
Returns Paginator<List[], undefined>
Array of List

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

Interface ListRepository

Index

Methods

Methods

$select

Parameters

Returns { accounts: { create(params, meta?): Promise<void>; list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>; remove(params, meta?): Promise<void>; }; fetch(meta?): Promise<List>; remove(meta?): Promise<void>; update(params, meta?): Promise<List>; }

accounts: { create(params, meta?): Promise<void>; list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>; remove(params, meta?): Promise<void>; }

create:function

Parameters

Returns Promise<void>

See

list:function

Parameters

Returns Paginator<mastodon.v1.Account[], DefaultPaginationParams>

See

remove:function

Parameters

Returns Promise<void>

See

fetch:function

Parameters

Returns Promise<List>

See

remove:function

Parameters

Returns Promise<void>

See

update:function

Parameters

Returns Promise<List>

See

create

Parameters

Returns Promise<List>

See

list

Parameters

Returns Paginator<List[], undefined>

See

Settings

Member Visibility

Theme

On This Page

Returns {
accounts: {
create(params, meta?): Promise<void>;
list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
remove(params, meta?): Promise<void>;
};
fetch(meta?): Promise<List>;
remove(meta?): Promise<void>;
update(params, meta?): Promise<List>;
}

accounts: {
create(params, meta?): Promise<void>;
list(params?, meta?): Paginator<mastodon.v1.Account[], DefaultPaginationParams>;
remove(params, meta?): Promise<void>;
}