mirror of
https://github.com/versia-pub/docs.git
synced 2025-12-06 06:18:19 +01:00
57 lines
1.9 KiB
Plaintext
57 lines
1.9 KiB
Plaintext
export const metadata = {
|
|
title: 'Unfollow',
|
|
description: 'The Unfollow entity allows users to unsubscribe from each other',
|
|
}
|
|
|
|
# Unfollow
|
|
|
|
Sometimes, [Users](/entities/user) want to unsubscribe from each other to stop seeing each other's content. The `Unfollow` defines such a change. {{ className: 'lead' }}
|
|
|
|
<Note>
|
|
Refer to the [Follow](/entities/follow) entity for information on how follow relationships work.
|
|
</Note>
|
|
|
|
<Note>
|
|
This is **not** used to remove a follower from a followee.
|
|
|
|
For example, if Bob follows Alice, this entity is used when:
|
|
- Bob wants to stop following Alice.
|
|
|
|
**NOT** when:
|
|
|
|
- Alice wants to remove Bob as a follower.
|
|
|
|
For the latter, use [FollowReject](/entities/follow-reject).
|
|
</Note>
|
|
|
|
## Entity Definition
|
|
|
|
<Row>
|
|
<Col>
|
|
<Properties name="Unfollow">
|
|
<Property name="uri" type="null" required={false}>
|
|
This is a [**Transient Entity**](/entities#transient-entities) and does not have a URI.
|
|
</Property>
|
|
<Property name="author" type="URI" required={true} typeLink="/types#uri">
|
|
URI of the `User` considered the 'follower', i.e. the user who is unsubscribing from the followee.
|
|
</Property>
|
|
<Property name="followee" type="URI" required={true} typeLink="/types#uri">
|
|
URI of the `User` considered the 'followee', i.e. the user who is being unsubscribed from.
|
|
</Property>
|
|
</Properties>
|
|
</Col>
|
|
|
|
<Col sticky>
|
|
|
|
```jsonc {{ title: 'Example Unfollow' }}
|
|
{
|
|
"type": "Unfollow",
|
|
"id": "3e7e4750-afd4-4d99-a256-02f0710a0520",
|
|
"author": "https://example.com/users/6e0204a2-746c-4972-8602-c4f37fc63bbe",
|
|
"created_at": "2021-01-01T00:00:00.000Z",
|
|
"followee": "https://example.com/users/02e1e3b2-cb1f-4e4a-b82e-98866bee5de7"
|
|
}
|
|
```
|
|
|
|
</Col>
|
|
</Row> |