activity/streams/vocab/gen_property_current_interf...

117 行
4.9 KiB
Go

package vocab
import "net/url"
// In a paged Collection, indicates the page that contains the most recently
// updated member items.
//
// Example 74 (https://www.w3.org/TR/activitystreams-vocabulary/#ex71-jsonld):
// {
// "current": "http://example.org/collection",
// "items": [
// "http://example.org/posts/1",
// "http://example.org/posts/2",
// "http://example.org/posts/3"
// ],
// "summary": "Sally's blog posts",
// "totalItems": 3,
// "type": "Collection"
// }
//
// Example 75 (https://www.w3.org/TR/activitystreams-vocabulary/#ex72-jsonld):
// {
// "current": {
// "summary": "Most Recent Items",
// "type": "owl:Class",
// "url": "http://example.org/collection"
// },
// "items": [
// "http://example.org/posts/1",
// "http://example.org/posts/2",
// "http://example.org/posts/3"
// ],
// "summary": "Sally's blog posts",
// "totalItems": 3,
// "type": "Collection"
// }
type CurrentPropertyInterface interface {
// Clear ensures no value of this property is set. Calling HasAny or any
// of the 'Is' methods afterwards will return false.
Clear()
// GetCollectionPage returns the value of this property. When
// IsCollectionPage returns false, GetCollectionPage will return an
// arbitrary value.
GetCollectionPage() CollectionPageInterface
// GetIRI returns the IRI of this property. When IsIRI returns false,
// GetIRI will return an arbitrary value.
GetIRI() *url.URL
// GetLink returns the value of this property. When IsLink returns false,
// GetLink will return an arbitrary value.
GetLink() LinkInterface
// GetMention returns the value of this property. When IsMention returns
// false, GetMention will return an arbitrary value.
GetMention() MentionInterface
// GetOrderedCollectionPage returns the value of this property. When
// IsOrderedCollectionPage returns false, GetOrderedCollectionPage
// will return an arbitrary value.
GetOrderedCollectionPage() OrderedCollectionPageInterface
// HasAny returns true if any of the different values is set.
HasAny() bool
// IsCollectionPage returns true if this property has a type of
// "CollectionPage". When true, use the GetCollectionPage and
// SetCollectionPage methods to access and set this property.
IsCollectionPage() bool
// IsIRI returns true if this property is an IRI. When true, use GetIRI
// and SetIRI to access and set this property
IsIRI() bool
// IsLink returns true if this property has a type of "Link". When true,
// use the GetLink and SetLink methods to access and set this property.
IsLink() bool
// IsMention returns true if this property has a type of "Mention". When
// true, use the GetMention and SetMention methods to access and set
// this property.
IsMention() bool
// IsOrderedCollectionPage returns true if this property has a type of
// "OrderedCollectionPage". When true, use the
// GetOrderedCollectionPage and SetOrderedCollectionPage methods to
// access and set this property.
IsOrderedCollectionPage() bool
// JSONLDContext returns the JSONLD URIs required in the context string
// for this property and the specific values that are set. The value
// in the map is the alias used to import the property's value or
// values.
JSONLDContext() map[string]string
// KindIndex computes an arbitrary value for indexing this kind of value.
// This is a leaky API detail only for folks looking to replace the
// go-fed implementation. Applications should not use this method.
KindIndex() int
// LessThan compares two instances of this property with an arbitrary but
// stable comparison. Applications should not use this because it is
// only meant to help alternative implementations to go-fed to be able
// to normalize nonfunctional properties.
LessThan(o CurrentPropertyInterface) bool
// Name returns the name of this property: "current".
Name() string
// Serialize converts this into an interface representation suitable for
// marshalling into a text or binary format. Applications should not
// need this function as most typical use cases serialize types
// instead of individual properties. It is exposed for alternatives to
// go-fed implementations to use.
Serialize() (interface{}, error)
// SetCollectionPage sets the value of this property. Calling
// IsCollectionPage afterwards returns true.
SetCollectionPage(v CollectionPageInterface)
// SetIRI sets the value of this property. Calling IsIRI afterwards
// returns true.
SetIRI(v *url.URL)
// SetLink sets the value of this property. Calling IsLink afterwards
// returns true.
SetLink(v LinkInterface)
// SetMention sets the value of this property. Calling IsMention
// afterwards returns true.
SetMention(v MentionInterface)
// SetOrderedCollectionPage sets the value of this property. Calling
// IsOrderedCollectionPage afterwards returns true.
SetOrderedCollectionPage(v OrderedCollectionPageInterface)
}