Library

By Fediverse Developer Network

https://fedidevs.org/projects/server-apps/funkwhale/objects/library/

A Library is a custom object used to store music collection information. It inherits its behavior and properties from ActivityPub’s Actor and Collection objects.

Properties

PropertyData typeDescription
type*StringThe object type (Library)
id*String (URI)A URI that identifies the library over federation
name*StringThe library’s name
followers*String (URI)The ID of the library’s followers collection
totalItems*IntegerThe number of Audio objects in the library
first*String (URI)The URL of the library’s first page
last*String (URI)The URL of the library’s last page
summary?StringThe library’s description

Example

{
  "type": "Library",
  "id": "https://awesome.music/federation/music/libraries/dc702491-f6ce-441b-9da0-cecbed08bcc6",
  "attributedTo": "https://awesome.music/federation/actors/Alice",
  "name": "My awesome library",
  "followers": "https://awesome.music/federation/music/libraries/dc702491-f6ce-441b-9da0-cecbed08bcc6/followers",
  "summary": "This library is for restricted use only",
  "totalItems": 4234,
  "first": "https://awesome.music/federation/music/libraries/dc702491-f6ce-441b-9da0-cecbed08bcc6?page=1",
  "last": "https://awesome.music/federation/music/libraries/dc702491-f6ce-441b-9da0-cecbed08bcc6?page=56"
}