mirror of
https://github.com/versia-pub/docs.git
synced 2025-12-06 14:28:20 +01:00
52 lines
1.7 KiB
Plaintext
52 lines
1.7 KiB
Plaintext
|
export const metadata = {
|
||
|
|
title: 'FollowReject',
|
||
|
|
description: 'FollowReject lets users reject follow requests',
|
||
|
|
}
|
||
|
|
|
||
|
|
# FollowReject
|
||
|
|
|
||
|
|
<Note>
|
||
|
|
Refer to the [Follow](/entities/follow) entity for information on how follow relationships work.
|
||
|
|
</Note>
|
||
|
|
|
||
|
|
## Removing followers
|
||
|
|
|
||
|
|
`FollowReject` can also be used *after* a follow relationship has been established to remove a follower.
|
||
|
|
|
||
|
|
For example, if Bob requests to follow Alice, this entity is used when:
|
||
|
|
- Alice wants to reject Bob's follow request.
|
||
|
|
|
||
|
|
But it can also be used when Bob is already following Alice, in the case that:
|
||
|
|
- Alice wants to remove Bob as a follower.
|
||
|
|
|
||
|
|
## Entity Definition
|
||
|
|
|
||
|
|
<Row>
|
||
|
|
<Col>
|
||
|
|
<Properties>
|
||
|
|
<Property name="uri" type="null" required={false}>
|
||
|
|
This entity does not have a URI.
|
||
|
|
</Property>
|
||
|
|
<Property name="author" type="URI" required={true} typeLink="/types#uri">
|
||
|
|
URI of the `User` considered the 'followee', i.e. the user who is being followed.
|
||
|
|
</Property>
|
||
|
|
<Property name="follower" type="URI" required={true} typeLink="/types#uri">
|
||
|
|
URI of the `User` considered the 'follower', i.e. the user who is trying to follow the author.
|
||
|
|
</Property>
|
||
|
|
</Properties>
|
||
|
|
</Col>
|
||
|
|
|
||
|
|
<Col sticky>
|
||
|
|
|
||
|
|
```jsonc {{ title: 'Example FollowReject' }}
|
||
|
|
{
|
||
|
|
"type": "FollowReject",
|
||
|
|
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
|
||
|
|
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
|
||
|
|
"created_at": "2021-01-01T00:00:00.000Z",
|
||
|
|
"follower": "https://example.com/users/02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
</Col>
|
||
|
|
</Row>
|