Class AccountRepository

Hierarchy

AccountRepository

Implements

Repository<mastodon.v1.Account, CreateAccountParams>

Index

Constructors

constructor

new AccountRepository(http: Http, config: MastoConfig, logger?: Logger): mastodon.v1.AccountRepository
Parameters
- http: Http
- config: MastoConfig
- Optional logger: Logger
Returns mastodon.v1.AccountRepository
- Defined in src/mastodon/v1/repositories/account-repository.ts:105

Properties

`Readonly` config

config: MastoConfig

`Optional` `Readonly` logger

logger?: Logger

Methods

block

block(id: string): Promise<Relationship>
Block the given account. Clients should filter statuses from this account if received (e.g. due to a boost in the Home timeline)

Returns
Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:260

create

create(params: CreateAccountParams): Promise<mastodon.v1.Account>
Creates a user and account records. Returns an account access token for the app that initiated the request. The app should save this token for later, and should wait for the user to confirm their account by clicking a link in their email inbox.

Returns
Token

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- params: CreateAccountParams
  
  Parameters
Returns Promise<mastodon.v1.Account>
Implementation of Repository.create
- Defined in src/mastodon/v1/repositories/account-repository.ts:130

createNote

createNote(id: string, params: CreateAccountNoteParams): Promise<Relationship>
Add personal note to the account

Returns
Relationship
Parameters
- id: string
  
  ID of the account
- params: CreateAccountNoteParams
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:338

fetch

fetch(id: string): Promise<mastodon.v1.Account>
View information about a profile.

Returns
Account

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
Returns Promise<mastodon.v1.Account>
Implementation of Repository.fetch
- Defined in src/mastodon/v1/repositories/account-repository.ts:117

fetchFamiliarFollowers

fetchFamiliarFollowers(id: string[]): Promise<FamiliarFollowers[]>
Obtain a list of all accounts that follow a given account, filtered for accounts you follow.

Returns
Array of FamiliarFollowers
Parameters
- id: string[]
Returns Promise<FamiliarFollowers[]>
- Defined in src/mastodon/v1/repositories/account-repository.ts:381

fetchRelationships

fetchRelationships(id: string[]): Promise<Relationship[]>
Find out whether a given account is followed, blocked, muted, etc.

Returns
Array of Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string[]
  
  Array of account IDs to check
Returns Promise<Relationship[]>
- Defined in src/mastodon/v1/repositories/account-repository.ts:234

follow

follow(id: string, params?: FollowAccountParams): Promise<Relationship>
Follow the given account.

Returns
Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
- Optional params: FollowAccountParams
  
  Parameters
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:212

listFeaturedTags

listFeaturedTags(id: string): Paginator<FeaturedTag[], never>
Get featured tag of the account

Returns
FeaturedTags
Parameters
- id: string
  
  ID of the account
Returns Paginator<FeaturedTag[], never>
- Defined in src/mastodon/v1/repositories/account-repository.ts:351

listFollowers

listFollowers(id: string, params?: DefaultPaginationParams): Paginator<mastodon.v1.Account[], DefaultPaginationParams>
Accounts which follow the given account, if network is not hidden by the account owner.

Returns
Array of Account

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
- params: DefaultPaginationParams = {}
  
  Parameters
Returns Paginator<mastodon.v1.Account[], DefaultPaginationParams>
- Defined in src/mastodon/v1/repositories/account-repository.ts:167

listFollowing

listFollowing(id: string, params?: DefaultPaginationParams): Paginator<mastodon.v1.Account[], DefaultPaginationParams>
Accounts which the given account is following, if network is not hidden by the account owner.

Returns
Array of Account

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
- params: DefaultPaginationParams = {}
  
  Parameters
Returns Paginator<mastodon.v1.Account[], DefaultPaginationParams>
- Defined in src/mastodon/v1/repositories/account-repository.ts:182

listIdentityProofs

listIdentityProofs(id: string): Paginator<IdentityProof[], never>
Identity proofs

Returns
Array of IdentityProof

See
https://github.com/tootsuite/mastodon/pull/10297
Parameters
- id: string
  
  The id of the account in the database
Returns Paginator<IdentityProof[], never>
- Defined in src/mastodon/v1/repositories/account-repository.ts:362

listLists

listLists(id: string): Paginator<List[], never>
Fetch the list with the given ID. Used for verifying the title of a list.

Returns
Array of List

See
https://docs.joinmastodon.org/methods/timelines/lists/
Parameters
- id: string
  
  ID of the list in the database
Returns Paginator<List[], never>
- Defined in src/mastodon/v1/repositories/account-repository.ts:304

listStatuses

listStatuses(id: string, params?: ListAccountStatusesParams): Paginator<Status[], ListAccountStatusesParams>
Statuses posted to the given account.

Returns
Array of Status

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
- params: ListAccountStatusesParams = {}
  
  Parameters
Returns Paginator<Status[], ListAccountStatusesParams>
- Defined in src/mastodon/v1/repositories/account-repository.ts:197

lookup

lookup(params: LookupAccountParams): Promise<mastodon.v1.Account>
This method allows to quickly convert a username of a known account to an ID that can be used with the REST API, or to check if a username is available for sign-up

Returns
Account
Parameters
- params: LookupAccountParams
  
  Parameters
Returns Promise<mastodon.v1.Account>
- Defined in src/mastodon/v1/repositories/account-repository.ts:372

mute

mute(id: string, params?: MuteAccountParams): Promise<Relationship>
Mute the given account. Clients should filter statuses and notifications from this account, if received (e.g. due to a boost in the Home timeline).

Returns
Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
- Optional params: MuteAccountParams
  
  Parameter
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:316

pin(id: string): Promise<Relationship>
Add the given account to the user's featured profiles. (Featured profiles are currently shown on the user's own public profile.)

Returns
Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:282

removeFromFollowers

removeFromFollowers(id: string): Promise<void>
Returns
N/A
Parameters
- id: string
  
  ID of the account
Returns Promise<void>
- Defined in src/mastodon/v1/repositories/account-repository.ts:390

search

search(params?: SearchAccountsParams): Paginator<mastodon.v1.Account[], SearchAccountsParams>
Search for matching accounts by username or display name.

Returns
Array of Account

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- Optional params: SearchAccountsParams
  
  Parameters
Returns Paginator<mastodon.v1.Account[], SearchAccountsParams>
- Defined in src/mastodon/v1/repositories/account-repository.ts:247

unblock

unblock(id: string): Promise<Relationship>
Unblock the given account.

Returns
Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:271

unfollow

unfollow(id: string, params?: FollowAccountParams): Promise<Relationship>
Unfollow the given account

Returns
Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
- Optional params: FollowAccountParams
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:223

unmute

unmute(id: string): Promise<Relationship>
Unmute the given account.

Returns
Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:327

unpin

unpin(id: string): Promise<Relationship>
Remove the given account from the user's featured profiles.

Returns
Relationship

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- id: string
  
  The id of the account in the database
Returns Promise<Relationship>
- Defined in src/mastodon/v1/repositories/account-repository.ts:293

updateCredentials

updateCredentials(params?: UpdateCredentialsParams): Promise<AccountCredentials>
Update the user's display and preferences.

Returns
the user's own Account with Source

See
https://docs.joinmastodon.org/methods/accounts/
Parameters
- Optional params: UpdateCredentialsParams
  
  Parameters
Returns Promise<AccountCredentials>
- Defined in src/mastodon/v1/repositories/account-repository.ts:151

verifyCredentials

verifyCredentials(): Promise<AccountCredentials>
Test to make sure that the user token works.

Returns
the user's own Account with Source

See
https://docs.joinmastodon.org/methods/accounts/

Returns Promise<AccountCredentials>
- Defined in src/mastodon/v1/repositories/account-repository.ts:140

Class AccountRepository

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

http: Http

config: MastoConfig

Optional logger: Logger

Returns mastodon.v1.AccountRepository

Properties

Readonly config

Optional Readonly logger

Methods

block

Returns

See

Parameters

id: string

Returns Promise<Relationship>

create

Returns

See

Parameters

params: CreateAccountParams

Returns Promise<mastodon.v1.Account>

createNote

Returns

Parameters

id: string

params: CreateAccountNoteParams

Returns Promise<Relationship>

fetch

Returns

See

Parameters

id: string

Returns Promise<mastodon.v1.Account>

fetchFamiliarFollowers

Returns

Parameters

id: string[]

Returns Promise<FamiliarFollowers[]>

fetchRelationships

Returns

See

Parameters

id: string[]

Returns Promise<Relationship[]>

follow

Returns

See

Parameters

id: string

Optional params: FollowAccountParams

Returns Promise<Relationship>

listFeaturedTags

Returns

Parameters

id: string

Returns Paginator<FeaturedTag[], never>

listFollowers

Returns

See

Parameters

id: string

params: DefaultPaginationParams = {}

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

listFollowing

Returns

See

Parameters

id: string

params: DefaultPaginationParams = {}

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

listIdentityProofs

`Optional` logger: Logger

`Readonly` config

`Optional` `Readonly` logger

`Optional` params: FollowAccountParams

`Optional` params: MuteAccountParams

`Optional` params: SearchAccountsParams

`Optional` params: FollowAccountParams