OIP Index

oip-index is a simple module to retreive Artifacts, Publishers, and other OIP Objects back from OIP.

Table of Contents

• Installation Instructions
• Getting Started
  • Getting an Artifact from the Index
  • Use a Custom OIPd Server
  • Create a new Artifact
• API Documentation
  • Index
  • Artifact
• License

Installation Instructions

You can install the latest version by running the following npm install command.

$ npm install --save oip-index

Getting Started

Getting an Artifact from the Index

To get an Artifact back from the Index, we will first need to spawn a new Index object. This Index object is what we will interact with in order to get Artifacts back from the Index. After you have created a new Index you can lookup a specific Artifact using the .getArtifact(artifact_id) method. The getArtifact method returns a Promise that will resolve to the requested Artifact, or will reject if there was an error.

import { Index } from 'oip-index'

var index = new Index()

index.getArtifact("513691").then((artifact) => {
    console.log(artifact.getTitle())
})

Use a Custom OIPd Server

Using a custom OIPd server as your source for Artifacts is simple, yet powerful. To hookup to an OIPd server, simply pass the API url into the Index object when you create it. All requests made to the index object it creates will use the OIPd server you specified as its source of truth.

import { Index } from 'oip-index'

var index = new Index("https://my-oipd-url.com/api")

Create a new Artifact

Creating a new Artifact allows you to build your own Artifact that can then be handed off to oip-account for publishing to the Index. To create a new Artifact, we first need to import the Artifact class from oip-index. After we have imported the class, we can then create a new Artifact.

import { Artifact } from 'oip-index'

var myArtifact = new Artifact();

After we have created our new Artifact, we can then start setting values on it, as well as adding files. In this example, I am just going to set the Title, and Description.

myArtifact.setTitle("My Great Title")
myArtifact.setDescription("The description for the Artifact we are creating")

API Documentation

Learn more about how each Class works, or take a look at all functions available to you.

• Documentation Home
  • Index
  • Artifact

License

MIT License

Copyright (c) 2018 Open Index Protocol Working Group

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.