Type: synchronous
History of change:
| DLS version
| Change
| .HI-DLS.10.300.00.
e164ModifySipSubscriber(String, String, String, String, String, String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
Modify a SIP subscriber based on its e164 number.
e164ModifySipSubscriberType02(String, String, String, String, String, String, String, String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED .
e164QuerySubscribers(String, String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
Query DLS inventory DB based on e164 number (search pattern).
e164QuerySubscribersType01(String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
This method does essentialy the same as DlsAPIv100.e164QuerySubscribers(String, String, String, String)
with queryType=01.
e164QuerySubscribersType02(String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
This method does essentialy the same as DlsAPIv100.e164QuerySubscribers(String, String, String, String)
with queryType=02.
ERROR_INVALID_e164 -
Static variable in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
Submitted e164 has invalid format, inventory or pp data cannot be searched.
ERROR_SUBSCRIBER_BUSY -
Static variable in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
Subscriber found in inventory db, but a mobile user is logged on.
ERROR_SUBSCRIBER_NOT_DELETED -
Static variable in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
Subscriber found in inventory db, no mobile user logged on, but deletion was not possiblle.
ERROR_SUBSCRIBER_NOT_FOUND -
Static variable in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
Nor a subscriber neither plug & play data found.
F
- fromString(String) -
Static method in class de.siemens.icn.hipath.dls.apiv100.device.KeyFunction
-
- fromValue(String) -
Static method in class de.siemens.icn.hipath.dls.apiv100.device.KeyFunction
-
- FunctionDescription - Class in de.siemens.icn.hipath.dls.apiv100.device
- Describes a key function.
- FunctionDescription() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.FunctionDescription
-
- FunctionDescription(String, String, String, int, String, AttributeDescription[]) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.FunctionDescription
-
- FunctionDescriptionAPIout - Class in de.siemens.icn.hipath.dls.apiv100
-
- FunctionDescriptionAPIout() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.FunctionDescriptionAPIout
-
- FunctionDescriptionAPIout(int, String) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.FunctionDescriptionAPIout
-
- FunctionDescriptionAPIout(FunctionDescription[]) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.FunctionDescriptionAPIout
-
G
- gatewayStartupNotification(String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
- Notify DLS about gateway startup.
- getApiServerVersionString() -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
- Get the version of the DlsAPI.
- getAttributes() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.DescriptionBase
-
- getAttributes() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getAttributes() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Layout
-
- getDevice() -
Method in class de.siemens.icn.hipath.dls.apiv100.DeviceAPIout
-
- getDeviceDescriptions() -
Method in class de.siemens.icn.hipath.dls.apiv100.DeviceDescriptionAPIout
-
- getDeviceDescriptions(String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
- This method returns master data of devices suported by DLS (i.e. device type, modules, level and keys).
- getDeviceID() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- getDeviceId() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
-
- getDeviceProfileName() -
Method in class de.siemens.icn.hipath.dls.apiv100.DeviceProfileAPIout
-
- getDeviceType() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.DescriptionBase
-
- getDeviceType() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.DeviceDescription
-
- getDeviceType() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- getDisplayID() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- getDlsServerVersionString() -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
- Get the version of the DLS server.
- getE164() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- getE164() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- getE164() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
-
- getEnglishText() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.TextDescription
-
- getFunctionDescriptions(String, String, int, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
Key function descriptions are stable throughout a DLS release.
- getFunctionDescriptions() -
Method in class de.siemens.icn.hipath.dls.apiv100.FunctionDescriptionAPIout
-
- getFunctions() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.KeyDescription
-
- getGermanText() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.TextDescription
-
- getIpAddress() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- getIsRegistered() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- getKey() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.TextDescription
-
- getKeyFunct() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getKeyFunctVerifyState() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getKeys() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- getLastRegistration() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- getLayout() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- getLayoutDescription(String, String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
Key layout descriptions are stable throughout a DLS release.
- getLayoutDescription() -
Method in class de.siemens.icn.hipath.dls.apiv100.LayoutDescriptionAPIout
-
- getLevel() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.FunctionDescription
-
- getLevel() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getLevelVerifyState() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getModule() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getModules() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.DeviceDescription
-
- getModuleVerifyState() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getName() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Attribute
-
- getName() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.AttributeDescription
-
- getName() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.FunctionDescription
-
- getNumber() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getNumber() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.KeyDescription
-
- getNumberOfKeys() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.ModuleDescription
-
- getNumberOfLevels() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.ModuleDescription
-
- getNumberOfSubscribers() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteList
-
- getNumberOfSubscribers() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
- getNumberVerifyState() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- getRequestID() -
Method in class de.siemens.icn.hipath.dls.apiv100.DlsAPIout
-
- getResult() -
Method in class de.siemens.icn.hipath.dls.apiv100.DlsAPIout
-
- getSipSubscribers() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteList
-
- getSipSubscribers() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
- getSoftwareType() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.DescriptionBase
-
- getSoftwareType() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- getSoftwareTypes() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.DeviceDescription
-
- getSoftwareVersion() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.DescriptionBase
-
- getSoftwareVersion() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- getStatus() -
Method in class de.siemens.icn.hipath.dls.apiv100.DlsAPIout
-
- getStatus() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
-
- getStatusOfRequestID(String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
- Get status of an asynchronously started request (i.e. a request that
returned
DlsAPIout.DLSAPI_OK_RUNNING ).
- getStatusOfRequestIDs(String, String, String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
- Get status of asynchronously started requests (i.e. all requests that
returned
DlsAPIout.DLSAPI_OK_RUNNING ) including their current
status.
- getStatusText() -
Method in class de.siemens.icn.hipath.dls.apiv100.DlsAPIout
-
- getStatusText() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
-
- getSwType() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- getSwVersion() -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- getTimeInMillis() -
Method in class de.siemens.icn.hipath.dls.apiv100.DeviceProfileAPIout
-
- getType() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.AttributeDescription
-
- getType() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- getType() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.ModuleDescription
-
- getValidationState() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Attribute
-
- getValue() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Attribute
-
- getValue() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.KeyFunction
-
- getValueList() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.AttributeDescription
-
I
- isRequired() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.AttributeDescription
-
K
- Key - Class in de.siemens.icn.hipath.dls.apiv100.device
-
- Key() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- KeyDescription - Class in de.siemens.icn.hipath.dls.apiv100.device
-
- KeyDescription() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.KeyDescription
-
- KeyDescription(String, FunctionDescription[]) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.KeyDescription
-
- KeyFunction - Class in de.siemens.icn.hipath.dls.apiv100.device
-
L
- Layout - Class in de.siemens.icn.hipath.dls.apiv100.device
-
- Layout() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.Layout
-
- LayoutDescription - Class in de.siemens.icn.hipath.dls.apiv100.device
-
- LayoutDescription() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.LayoutDescription
-
- LayoutDescription(String, String, String, AttributeDescription[]) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.LayoutDescription
-
- LayoutDescriptionAPIout - Class in de.siemens.icn.hipath.dls.apiv100
-
- LayoutDescriptionAPIout() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.LayoutDescriptionAPIout
-
- LayoutDescriptionAPIout(int, String) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.LayoutDescriptionAPIout
-
- LayoutDescriptionAPIout(LayoutDescription) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.LayoutDescriptionAPIout
-
- LINE_HUNT_SEQ -
Static variable in class de.siemens.icn.hipath.dls.apiv100.device.KeyFunction
-
- LINE_SHARED -
Static variable in class de.siemens.icn.hipath.dls.apiv100.device.KeyFunction
-
- lineHuntSeq -
Static variable in class de.siemens.icn.hipath.dls.apiv100.device.KeyFunction
-
- lineShared -
Static variable in class de.siemens.icn.hipath.dls.apiv100.device.KeyFunction
-
- listDeviceProfiles(String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
- List all device profiles names currently configured in DLS.
M
- mobileUserLogoff(String, String, String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
-
Logoff a mobile user from a mobility-enabled phone.
- mobileUserLogon(String, String, String, String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
-
Logon a mobile user to a mobility-enabled phone.
- mobileUserModifyTerminalName(String, String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
-
Modify the terminal name of a mobile user.
- mobileUserSearch(String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
-
Return mobility-enabled phone(s), the mobile user is currently logged on.
- mobileUserStatus(String, String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
-
Return current mobility status of a mobility-enabled phone.
- ModuleDescription - Class in de.siemens.icn.hipath.dls.apiv100.device
- Describes a hardware module of a device.
- ModuleDescription() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.ModuleDescription
-
- ModuleDescription(String, int, int) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.ModuleDescription
-
O
- OK_SUBSCRIBER -
Static variable in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
- Subscriber found in inventory db, no mobile user loggod on.
- OK_SUBSCRIBER_DELETED -
Static variable in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
- Subscriber found, no mobile user logged on, and together with its pp data deleted.
- openSession(String, String) -
Method in interface de.siemens.icn.hipath.dls.apiv100.DlsAPIv100
- Open a DlsAPI session.
R
- requestID -
Variable in class de.siemens.icn.hipath.dls.apiv100.DlsAPIout
- Relevant in case of methods returning DLSAPI_OK_RUNNING (i.e. asynchronous execution of the request).
- result -
Variable in class de.siemens.icn.hipath.dls.apiv100.DlsAPIout
- Contains the requested method's result (if provided), e.g. output of query/get requests.
S
- setAttributes(Attribute[]) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setAttributes(Attribute[]) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Layout
-
- setE164(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- setKeyFunct(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setKeyFunctVerifyState(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setKeys(Key[]) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- setLayout(Layout) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- setLevel(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setLevelVerifyState(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setModule(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setModuleVerifyState(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setName(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Attribute
-
- setNumber(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setNumberVerifyState(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- setStatus(int) -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
-
- setStatusText(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
-
- setValue(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Attribute
-
- SipSubscriberData - Class in de.siemens.icn.hipath.dls.apiv100
- This class serves as data holder for sip subscriber values.
- SipSubscriberData() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- SipSubscriberData(String[]) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- SipSubscriberData(String, String, String, String, String, String, String, String) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- SipSubscriberDeleteData - Class in de.siemens.icn.hipath.dls.apiv100
-
- SipSubscriberDeleteData() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
-
- SipSubscriberDeleteData(int, String, String) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteData
-
- SipSubscriberDeleteList - Class in de.siemens.icn.hipath.dls.apiv100
- This class represents a list of sip subscribers.
- SipSubscriberDeleteList(SipSubscriberDeleteData[], int, String) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteList
-
- SipSubscriberDeleteList(SipSubscriberDeleteData[], int) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteList
-
- SipSubscriberDeleteList(int) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteList
-
- SipSubscriberDeleteList(SipSubscriberDeleteData[]) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteList
-
- SipSubscriberDeleteList() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberDeleteList
-
- SipSubscriberList - Class in de.siemens.icn.hipath.dls.apiv100
- This class represents a list of sip subscribers.
- SipSubscriberList(SipSubscriberData[], int, String, String, String) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
- SipSubscriberList(SipSubscriberData[], int, String, String) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
- SipSubscriberList(SipSubscriberData[], int, String) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
- SipSubscriberList(SipSubscriberData[], int) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
- SipSubscriberList(SipSubscriberData[]) -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
- SipSubscriberList() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
- status -
Variable in class de.siemens.icn.hipath.dls.apiv100.DlsAPIout
- The requested method's return status.
- statusText -
Variable in class de.siemens.icn.hipath.dls.apiv100.DlsAPIout
- In case of errors: contains a text in English language, that explains the returned status in more detail.
T
- TextDescription - Class in de.siemens.icn.hipath.dls.apiv100.device
-
- TextDescription() -
Constructor for class de.siemens.icn.hipath.dls.apiv100.device.TextDescription
-
- toString() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Attribute
-
- toString() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.AttributeDescription
-
- toString() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.DescriptionBase
-
- toString() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Device
-
- toString() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Key
-
- toString() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.Layout
-
- toString() -
Method in class de.siemens.icn.hipath.dls.apiv100.device.ModuleDescription
-
- toString() -
Method in class de.siemens.icn.hipath.dls.apiv100.DeviceAPIout
-
- toString(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberData
-
- toString(String) -
Method in class de.siemens.icn.hipath.dls.apiv100.SipSubscriberList
-
A C D E F G I K L M O R S T
|