Sesha_Api
extends Horde_Registry_Api
in package
Sesha external API interface.
Copyright 2003-2017 Horde LLC (http://www.horde.org/)
This file defines Sesha's external API interface. Other applications can interact with Sesha through this API.
Tags
Table of Contents
- getQueueDetails() : array<string|int, mixed>
- Get a queueDetails hash for a queue (category)
- getVersionDetails() : array<string|int, mixed>
- return a version details hash by version id
- listQueues() : array<string|int, mixed>
- List categories as ticket queues
- listVersions() : array<string|int, mixed>
- List Stock items as versions for a queue (category)
Methods
getQueueDetails()
Get a queueDetails hash for a queue (category)
public
getQueueDetails(int $queue_id) : array<string|int, mixed>
Parameters
- $queue_id : int
-
The Queue for which to build the details hash
Return values
array<string|int, mixed> —A hash of category id as id, category label as name, category description as description, a link, a list of subjects as configured
getVersionDetails()
return a version details hash by version id
public
getVersionDetails(int $version_id) : array<string|int, mixed>
Parameters
- $version_id : int
-
The ID of the stock item to display as a version
Return values
array<string|int, mixed> —The version hash containing stock name as name, stock note as description and a link
listQueues()
List categories as ticket queues
public
listQueues() : array<string|int, mixed>
Return values
array<string|int, mixed> —a list of ticket queues with category id as key and category caption as value
listVersions()
List Stock items as versions for a queue (category)
public
listVersions(int $queue_id) : array<string|int, mixed>
Parameters
- $queue_id : int
-
The category id (queue) for which we want to fetch versions
Return values
array<string|int, mixed> —A hash containing stock id as id, stock name as name, stock note as description