RegisterCallback
From
(Difference between revisions)
(→Parameters) |
|||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
== Method == | == Method == | ||
| − | + | [[RegisterCallbackResult]] registerCallback([[UserIDBean]] userID, String url, [[UserIDBean]] callbackUserID, long updatePeriod, [[CallbackVersion]] version) | |
== Description == | == Description == | ||
| − | + | Registers an instance of the callback interface for receiving events related to field devices and jobs. Each user may register only once, if more than one callback interface must be registered, a user for each must be created in the NADS system. | |
| + | |||
| + | As part of the registration process, getVersion will be called on the interface to ensure that the version is supported and the interface is up. If this test fails, an failure will be returned by this method. | ||
== Parameters == | == Parameters == | ||
| Line 14: | Line 15: | ||
|[[UserIDBean]] | |[[UserIDBean]] | ||
|userID | |userID | ||
| − | |The admin username and password. | + | |The admin username and password used by your application to communicate with EService (in this case your application is actually a server that is implementing the [[SOAP_3_Callback_Documentation|Callback API]]). |
| + | |---- bgcolor=#EDEDFF | ||
| + | |String | ||
| + | |url | ||
| + | |The URl location of the callback interface instance. | ||
| + | |---- bgcolor=#EDEDFF | ||
| + | |[[UserIDBean]] | ||
| + | |callbackUserID | ||
| + | |The username and password required for EService to be able to access methods on the callback instance (that implements the [[SOAP_3_Callback_Documentation|Callback API]]). | ||
| + | |---- bgcolor=#EDEDFF | ||
| + | |long | ||
| + | |updatePeriod | ||
| + | |The period in seconds between calls to the callback interface. The minimum period between updates is 10 seconds, and the recommended value is 60 seconds. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
| − | |[[ | + | |[[CallbackVersion]] |
| − | | | + | |version |
| − | | | + | |The particular version of the callback interface that has been implemented. |
|} | |} | ||
== Return Value == | == Return Value == | ||
| − | [[ | + | [[RegisterCallbackResult]] |
Latest revision as of 22:03, 10 September 2015
Contents |
[edit] Method
RegisterCallbackResult registerCallback(UserIDBean userID, String url, UserIDBean callbackUserID, long updatePeriod, CallbackVersion version)
[edit] Description
Registers an instance of the callback interface for receiving events related to field devices and jobs. Each user may register only once, if more than one callback interface must be registered, a user for each must be created in the NADS system.
As part of the registration process, getVersion will be called on the interface to ensure that the version is supported and the interface is up. If this test fails, an failure will be returned by this method.
[edit] Parameters
| Type | Name | Description |
|---|---|---|
| UserIDBean | userID | The admin username and password used by your application to communicate with EService (in this case your application is actually a server that is implementing the Callback API). |
| String | url | The URl location of the callback interface instance. |
| UserIDBean | callbackUserID | The username and password required for EService to be able to access methods on the callback instance (that implements the Callback API). |
| long | updatePeriod | The period in seconds between calls to the callback interface. The minimum period between updates is 10 seconds, and the recommended value is 60 seconds. |
| CallbackVersion | version | The particular version of the callback interface that has been implemented. |
