Interface SuggestionRepository

interface SuggestionRepository {
    $select(
        id: string,
    ): { remove(id: string, meta?: HttpMetaParams<"none">): Promise<void> };
    list(
        params?: ListSuggestionParams,
        meta?: HttpMetaParams<"none">,
    ): Paginator<mastodon.v1.Account[], ListSuggestionParams>;
}

Index

Methods

$select list

Methods

$select

$select(
id: string,
): { remove(id: string, meta?: HttpMetaParams<"none">): Promise<void> }
Parameters
- id: string
Returns { remove(id: string, meta?: HttpMetaParams<"none">): Promise<void> }
- remove:function
  - remove(id: string, meta?: HttpMetaParams<"none">): Promise<void>
    Remove an account from follow suggestions.
    
    Parameters
    id: string
    Optionalmeta: HttpMetaParams<"none">
    Returns Promise<void>
    N/A
    
    See
    https://docs.joinmastodon.org/methods/accounts/suggestions/
    
    Defined in src/mastodon/rest/v1/suggestion-repository.ts:28
- Defined in src/mastodon/rest/v1/suggestion-repository.ts:22

list

list(
params?: ListSuggestionParams,
meta?: HttpMetaParams<"none">,
): Paginator<mastodon.v1.Account[], ListSuggestionParams>
Accounts the user has had past positive interactions with, but is not yet following.
Parameters
- Optionalparams: ListSuggestionParams
  Parameters
- Optionalmeta: HttpMetaParams<"none">
Returns Paginator<mastodon.v1.Account[], ListSuggestionParams>
Array of Accounts

See
https://docs.joinmastodon.org/methods/suggestions/#v1
- Defined in src/mastodon/rest/v1/suggestion-repository.ts:17

Interface SuggestionRepository

Index

Methods

Methods

$select

Parameters

Returns { remove(id: string, meta?: HttpMetaParams<"none">): Promise<void> }

remove:function

Parameters

Returns Promise<void>

See

list

Parameters

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

See

Settings

On This Page