Heracles.ts

@hydra-cg/heracles.ts > IPartialCollectionView

Interface: IPartialCollectionView

Describes an abstract partial collection view with links to other collection parts.

interface:

Hierarchy

↳ ILink

↳ IPartialCollectionView

Index

Properties

• baseUrl
• collections
• first
• iri
• last
• links
• next
• operations
• previous
• relation
• supportedOperations
• target
• type

---

Properties

baseUrl

● baseUrl: string

Inherited from ILink.baseUrl

Defined in DataModel/ILink.ts:22

Gets a base URL that can be used to resolve target in case it is relative.

readonly:

returns:

---

collections

● collections: ResourceFilterableCollection<ICollection>

Inherited from IHydraResource.collections

Defined in DataModel/IHydraResource.ts:17

Gets collections exposed by that resource.

readonly:

returns:

---

<Optional> first

● first: ILink

Defined in DataModel/IPartialCollectionView.ts:13

Gets the link to the first part of the collection, if any.

readonly:

returns:

---

iri

● iri: string

Inherited from IResource.iri

Defined in DataModel/IResource.ts:13

Gets an Iri of a resource.

readonly:

returns:

---

<Optional> last

● last: ILink

Defined in DataModel/IPartialCollectionView.ts:34

Gets the link to the last part of the collection, if any.

readonly:

returns:

---

links

● links: LinksCollection

Inherited from IHydraResource.links

Defined in DataModel/IHydraResource.ts:31

Gets links related to that resource.

readonly:

returns:

---

<Optional> next

● next: ILink

Defined in DataModel/IPartialCollectionView.ts:20

Gets the link to the next part of the collection, if any.

readonly:

returns:

---

operations

● operations: OperationsCollection

Inherited from IHydraResource.operations

Defined in DataModel/IHydraResource.ts:24

Gets operations that can be performed on that resource.

readonly:

returns:

---

<Optional> previous

● previous: ILink

Defined in DataModel/IPartialCollectionView.ts:27

Gets the link to the previous part of the collection, if any.

readonly:

returns:

---

relation

● relation: string

Inherited from ILink.relation

Defined in DataModel/ILink.ts:16

Gets a relation of the link.

readonly:

returns:

---

supportedOperations

● supportedOperations: OperationsCollection

Inherited from ILink.supportedOperations

Defined in DataModel/ILink.ts:36

Gets a link’s supported operations.

readonly:

returns:

---

target

● target: IResource

Inherited from ILink.target

Defined in DataModel/ILink.ts:29

Gets a target URL to be called.

readonly:

returns:

---

type

● type: TypesCollection

Inherited from IResource.type

Defined in DataModel/IResource.ts:20

Gets classes a given resource is of.

readonly:

returns:

---

This site is open source. Improve this page.