propertyfeatured

Documentation

Overview

Package propertyfeatured contains the implementation for the featured property. All applications are strongly encouraged to use the interface instead of this concrete definition. The interfaces allow applications to consume only the types and properties needed and be independent of the go-fed implementation if another alternative implementation is created. This package is code-generated and subject to the same license as the go-fed tool used to generate it.

This package is independent of other types' and properties' implementations by having a Manager injected into it to act as a factory for the concrete implementations. The implementations have been generated into their own separate subpackages for each vocabulary.

Strongly consider using the interfaces instead of this package.

Index

• func SetManager(m privateManager)
• type TootFeaturedProperty
  • func DeserializeFeaturedProperty(m map[string]interface{}, aliasMap map[string]string) (*TootFeaturedProperty, error)
  • func NewTootFeaturedProperty() *TootFeaturedProperty
  • func (this *TootFeaturedProperty) Clear()
  • func (this TootFeaturedProperty) GetActivityStreamsOrderedCollection() vocab.ActivityStreamsOrderedCollection
  • func (this TootFeaturedProperty) GetActivityStreamsOrderedCollectionPage() vocab.ActivityStreamsOrderedCollectionPage
  • func (this TootFeaturedProperty) GetIRI() *url.URL
  • func (this TootFeaturedProperty) GetType() vocab.Type
  • func (this TootFeaturedProperty) HasAny() bool
  • func (this TootFeaturedProperty) IsActivityStreamsOrderedCollection() bool
  • func (this TootFeaturedProperty) IsActivityStreamsOrderedCollectionPage() bool
  • func (this TootFeaturedProperty) IsIRI() bool
  • func (this TootFeaturedProperty) JSONLDContext() map[string]string
  • func (this TootFeaturedProperty) KindIndex() int
  • func (this TootFeaturedProperty) LessThan(o vocab.TootFeaturedProperty) bool
  • func (this TootFeaturedProperty) Name() string
  • func (this TootFeaturedProperty) Serialize() (interface{}, error)
  • func (this *TootFeaturedProperty) SetActivityStreamsOrderedCollection(v vocab.ActivityStreamsOrderedCollection)
  • func (this *TootFeaturedProperty) SetActivityStreamsOrderedCollectionPage(v vocab.ActivityStreamsOrderedCollectionPage)
  • func (this *TootFeaturedProperty) SetIRI(v *url.URL)
  • func (this *TootFeaturedProperty) SetType(t vocab.Type) error

Functions

func SetManager

func SetManager(m privateManager)

SetManager sets the manager package-global variable. For internal use only, do not use as part of Application behavior. Must be called at golang init time.

Types

type TootFeaturedProperty

type TootFeaturedProperty struct {
	// contains filtered or unexported fields
}

TootFeaturedProperty is the functional property "featured". It is permitted to be one of multiple value types. At most, one type of value can be present, or none at all. Setting a value will clear the other types of values so that only one of the 'Is' methods will return true. It is possible to clear all values, so that this property is empty.

func DeserializeFeaturedProperty

func DeserializeFeaturedProperty(m map[string]interface{}, aliasMap map[string]string) (*TootFeaturedProperty, error)

DeserializeFeaturedProperty creates a "featured" property from an interface representation that has been unmarshalled from a text or binary format.

func NewTootFeaturedProperty

func NewTootFeaturedProperty() *TootFeaturedProperty

NewTootFeaturedProperty creates a new featured property.

func (*TootFeaturedProperty) Clear

func (this *TootFeaturedProperty) Clear()

Clear ensures no value of this property is set. Calling HasAny or any of the 'Is' methods afterwards will return false.

func (TootFeaturedProperty) GetActivityStreamsOrderedCollection

func (this TootFeaturedProperty) GetActivityStreamsOrderedCollection() vocab.ActivityStreamsOrderedCollection

GetActivityStreamsOrderedCollection returns the value of this property. When IsActivityStreamsOrderedCollection returns false, GetActivityStreamsOrderedCollection will return an arbitrary value.

func (TootFeaturedProperty) GetActivityStreamsOrderedCollectionPage

func (this TootFeaturedProperty) GetActivityStreamsOrderedCollectionPage() vocab.ActivityStreamsOrderedCollectionPage

GetActivityStreamsOrderedCollectionPage returns the value of this property. When IsActivityStreamsOrderedCollectionPage returns false, GetActivityStreamsOrderedCollectionPage will return an arbitrary value.

func (TootFeaturedProperty) GetIRI

func (this TootFeaturedProperty) GetIRI() *url.URL

GetIRI returns the IRI of this property. When IsIRI returns false, GetIRI will return an arbitrary value.

func (TootFeaturedProperty) GetType

func (this TootFeaturedProperty) GetType() vocab.Type

GetType returns the value in this property as a Type. Returns nil if the value is not an ActivityStreams type, such as an IRI or another value.

func (TootFeaturedProperty) HasAny

func (this TootFeaturedProperty) HasAny() bool

HasAny returns true if any of the different values is set.

func (TootFeaturedProperty) IsActivityStreamsOrderedCollection

func (this TootFeaturedProperty) IsActivityStreamsOrderedCollection() bool

IsActivityStreamsOrderedCollection returns true if this property has a type of "OrderedCollection". When true, use the GetActivityStreamsOrderedCollection and SetActivityStreamsOrderedCollection methods to access and set this property.

func (TootFeaturedProperty) IsActivityStreamsOrderedCollectionPage

func (this TootFeaturedProperty) IsActivityStreamsOrderedCollectionPage() bool

IsActivityStreamsOrderedCollectionPage returns true if this property has a type of "OrderedCollectionPage". When true, use the GetActivityStreamsOrderedCollectionPage and SetActivityStreamsOrderedCollectionPage methods to access and set this property.

func (TootFeaturedProperty) IsIRI

func (this TootFeaturedProperty) IsIRI() bool

IsIRI returns true if this property is an IRI. When true, use GetIRI and SetIRI to access and set this property

func (TootFeaturedProperty) JSONLDContext

func (this TootFeaturedProperty) JSONLDContext() map[string]string

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.

func (TootFeaturedProperty) KindIndex

func (this TootFeaturedProperty) KindIndex() int

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.

func (TootFeaturedProperty) LessThan

func (this TootFeaturedProperty) LessThan(o vocab.TootFeaturedProperty) bool

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.

func (TootFeaturedProperty) Name

func (this TootFeaturedProperty) Name() string

Name returns the name of this property: "featured".

func (TootFeaturedProperty) Serialize

func (this TootFeaturedProperty) Serialize() (interface{}, error)

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.

func (*TootFeaturedProperty) SetActivityStreamsOrderedCollection

func (this *TootFeaturedProperty) SetActivityStreamsOrderedCollection(v vocab.ActivityStreamsOrderedCollection)

SetActivityStreamsOrderedCollection sets the value of this property. Calling IsActivityStreamsOrderedCollection afterwards returns true.

func (*TootFeaturedProperty) SetActivityStreamsOrderedCollectionPage

func (this *TootFeaturedProperty) SetActivityStreamsOrderedCollectionPage(v vocab.ActivityStreamsOrderedCollectionPage)

SetActivityStreamsOrderedCollectionPage sets the value of this property. Calling IsActivityStreamsOrderedCollectionPage afterwards returns true.

func (*TootFeaturedProperty) SetIRI

func (this *TootFeaturedProperty) SetIRI(v *url.URL)

SetIRI sets the value of this property. Calling IsIRI afterwards returns true.

func (*TootFeaturedProperty) SetType

func (this *TootFeaturedProperty) SetType(t vocab.Type) error

SetType attempts to set the property for the arbitrary type. Returns an error if it is not a valid type to set on this property.