Hyperwave API

• Introduction
• Installing/Configuring
  • Requirements
  • Installation
  • Runtime Configuration
  • Resource Types
• Predefined Constants
• Hyperwave API Functions
  • hw_api_attribute->key — Returns key of the attribute
  • hw_api_attribute->langdepvalue — Returns value for a given language
  • hw_api_attribute->value — Returns value of the attribute
  • hw_api_attribute->values — Returns all values of the attribute
  • hw_api_attribute — Creates instance of class hw_api_attribute
  • hw_api->checkin — Checks in an object
  • hw_api->checkout — Checks out an object
  • hw_api->children — Returns children of an object
  • hw_api_content->mimetype — Returns mimetype
  • hw_api_content->read — Read content
  • hw_api->content — Returns content of an object
  • hw_api->copy — Copies physically
  • hw_api->dbstat — Returns statistics about database server
  • hw_api->dcstat — Returns statistics about document cache server
  • hw_api->dstanchors — Returns a list of all destination anchors
  • hw_api->dstofsrcanchor — Returns destination of a source anchor
  • hw_api_error->count — Returns number of reasons
  • hw_api_error->reason — Returns reason of error
  • hw_api->find — Search for objects
  • hw_api->ftstat — Returns statistics about fulltext server
  • hwapi_hgcsp — Returns object of class hw_api
  • hw_api->hwstat — Returns statistics about Hyperwave server
  • hw_api->identify — Log into Hyperwave Server
  • hw_api->info — Returns information about server configuration
  • hw_api->insert — Inserts a new object
  • hw_api->insertanchor — Inserts a new object of type anchor
  • hw_api->insertcollection — Inserts a new object of type collection
  • hw_api->insertdocument — Inserts a new object of type document
  • hw_api->link — Creates a link to an object
  • hw_api->lock — Locks an object
  • hw_api->move — Moves object between collections
  • hw_api_content — Create new instance of class hw_api_content
  • hw_api_object->assign — Clones object
  • hw_api_object->attreditable — Checks whether an attribute is editable
  • hw_api_object->count — Returns number of attributes
  • hw_api_object->insert — Inserts new attribute
  • hw_api_object — Creates a new instance of class hw_api_object
  • hw_api_object->remove — Removes attribute
  • hw_api_object->title — Returns the title attribute
  • hw_api_object->value — Returns value of attribute
  • hw_api->object — Retrieve attribute information
  • hw_api->objectbyanchor — Returns the object an anchor belongs to
  • hw_api->parents — Returns parents of an object
  • hw_api_reason->description — Returns description of reason
  • hw_api_reason->type — Returns type of reason
  • hw_api->remove — Delete an object
  • hw_api->replace — Replaces an object
  • hw_api->setcommittedversion — Commits version other than last version
  • hw_api->srcanchors — Returns a list of all source anchors
  • hw_api->srcsofdst — Returns source of a destination object
  • hw_api->unlock — Unlocks a locked object
  • hw_api->user — Returns the own user object
  • hw_api->userlist — Returns a list of all logged in users