Methods
accountBlockById(id) → {Promise.<object>}
- Description:
- Block an account
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to block |
Returns:
The response object
- Type
- Promise.<object>
accountBlocks() → {Promise.<object>}
- Description:
- Get your blocks
- Source:
Returns:
The response object
- Type
- Promise.<object>
accountById(id) → {Promise.<object>}
- Description:
- Get an account
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to get |
Returns:
The response object
- Type
- Promise.<object>
accountFollowersById(id) → {Promise.<object>}
- Description:
- Get account followers
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to get the followers of |
Returns:
The response object
- Type
- Promise.<object>
accountFollowingById(id) → {Promise.<object>}
- Description:
- Get account following
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to get the following of |
Returns:
The response object
- Type
- Promise.<object>
accountFollowRequests() → {Promise.<object>}
- Description:
- Get your follow requests
- Source:
Returns:
The response object
- Type
- Promise.<object>
accountLikes() → {Promise.<object>}
- Description:
- Get your favourites
- Source:
Returns:
The response object
- Type
- Promise.<object>
accountMuteById(id) → {Promise.<object>}
- Description:
- Mute an account
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to mute |
Returns:
The response object
- Type
- Promise.<object>
accountMutes() → {Promise.<object>}
- Description:
- Get your mutes
- Source:
Returns:
The response object
- Type
- Promise.<object>
accountNotifications() → {Promise.<object>}
- Description:
- Get your notifications
- Source:
Returns:
The response object
- Type
- Promise.<object>
accountSearch(query) → {Promise.<object>}
- Description:
- Search query
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
query |
string | The query you want to search |
Returns:
The response object
- Type
- Promise.<object>
accountStatusesById(id) → {Promise.<object>}
- Description:
- Get account posts
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to get the posts of |
Returns:
The response object
- Type
- Promise.<object>
accountUnblockById(id) → {Promise.<object>}
- Description:
- Unblock an account
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to unblock |
Returns:
The response object
- Type
- Promise.<object>
accountUnmuteById(id) → {Promise.<object>}
- Description:
- Unmute an account
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to unmute |
Returns:
The response object
- Type
- Promise.<object>
followAccountById(id) → {Promise.<object>}
- Description:
- Follow an account
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to follow |
Returns:
The response object
- Type
- Promise.<object>
homeTimeline() → {Promise.<object>}
- Description:
- Get your timeline
- Source:
Returns:
The response object
- Type
- Promise.<object>
instance() → {Promise.<object>}
- Description:
- Get the info about the instance
- Source:
Returns:
The response object
- Type
- Promise.<object>
mediaUpload(file) → {Promise.<object>}
- Description:
- Upload a status
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
file |
string | The location of the file you want to upload |
Returns:
The response object
- Type
- Promise.<object>
nodeinfo() → {Promise.<object>}
- Description:
- Get node info
- Source:
Returns:
The response object
- Type
- Promise.<object>
publicTimeline() → {Promise.<object>}
- Description:
- Get the public timeline
- Source:
Returns:
The response object
- Type
- Promise.<object>
statusById(id) → {Promise.<object>}
- Description:
- Get a status
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the status you want to get |
Returns:
The response object
- Type
- Promise.<object>
statusCreate(mediaIds, captionopt, sensitiveopt, scopeopt, inReplyToIdopt) → {Promise.<object>}
- Source:
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
mediaIds |
Array.<number> | An array of media ids | ||
caption |
string |
<optional> |
null
|
The caption |
sensitive |
bool |
<optional> |
false
|
Whether or not it's sensitive |
scope |
string |
<optional> |
public
|
Must be private, unlisted or public |
inReplyToId |
number |
<optional> |
null
|
The ID it replies to |
Returns:
The response object
- Type
- Promise.<object>
statusFavouriteById(id) → {Promise.<object>}
- Description:
- Favourite a status
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the status you want to favourite |
Returns:
The response object
- Type
- Promise.<object>
statusLikedById(id) → {Promise.<object>}
- Description:
- Get who favoureted a status
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the status you want to get the favourites of |
Returns:
The response object
- Type
- Promise.<object>
statusRebloggedById(id) → {Promise.<object>}
- Description:
- Get who reblogged a status
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the status you want to get the rebloggers of |
Returns:
The response object
- Type
- Promise.<object>
statusUnfavouriteById(id) → {Promise.<object>}
- Description:
- Unfavourite a status
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the status you want to unfavourite |
Returns:
The response object
- Type
- Promise.<object>
unfollowAccountById(id) → {Promise.<object>}
- Description:
- Unfollow an account
- Source:
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the account you want to unfollow |
Returns:
The response object
- Type
- Promise.<object>
user() → {Promise.<object>}
- Description:
- Confirm that the app's OAuth2 credentials work
- Source:
Returns:
The response object
- Type
- Promise.<object>