|
Configuration Platform SDK 7.6 API Reference | ||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |
See:
Description
Class Summary | |
RequestCreateObject | Adds a new object with property values specified by ObjectType and ConfObject. |
RequestDeleteObject | A request to delete an object from the Genesys Configuration Layer. |
RequestReadObjects | A request to obtain information about objects in the Genesys Configuration Layer. |
RequestRegisterNotification | Registers application to receive notifications on the objects specified in the Subscription list. |
RequestUnregisterNotification | Unregisters application from receiving notifications on the objects specified in the Subscription list. |
RequestUpdateObject | Sets new property values specified by ConfObject (delta object) for the object specified by ObjectType and delta_object. |
This package contains the Request Object classes that your applications
can use to work with objects in the Genesys Configuration Layer.
To use these classes, you will need to supply information about the
objects you want to work with. For example, you might want to use
RequestReadObjects
to obtain information about an agent.
Agents are objects of type CfgPerson
,
so the first thing you need to do is look at the entry for CfgPerson
contained in the folder of Configuration Objects that comes with this API
Reference. (This folder is accessible from the Overview page.)
If you look at this entry, you will see a list of filter keys that you
can use to access a particular agent. For example, if you know the agent's
user name, you can use user_name
as a key to retrieve information
about that agent.
At this point, you will need one more piece of information to create your request.
Each object in the Configuration Layer has a type, called an ID
.
There is an enumeration,
ConfServerObjectType
that you can use to specify this ID. In this case, you want to ask for
ConfServerObjectType.Person
. Now that you know that, you are ready
to create a RequestReadObjects
.
As you can see in the snippet below, you first need to create a
KeyValueCollection
to hold your filter key. The collection can hold
more than one key, as long as they are all for the same kind of object. The next
step is to add the key and value for your agent. Finally, you create the request,
supplying the value for the object type. Note that you must convert the object
type to an int
before you create your request:
KeyValueCollection filterKey = new KeyValueCollection();
filterKey.addObject("user_name", agentUserName);
ConfServerObjectType objectType = ConfServerObjectType.Person;
int intPerson = objectType.asInteger();
RequestReadObjects requestReadObjects =
RequestReadObjects.create(
intPerson,
filterKey);
|
Configuration Platform SDK 7.6 API Reference | ||||||||||
PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES |