typeendpoints

Documentation

Overview

Package typeendpoints contains the implementation for the Endpoints type. 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 ActivityStreamsEndpointsExtends(other vocab.Type) bool
• func EndpointsIsDisjointWith(other vocab.Type) bool
• func EndpointsIsExtendedBy(other vocab.Type) bool
• func IsOrExtendsEndpoints(other vocab.Type) bool
• func SetManager(m privateManager)
• func SetTypePropertyConstructor(f func() vocab.JSONLDTypeProperty)
• type ActivityStreamsEndpoints
  • func DeserializeEndpoints(m map[string]interface{}, aliasMap map[string]string) (*ActivityStreamsEndpoints, error)
  • func NewActivityStreamsEndpoints() *ActivityStreamsEndpoints
  • func (this ActivityStreamsEndpoints) GetActivityStreamsSharedInbox() vocab.ActivityStreamsSharedInboxProperty
  • func (this ActivityStreamsEndpoints) GetJSONLDId() vocab.JSONLDIdProperty
  • func (this ActivityStreamsEndpoints) GetTypeName() string
  • func (this ActivityStreamsEndpoints) GetUnknownProperties() map[string]interface{}
  • func (this ActivityStreamsEndpoints) IsExtending(other vocab.Type) bool
  • func (this ActivityStreamsEndpoints) JSONLDContext() map[string]string
  • func (this ActivityStreamsEndpoints) LessThan(o vocab.ActivityStreamsEndpoints) bool
  • func (this ActivityStreamsEndpoints) Serialize() (map[string]interface{}, error)
  • func (this *ActivityStreamsEndpoints) SetActivityStreamsSharedInbox(i vocab.ActivityStreamsSharedInboxProperty)
  • func (this *ActivityStreamsEndpoints) SetJSONLDId(i vocab.JSONLDIdProperty)
  • func (this ActivityStreamsEndpoints) VocabularyURI() string

Functions

func ActivityStreamsEndpointsExtends

func ActivityStreamsEndpointsExtends(other vocab.Type) bool

ActivityStreamsEndpointsExtends returns true if the Endpoints type extends from the other type.

func EndpointsIsDisjointWith

func EndpointsIsDisjointWith(other vocab.Type) bool

EndpointsIsDisjointWith returns true if the other provided type is disjoint with the Endpoints type.

func EndpointsIsExtendedBy

func EndpointsIsExtendedBy(other vocab.Type) bool

EndpointsIsExtendedBy returns true if the other provided type extends from the Endpoints type. Note that it returns false if the types are the same; see the "IsOrExtendsEndpoints" variant instead.

func IsOrExtendsEndpoints

func IsOrExtendsEndpoints(other vocab.Type) bool

IsOrExtendsEndpoints returns true if the other provided type is the Endpoints type or extends from the Endpoints type.

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.

func SetTypePropertyConstructor

func SetTypePropertyConstructor(f func() vocab.JSONLDTypeProperty)

SetTypePropertyConstructor sets the "type" property's constructor in the package-global variable. For internal use only, do not use as part of Application behavior. Must be called at golang init time. Permits ActivityStreams types to correctly set their "type" property at construction time, so users don't have to remember to do so each time. It is dependency injected so other go-fed compatible implementations could inject their own type.

Types

type ActivityStreamsEndpoints

type ActivityStreamsEndpoints struct {
	JSONLDId                   vocab.JSONLDIdProperty
	ActivityStreamsSharedInbox vocab.ActivityStreamsSharedInboxProperty
	// contains filtered or unexported fields
}

A json object which maps additional (typically server/domain-wide) endpoints which may be useful either for this actor or someone referencing this actor. This mapping may be nested inside the actor document as the value or may be a link to a JSON-LD document with these properties.

func DeserializeEndpoints

func DeserializeEndpoints(m map[string]interface{}, aliasMap map[string]string) (*ActivityStreamsEndpoints, error)

DeserializeEndpoints creates a Endpoints from a map representation that has been unmarshalled from a text or binary format.

func NewActivityStreamsEndpoints

func NewActivityStreamsEndpoints() *ActivityStreamsEndpoints

NewActivityStreamsEndpoints creates a new Endpoints type

func (ActivityStreamsEndpoints) GetActivityStreamsSharedInbox

func (this ActivityStreamsEndpoints) GetActivityStreamsSharedInbox() vocab.ActivityStreamsSharedInboxProperty

GetActivityStreamsSharedInbox returns the "sharedInbox" property if it exists, and nil otherwise.

func (ActivityStreamsEndpoints) GetJSONLDId

func (this ActivityStreamsEndpoints) GetJSONLDId() vocab.JSONLDIdProperty

GetJSONLDId returns the "id" property if it exists, and nil otherwise.

func (ActivityStreamsEndpoints) GetTypeName

func (this ActivityStreamsEndpoints) GetTypeName() string

GetTypeName returns the name of this type.

func (ActivityStreamsEndpoints) GetUnknownProperties

func (this ActivityStreamsEndpoints) GetUnknownProperties() map[string]interface{}

GetUnknownProperties returns the unknown properties for the Endpoints type. Note that this should not be used by app developers. It is only used to help determine which implementation is LessThan the other. Developers who are creating a different implementation of this type's interface can use this method in their LessThan implementation, but routine ActivityPub applications should not use this to bypass the code generation tool.

func (ActivityStreamsEndpoints) IsExtending

func (this ActivityStreamsEndpoints) IsExtending(other vocab.Type) bool

IsExtending returns true if the Endpoints type extends from the other type.

func (ActivityStreamsEndpoints) JSONLDContext

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

JSONLDContext returns the JSONLD URIs required in the context string for this type and the specific properties that are set. The value in the map is the alias used to import the type and its properties.

func (ActivityStreamsEndpoints) LessThan

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

LessThan computes if this Endpoints is lesser, with an arbitrary but stable determination.

func (ActivityStreamsEndpoints) Serialize

func (this ActivityStreamsEndpoints) Serialize() (map[string]interface{}, error)

Serialize converts this into an interface representation suitable for marshalling into a text or binary format.

func (*ActivityStreamsEndpoints) SetActivityStreamsSharedInbox

func (this *ActivityStreamsEndpoints) SetActivityStreamsSharedInbox(i vocab.ActivityStreamsSharedInboxProperty)

SetActivityStreamsSharedInbox sets the "sharedInbox" property.

func (*ActivityStreamsEndpoints) SetJSONLDId

func (this *ActivityStreamsEndpoints) SetJSONLDId(i vocab.JSONLDIdProperty)

SetJSONLDId sets the "id" property.

func (ActivityStreamsEndpoints) VocabularyURI

func (this ActivityStreamsEndpoints) VocabularyURI() string

VocabularyURI returns the vocabulary's URI as a string.