docs-mastodon/content/en/entities/RelationshipSeveranceEvent.md
Nik Clayton 49868155b9
feat: Document datetime and date formats (#1565)
Add a new document that precisely describes the string representation of
datetime and date types.

The previous description of them as "ISO 8601 Datetime" was very
imprecise, as ISO 8601 describes many different ways of representing a
datetime and date.

Specify the datetime format precisely as the ISO 8601 profile described
in RFC 3339, and the date format precisely as the "Complete date" format
from the W3C note on date and time formats.

Adjust all the references to ISO 8601 datetimes or dates to link back
to the definition.

Fixes #1420
2024-11-27 15:08:51 +00:00

1.5 KiB

title description menu aliases
RelationshipSeveranceEvent Summary of a moderation or block event that caused follow relationships to be severed.
docs
parent
entities
/entities/RelationshipSeveranceEvent
/api/entities/RelationshipSeveranceEvent

Attributes

id

Description: The ID of the relationship severance event in the database.
Type: String (cast from integer)
Version history:
4.3.0 - added

type

Description: Type of event.
Type: String (Enumerable oneOf)
domain_block = A moderator suspended a whole domain
user_domain_block = The user blocked a whole domain
account_suspension = A moderator suspended a specific account
Version history:
4.3.0 - added

purged

Description: Whether the list of severed relationships is unavailable because the underlying issue has been purged.
Type: Boolean
Version history:
4.3.0 - added

target_name

Description: Name of the target of the moderation/block event. This is either a domain name or a user handle, depending on the event type.
Type: String
Version history:
4.3.0 - added

relationships_count {{%optional%}}

Description: Number of follow relationships (in either direction) that were severed.
Type: Integer
Version history:
4.3.0 - added

created_at

Description: When the event took place.
Type: String (Datetime)
Version history:
4.3.0 - added