store/Resource

Source:
See:
  • subclass Context
  • subclass List
  • subclass Graph
  • subclass String
  • subclass File
  • subclass User
  • subclass Group

Methods

getEntry() → {Promise.<Entry>|Entry}

Description:
  • Retrieves the entry that contains this resource. Asking for the entry directly (direct=true, rather than getting it asynchronously via a promise) should work for all resources except context resources.

    Advanced explanation: Context resources are often created opportunistically by the API without also loading the context entry along with it, e.g. when loading entries during a search operation. The reason why the context entries are not loaded along with the context resource is that such an approach, depending on the use-case, may lead to dramatic increases in the amount of requests to the repository.

Source:
Returns:

if direct=true an Entry is returned (or undefined if not in cache, only happens sometimes for Contexts) otherwise a promise is returned that on success provides the entry for this resource.

Type
Promise.<Entry> | Entry

getEntryStore() → {EntryStore}

Description:
  • Retrieves the API's repository instance

Source:
Returns:
Type
EntryStore

getEntryURI() → {string}

Description:
  • The URI to the entry containing this resource.

Source:
Returns:
Type
string

getId() → {string}

Description:
  • The id for the entry containing this resource.

Source:
Returns:
Type
string

getResourceURI() → {string}

Description:
  • The resources own URI.

Source:
Returns:
Type
string