Interface APCollectionPage

interface APCollectionPage {
    @context?: ContextField | ContextField[];
    attachment?: AttachmentField | AttachmentField[];
    attributedTo?: AttributedToField | AttributedToField[];
    audience?: AudienceField | AudienceField[];
    bcc?: BccField | BccField[];
    bto?: BtoField | BtoField[];
    cc?: CcField | CcField[];
    content?: string;
    contentMap?: ContentMapField;
    current?: CollectionCurrentField;
    duration?: string;
    endTime?: DateTime;
    first?: CollectionFirstField;
    generator?: GeneratorField;
    icon?: IconField | IconField[];
    id?: string;
    image?: ImageField | ImageField[];
    inReplyTo?: InReplyToField | InReplyToField[];
    items?: CollectionItemsField[];
    last?: CollectionLastField;
    likes?: LikesField;
    location?: LocationField | LocationField[];
    mediaType?: string;
    name?: string;
    nameMap?: NameMapField;
    next?: CollectionPageNextField;
    partOf?: CollectionPagePartOfField;
    prev?: CollectionPagePrevField;
    preview?: PreviewField;
    published?: DateTime;
    replies?: RepliesField;
    shares?: SharesField;
    source?: SourceField;
    startTime?: DateTime;
    summary?: string;
    summaryMap?: SummaryMapField;
    tag?: TagField | TagField[];
    to?: ToField | ToField[];
    totalItems?: number;
    type?: string | string[];
    updated?: DateTime;
    url?: UrlField | UrlField[];
}

Hierarchy (view full)

Properties

@context?: ContextField | ContextField[]

JSON-LD uses the special

Context

property to define the processing context. The Field of the

Context

property is defined by the [JSON-LD] specification.

Docs

Identifies resources attached or related to an object that potentially requires special handling. The intent is to provide a model that is at least semantically similar to attachments in email.

Docs

Identifies one or more entities to which this object is attributed. The attributed entities might not be Actors. For instance, an object might be attributed to the completion of another activity.

Docs

Identifies one or more entities that represent the total population of entities for which the object can be considered to be relevant.

Docs

bcc?: BccField | BccField[]

Identifies one or more Objects that are part of the private secondary audience of this Object.

Docs

bto?: BtoField | BtoField[]

Identifies an Object that is part of the private primary audience of this Object.

Docs

cc?: CcField | CcField[]

Identifies an Object that is part of the public secondary audience of this Object.

Docs

content?: string

The content or textual representation of the Object encoded as a JSON string. By default, the value of content is HTML. The mediaType property can be used in the object to indicate a different content type. [For multiple language-tagged values use contentMap property]

Docs

contentMap?: ContentMapField

The content or textual representation of the Object encoded as a JSON string. By default, the value of content is HTML. The mediaType property can be used in the object to indicate a different content type. [For a single value use content property]

Docs

In a paged Collection, indicates the page that contains the most recently updated member items.

Docs

duration?: string

When the object describes a time-bound resource, such as an audio or video, a meeting, etc., the duration property indicates the object's approximate duration.

Docs

Must be provided in xsd:duration

Example

PT20M (20 minutes)
P1DT2H (1 day, 2 hours)
P2Y6M5DT12H35M30S (2 years, 6 months, 5 days, 12 hours, 35 minutes, 30 seconds)
endTime?: DateTime

The date and time describing the actual or expected ending time of the object. When used with an Activity object, for instance, the endTime property specifies the moment the activity concluded or is expected to conclude.

Must be provided in xsd:dateTime

Docs

Example

2020-08-08T08:30:11-03:00Z
2020-08-08T08:30:11-03:00
2020-08-08T08:30:11Z
2020-08-08T08:30:11
2020-08-08

In a paged Collection,indicates the furthest proceeding page of items in the collection.

Docs

generator?: GeneratorField

Identifies the entity (e.g. an application) that generated the object.

Docs

icon?: IconField | IconField[]

Indicates an entity (or entities) that describes an icon for this object. Unlike image property, the icon should have an aspect ratio of one (horizontal) to one (vertical) and should be suitable for presentation at a small size.

Docs

id?: string

Provides the globally unique identifier for an Object All objects must have unique global identifier (unless the object is transient, in which case the id MAY be omitted).

AS Docs (@id)

AP Docs

Indicates an entity that describes an image for this object. Unlike the icon property, there are no aspect ratio or display size limitations assumed.

Docs

Indicates one or more entities for which this object is considered a response.

Docs

Identifies the items contained in a collection. The items might be ordered or unordered.

Docs

In a paged Collection, indicates the furthest proceeding page of the collection.

Docs

likes?: LikesField

Every object MAY have a "likes" collection. 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.

Docs

Indicates one or more physical or logical locations associated with the object.

Docs

mediaType?: string

When used on an Object, identifies the MIME media type of the value of the content property. If not specified, the content property is assumed to contain text/html content. Works different with Link

Docs

name?: string

A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. [For multiple language-tagged values use nameMap property]

Docs

nameMap?: NameMapField

A simple, human-readable, plain-text name for the object. HTML markup MUST NOT be included. [For a single value use name property]

Docs

In a paged Collection, indicates the next page of items.

Docs

Identifies the Collection to which a CollectionPage objects items belong.

Docs

In a paged Collection, identifies the previous page of items.

Docs

preview?: PreviewField

Identifies an entity that provides a preview of this object.

Docs

published?: DateTime

The date and time at which the object was published.

Must be provided in xsd:dateTime

Docs

Example

2020-08-08T08:30:11-03:00Z
2020-08-08T08:30:11-03:00
2020-08-08T08:30:11Z
2020-08-08T08:30:11
2020-08-08
replies?: RepliesField

Identifies a Collection containing objects considered to be responses to this object.

Docs

shares?: SharesField

Every object MAY have a "shares" collection. 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.

Docs

source?: SourceField

ActivityPub extends the Object by supplying the source property. 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.

Docs

startTime?: DateTime

The date and time describing the actual or expected starting time of the object. When used with an Activity object, for instance, the startTime property specifies the moment the activity began or is scheduled to begin.

Must be provided in xsd:dateTime

Docs

Example

2020-08-08T08:30:11-03:00Z
2020-08-08T08:30:11-03:00
2020-08-08T08:30:11Z
2020-08-08T08:30:11
2020-08-08
summary?: string

A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided. [For multiple language-tagged values use summaryMap property]

Docs

summaryMap?: SummaryMapField

A natural language summarization of the object encoded as HTML. Multiple language tagged summaries MAY be provided. [For a single value use summary property]

Docs

tag?: TagField | TagField[]

One or more "tags" that have been associated with an objects. A tag can be any kind of Object. The key difference between attachment and tag is that the former implies association by inclusion, while the latter implies associated by reference.

Docs

to?: ToField | ToField[]

Identifies an entity or entities considered to be part of the public primary audience of an Object.

Docs

totalItems?: number

A non-negative integer specifying the total number of objects contained by the logical view of the collection. This number might not reflect the actual number of items serialized within the Collection object instance.

Docs

type?: string | string[]

Identifies the Object type. Multiple values may be specified. All objects must have type. There is already a bunch of default types presented by this library.

AS Docs (@type)

AP Docs

updated?: DateTime

The date and time at which the object was updated.

Must be provided in xsd:dateTime

Docs

Example

2020-08-08T08:30:11-03:00Z
2020-08-08T08:30:11-03:00
2020-08-08T08:30:11Z
2020-08-08T08:30:11
2020-08-08
url?: UrlField | UrlField[]

Identifies one or more links to representations of the object.

Docs

Generated using TypeDoc