mirror of
https://github.com/LemmyNet/lemmy.git
synced 2025-04-27 05:04:44 +00:00
111 lines
4.1 KiB
Rust
111 lines
4.1 KiB
Rust
/*
|
|
* This file is part of ActivityPub.
|
|
*
|
|
* Copyright © 2018 Riley Trautman
|
|
*
|
|
* ActivityPub is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* ActivityPub is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with ActivityPub. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
//! Namespace for properties of standard Object types
|
|
//!
|
|
//! To use these properties in your own types, you can flatten them into your struct with serde:
|
|
//!
|
|
//! ```rust
|
|
//! use activitypub::{Object, object::properties::ApObjectProperties};
|
|
//! use serde_derive::{Deserialize, Serialize};
|
|
//!
|
|
//! #[derive(Clone, Debug, Serialize, Deserialize)]
|
|
//! #[serde(rename_all = "camelCase")]
|
|
//! pub struct MyObject {
|
|
//! #[serde(rename = "type")]
|
|
//! pub kind: String,
|
|
//!
|
|
//! /// Define a require property for the MyObject type
|
|
//! pub my_property: String,
|
|
//!
|
|
//! #[serde(flatten)]
|
|
//! pub object_props: ApObjectProperties,
|
|
//! }
|
|
//!
|
|
//! impl Object for MyObject {}
|
|
//! #
|
|
//! # fn main() {}
|
|
//! ```
|
|
|
|
use super::Object;
|
|
|
|
use activitystreams_derive::Properties;
|
|
pub use activitystreams_types::object::properties::{
|
|
ObjectProperties, PlaceProperties, ProfileProperties, RelationshipProperties, TombstoneProperties,
|
|
};
|
|
use serde_derive::{Deserialize, Serialize};
|
|
|
|
/// Define activitypub properties for the Object type as described by the Activity Pub vocabulary.
|
|
#[derive(Clone, Debug, Default, Deserialize, Properties, Serialize)]
|
|
#[serde(rename_all = "camelCase")]
|
|
pub struct ApObjectProperties {
|
|
// TODO: IRI
|
|
/// This is a list of all Announce activities with this object as the object property, added as
|
|
/// a side effect.
|
|
///
|
|
/// The shares collection MUST be either an OrderedCollection or a Collection and MAY be
|
|
/// filtered on privileges of an authenticated user or as appropriate when no authentication is
|
|
/// given.
|
|
///
|
|
/// - Range: `anyUri`
|
|
/// - Functional: true
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
#[activitystreams(concrete(String), functional)]
|
|
pub shares: Option<serde_json::Value>,
|
|
|
|
/// This is a list of all Like activities with this object as the object property, added as a
|
|
/// side effect.
|
|
///
|
|
/// The likes collection MUST be either an OrderedCollection or a Collection and MAY be
|
|
/// filtered on privileges of an authenticated user or as appropriate when no authentication is
|
|
/// given.
|
|
///
|
|
/// - Range: `anyUri`
|
|
/// - Functional: true
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
#[activitystreams(concrete(String), functional)]
|
|
pub likes: Option<serde_json::Value>,
|
|
|
|
/// The source property is intended to convey some sort of source from which the content markup
|
|
/// was derived, as a form of provenance, or to support future editing by clients.
|
|
///
|
|
/// In general, clients do the conversion from source to content, not the other way around.
|
|
///
|
|
/// The value of source is itself an object which uses its own content and mediaType fields to
|
|
/// supply source information.
|
|
///
|
|
/// - Range: `Object`
|
|
/// - Functional: true
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
#[activitystreams(ab(Object), concrete(String), functional)]
|
|
pub source: Option<serde_json::Value>,
|
|
|
|
/// Servers MAY support uploading document types to be referenced in activites, such as images,
|
|
/// video or other binary data, but the precise mechanism is out of scope for this version of
|
|
/// `ActivityPub`.
|
|
///
|
|
/// The Social Web Community Group is refining the protocol in the
|
|
/// [`ActivityPub` Media Upload report](https://www.w3.org/wiki/SocialCG/ActivityPub/MediaUpload).
|
|
///
|
|
/// - Range: `anyUri`
|
|
/// - Functional: false
|
|
#[serde(skip_serializing_if = "Option::is_none")]
|
|
#[activitystreams(concrete(String))]
|
|
pub upload_media: Option<serde_json::Value>,
|
|
}
|