APIClient
has to be created only once and configured with the target Domain ID, the Domain Secret and (in most Cases) a valid Session ID - in most cases, that would be the Management Session ID.APIClient
will execute a valid APICall
. There are many different APICall
Classes for different Aspects of the API, but they all work in a similar Way.APICall
Class. In most cases, the APICall
Class Method is "humanized" and the Naming is less technical.APICall
Class exposes a getParameters()
and a getModifiers()
Method, which return Helper Classes for easier accessing the correct Parameters here:set
Method). Every valid Parameter though has also an explicit Setter (here setLimit
), which additionally check Consistency and Validity of the given Parameter.APIClient
takes the configured API Call and directly starts it. It returns an Instance of the APIResult
Class then, which can be handled like this:APIResult
Class can directly return the received JSON via getRawResponse
- or, only the "result" Part of the Response via getResult
.ResultObject
Class, which allows to query the JSON in a more human Way:getResultIterator
. The Iterator itself can return the pure JSON Objects or ResultObject
Class Instances as above.UploadHandler
Class:streamtypes
to be sure or just use a String.call
Method of the APIClient
offers a second Parameter, which will handle the Parameters and Interating over the API Responses to construct a APIResult
Object with indeed all Result Objects.setStreamtype
and a setItem
Method, which is extremely helpfull especially on Media Management, where one specific Media Item of a specific Streamtype should be modified.getResult
Method of the response
Object is is most cases sufficient.getChannels
. In most Cases, the response should be iterated over with an Iterator, but as most Lists are very short and Paging is (in most Cases) not supported, the getResult
Method is enough.getResult
Method of the APIResponse
Object is is most cases sufficient.