Class ASOrderedCollectionPage
- Namespace
- ActivityPub.Types.AS.Collection
- Assembly
- ActivityPub.Types.dll
Used to represent distinct subsets of items from an Ordered Collection.
public class ASOrderedCollectionPage : ASOrderedCollection, IASModel<ASType, ASTypeEntity>, IASModel<ASType>, IASModel<ASObject, ASObjectEntity, ASType>, IASModel<ASObject, ASObjectEntity>, IASModel<ASObject>, IASModel<ASOrderedCollection, ASOrderedCollectionEntity, ASObject>, IASModel<ASOrderedCollection, ASOrderedCollectionEntity>, IASModel<ASOrderedCollection>, IEnumerable<Linkable<ASObject>>, IEnumerable, IASModel<ASOrderedCollectionPage, ASOrderedCollectionPageEntity, ASOrderedCollection>, IASModel<ASOrderedCollectionPage, ASOrderedCollectionPageEntity>, IASModel<ASOrderedCollectionPage>- Inheritance
-
ASOrderedCollectionPage
- Implements
- Inherited Members
Remarks
Refer to the Activity Streams 2.0 Core specification for a complete description of the CollectionPage type.
Constructors
ASOrderedCollectionPage()
Constructs a new instance and attaches it to a new, empty type graph.
public ASOrderedCollectionPage()ASOrderedCollectionPage(ASType)
Constructs a new instance and extends an existing type graph from a provided model.
public ASOrderedCollectionPage(ASType existingGraph)Parameters
existingGraphASType
- See Also
-
Extend<TModel, TEntity>()
ASOrderedCollectionPage(TypeMap, ASOrderedCollectionPageEntity?)
public ASOrderedCollectionPage(TypeMap typeMap, ASOrderedCollectionPageEntity? entity)Parameters
typeMapTypeMapentityASOrderedCollectionPageEntity
ASOrderedCollectionPage(TypeMap, bool)
Constructs a new instance from an existing type graph. The existing graph is either extended or wrapped, depending on the value of
isExtendingpublic ASOrderedCollectionPage(TypeMap typeMap, bool isExtending = true)Parameters
Remarks
All overrides MUST call this using
base(typeMap, false)Exceptions
- InvalidOperationException
If
is true and the entity type already exists in the graphextendGraph- InvalidOperationException
If
is true and the entity requires another entity that is missing from the graphextendGraph- InvalidCastException
If
is false and the object is not of typeextendGraphTEntity
- See Also
Fields
OrderedCollectionPageType
ActivityStreams type name for "OrderedCollectionPage" types.
[PublicAPI]
public const string OrderedCollectionPageType = "OrderedCollectionPage"Field Value
Properties
Entity
private ASOrderedCollectionPageEntity Entity { get; }Property Value
Next
In a paged Collection, indicates the next page of items.
public Linkable<ASOrderedCollectionPage>? Next { get; set; }Property Value
- See Also
PartOf
Identifies the Collection to which a CollectionPage objects items belong.
public Linkable<ASOrderedCollection>? PartOf { get; set; }Property Value
- See Also
Prev
In a paged Collection, indicates the previous page of items.
public Linkable<ASOrderedCollectionPage>? Prev { get; set; }Property Value
- See Also
StartIndex
A non-negative integer value identifying the relative position within the logical view of a strictly ordered collection. This is only valid on OrderedCollectionPage, but it exists on unordered CollectionPage due to technical limitations.
public int? StartIndex { get; set; }Property Value
- int?
- See Also
Operators
implicit operator ASOrderedCollectionPage(List<ASObject>)
Converts a list of objects into an ordered collection page.
public static implicit operator ASOrderedCollectionPage(List<ASObject> collection)Parameters
Returns
Explicit Interface Implementations
IASModel<ASOrderedCollectionPage>.ASTypeName
AS type name of this entity. For the full list of names in the object graph, use ASTypes.
static string IASModel<ASOrderedCollectionPage>.ASTypeName { get; }Returns
IASModel<ASOrderedCollectionPage>.FromGraph(TypeMap)
Constructs an instance from this type from a pre-populated type graph. The provided TypeMap instance is guaranteed to include an instance of type EntityType.
static ASOrderedCollectionPage IASModel<ASOrderedCollectionPage>.FromGraph(TypeMap typeMap)Parameters
typeMapTypeMap