2022-11-06 16:29:58 +00:00
|
|
|
import {APObjectFields} from "../apObject/APObject.types";
|
2022-10-30 20:32:42 +00:00
|
|
|
import {SubjectValue, ObjectValue, RelationshipValue} from "../../common/common.types";
|
|
|
|
|
2022-11-06 16:29:58 +00:00
|
|
|
export interface RelationshipFields extends APObjectFields {
|
2022-10-30 20:32:42 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* On a Relationship object, the subject property identifies one of the connected individuals.
|
|
|
|
* For instance, for a Relationship object describing "John is related to Sally",
|
|
|
|
* subject would refer to John.
|
|
|
|
*
|
|
|
|
* {@link https://www.w3.org/ns/activitystreams#subject Docs}
|
|
|
|
*/
|
|
|
|
subject?: SubjectValue;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* When used within a Relationship describes the entity to which the subject is related.
|
|
|
|
*
|
|
|
|
* {@link https://www.w3.org/ns/activitystreams#object Docs}
|
|
|
|
*/
|
|
|
|
object?: ObjectValue | ObjectValue[];
|
|
|
|
|
|
|
|
/**
|
|
|
|
* On a Relationship object, the relationship property
|
|
|
|
* identifies the kind of relationship that exists between subject and object.
|
|
|
|
*
|
|
|
|
* {@link https://www.w3.org/ns/activitystreams#relationship Docs}
|
|
|
|
*/
|
|
|
|
relationship?: RelationshipValue;
|
|
|
|
}
|