cisco.uc.cuae.legacy
Class RemoteCiscoExtensionMobilityServer._Async

java.lang.Object
  cisco.uc.cuae.legacy.RemoteCiscoExtensionMobility._Async
      cisco.uc.cuae.legacy.RemoteCiscoExtensionMobilityServer._Async

Enclosing class:

RemoteCiscoExtensionMobilityServer

public final class RemoteCiscoExtensionMobilityServer._Async
extends RemoteCiscoExtensionMobility._Async

Asynchronous implementation of service methods.

Constructor Summary

RemoteCiscoExtensionMobilityServer._Async()

Method Summary

etch.bindings.java.support.Mailbox	_begin_login(java.lang.String sessionId, java.lang.String userId, java.lang.String deviceName, java.lang.String callManagerIP, CiscoExtensionMobility.Version version, java.lang.String appId, java.lang.String appCertificate, CiscoExtensionMobility.LoginOptions options) Begins a call to login.
etch.bindings.java.support.Mailbox	_begin_logout(java.lang.String sessionId, java.lang.String deviceName, java.lang.String callManagerIP, CiscoExtensionMobility.Version version, java.lang.String appId, java.lang.String appCertificate, CiscoExtensionMobility.LogoutOptions options) Begins a call to logout.
etch.bindings.java.support.Mailbox	_begin_queryDevices(java.lang.String sessionId, java.lang.String[] deviceNames, java.lang.String callManagerIP, CiscoExtensionMobility.Version version, java.lang.String appId, java.lang.String appCertificate, CiscoExtensionMobility.QueryDevicesOptions options) Begins a call to queryDevices.
etch.bindings.java.support.Mailbox	_begin_queryUsers(java.lang.String sessionId, java.lang.String[] users, java.lang.String callManagerIP, CiscoExtensionMobility.Version version, java.lang.String appId, java.lang.String appCertificate, CiscoExtensionMobility.QueryUsersOptions options) Begins a call to queryUsers.
CiscoExtensionMobility.LoginResult	_end_login(etch.bindings.java.support.Mailbox mb) Ends a call to login.
CiscoExtensionMobility.LogoutResult	_end_logout(etch.bindings.java.support.Mailbox mb) Ends a call to logout.
CiscoExtensionMobility.QueryDevicesResult	_end_queryDevices(etch.bindings.java.support.Mailbox mb) Ends a call to queryDevices.
CiscoExtensionMobility.QueryUsersResult	_end_queryUsers(etch.bindings.java.support.Mailbox mb) Ends a call to queryUsers.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoteCiscoExtensionMobilityServer._Async

public RemoteCiscoExtensionMobilityServer._Async()

Method Detail

_begin_login

public final etch.bindings.java.support.Mailbox _begin_login(java.lang.String sessionId,
                                                             java.lang.String userId,
                                                             java.lang.String deviceName,
                                                             java.lang.String callManagerIP,
                                                             CiscoExtensionMobility.Version version,
                                                             java.lang.String appId,
                                                             java.lang.String appCertificate,
                                                             CiscoExtensionMobility.LoginOptions options)

Begins a call to login. Logs a user into a device with a device profile. This action will invoke the Login Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node. The Login action will log a user into a device using a device profile. The device profile can either already be associated with the user account, in which case the DeviceProfile action parameter need not be specified, or the action can explicitly specify a device profile that is not associated with the user.

Parameters:

sessionId - The session Id for this method call

userId - The user to log in the specified device.

deviceName - The name of the device, of the form SEPXXXXXXXXXXXX

callManagerIP - The IP address and port of a CallManager node with the Extension Mobility service running, in the form '[IP]:[Port]'. Note that the Extension Mobility service is on port 80 by default in 3.x/4.x, and on port 8080 by default in 5.x/6.x.

version - The version of Cisco Unified Communications Manager. This version is used in conjuction with CallManagerHost to build the URL of the Extension Mobility Service. The possible values are described below: other - Specifiy other if the Cisco Unified Communications Manager version is anything above 3.3. v333 - Specify v333 if the Cisco Unified Communications Manager version is 3.3.3, 3.3.4, or 3.3.5. Undefined - This is the default value to when nothing is specified for the Version field. It is strongly recommended that this value not be used because the behavior is undefined as well.

appId - The name of a user configured in Cisco Unified Communications Manager that has the necessary permissions to invoke methods on the Extension Mobility service.

appCertificate - The password of the user specified by AppId.

options - An object holding all the optional parameters

Returns:

mailbox used to retrieve the result using _end_login.

See Also:

RemoteCiscoExtensionMobilityServer.login(java.lang.String, java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.LoginOptions), _end_login(etch.bindings.java.support.Mailbox)

_end_login

public final CiscoExtensionMobility.LoginResult _end_login(etch.bindings.java.support.Mailbox mb)

Ends a call to login. Logs a user into a device with a device profile. This action will invoke the Login Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node. The Login action will log a user into a device using a device profile. The device profile can either already be associated with the user account, in which case the DeviceProfile action parameter need not be specified, or the action can explicitly specify a device profile that is not associated with the user.

Parameters:

mb - mailbox returned by _begin_login.

See Also:

RemoteCiscoExtensionMobilityServer.login(java.lang.String, java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.LoginOptions), _begin_login(java.lang.String, java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.LoginOptions)

_begin_logout

public final etch.bindings.java.support.Mailbox _begin_logout(java.lang.String sessionId,
                                                              java.lang.String deviceName,
                                                              java.lang.String callManagerIP,
                                                              CiscoExtensionMobility.Version version,
                                                              java.lang.String appId,
                                                              java.lang.String appCertificate,
                                                              CiscoExtensionMobility.LogoutOptions options)

Begins a call to logout. Logs out a user from a device. This action will invoke the Logout Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node. The Logout action will log a user out of a device, if the user's device profile is currently logged into a device.

Parameters:

sessionId - The session Id for this method call

deviceName - The name of the device to log the user out of. This value is typically of the form SEPXXXXXXXXXXXX.

callManagerIP - The IP address and port of the publisher CallManager IP, in the form '[IP]:[Port]'. Note that the Extension Mobility service is on port 80 by default in 3.x/4.x, and on port 8080 by default in 5.x/6.x.

version - The version of Cisco Unified Communications Manager. This version is used in conjuction with CallManagerHost to build the URL of the Extension Mobility Service. The possible values are described below: other - Specifiy other if the Cisco Unified Communications Manager version is anything above 3.3. v333 - Specify v333 if the Cisco Unified Communications Manager version is 3.3.3, 3.3.4, or 3.3.5. Undefined - This is the default value to when nothing is specified for the Version field. It is strongly recommended that this value not be used because the behavior is undefined as well.

appId - The name of a user configured in Cisco Unified Communications Manager that has the necessary permissions to invoke methods on the Extension Mobility service.

appCertificate - The password of the user specified by AppId.

options - An object holding all the optional parameters

Returns:

mailbox used to retrieve the result using _end_logout.

See Also:

RemoteCiscoExtensionMobilityServer.logout(java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.LogoutOptions), _end_logout(etch.bindings.java.support.Mailbox)

_end_logout

public final CiscoExtensionMobility.LogoutResult _end_logout(etch.bindings.java.support.Mailbox mb)

Ends a call to logout. Logs out a user from a device. This action will invoke the Logout Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node. The Logout action will log a user out of a device, if the user's device profile is currently logged into a device.

Parameters:

mb - mailbox returned by _begin_logout.

See Also:

RemoteCiscoExtensionMobilityServer.logout(java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.LogoutOptions), _begin_logout(java.lang.String, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.LogoutOptions)

_begin_queryDevices

public final etch.bindings.java.support.Mailbox _begin_queryDevices(java.lang.String sessionId,
                                                                    java.lang.String[] deviceNames,
                                                                    java.lang.String callManagerIP,
                                                                    CiscoExtensionMobility.Version version,
                                                                    java.lang.String appId,
                                                                    java.lang.String appCertificate,
                                                                    CiscoExtensionMobility.QueryDevicesOptions options)

Begins a call to queryDevices. Queries one or more devices, determining which user, if any, is currently logged into it. This action will invoke the QueryDevices Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node. Devices in Cisco Unified Communications Manager can potentially be logged into by a single, Extension Mobility-enabled user. QueryDevices is a means to discover this relationship. The action will query the Extension Mobility service to determine which user, if any, is logged into the specified device(s) at that moment in time. The QueryDevices action returns a complex data type that, without any help, requires a substantial amount of C# to parse. To alleviate the demand for repetitive C#, you can use the GetDeviceStatus action, which will help determine if a user is logged into a particular device. The Devices action parameter is of type string[], which does not map to a native type. There are two options for creating this type within a Cisco Unified Application Designer-based application. One is to create the string[] in a C# snippet in the action parameter, the other is to use the null () in a C# action parameter (which allows one to use an ArrayList variable). Both samples are listed below: Creating a string[] Dynamically Using ToArray() to convert an ArrayList to a string[]

Parameters:

sessionId - The session Id for this method call

deviceNames - The name(s) of the device(s)

callManagerIP - The IP address and port of a CallManager node with the Extension Mobility service running, in the form '[IP]:[Port]'. Note that the Extension Mobility service is on port 80 by default in 3.x/4.x, and on port 8080 by default in 5.x/6.x.

version - The version of Cisco Unified Communications Manager. This version is used in conjuction with CallManagerHost to build the URL of the Extension Mobility Service. The possible values are described below: other - Specifiy other if the Cisco Unified Communications Manager version is anything above 3.3. v333 - Specify v333 if the Cisco Unified Communications Manager version is 3.3.3, 3.3.4, or 3.3.5. Undefined - This is the default value to when nothing is specified for the Version field. It is strongly recommended that this value not be used because the behavior is undefined as well.

appId - The name of a user configured in Cisco Unified Communications Manager that has the necessary permissions to invoke methods on the Extension Mobility service.

appCertificate - The password of the user specified by AppId.

options - An object holding all the optional parameters

Returns:

mailbox used to retrieve the result using _end_queryDevices.

See Also:

RemoteCiscoExtensionMobilityServer.queryDevices(java.lang.String, java.lang.String[], java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.QueryDevicesOptions), _end_queryDevices(etch.bindings.java.support.Mailbox)

_end_queryDevices

public final CiscoExtensionMobility.QueryDevicesResult _end_queryDevices(etch.bindings.java.support.Mailbox mb)

Ends a call to queryDevices. Queries one or more devices, determining which user, if any, is currently logged into it. This action will invoke the QueryDevices Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node. Devices in Cisco Unified Communications Manager can potentially be logged into by a single, Extension Mobility-enabled user. QueryDevices is a means to discover this relationship. The action will query the Extension Mobility service to determine which user, if any, is logged into the specified device(s) at that moment in time. The QueryDevices action returns a complex data type that, without any help, requires a substantial amount of C# to parse. To alleviate the demand for repetitive C#, you can use the GetDeviceStatus action, which will help determine if a user is logged into a particular device. The Devices action parameter is of type string[], which does not map to a native type. There are two options for creating this type within a Cisco Unified Application Designer-based application. One is to create the string[] in a C# snippet in the action parameter, the other is to use the null () in a C# action parameter (which allows one to use an ArrayList variable). Both samples are listed below: Creating a string[] Dynamically Using ToArray() to convert an ArrayList to a string[]

Parameters:

mb - mailbox returned by _begin_queryDevices.

See Also:

RemoteCiscoExtensionMobilityServer.queryDevices(java.lang.String, java.lang.String[], java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.QueryDevicesOptions), _begin_queryDevices(java.lang.String, java.lang.String[], java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.QueryDevicesOptions)

_begin_queryUsers

public final etch.bindings.java.support.Mailbox _begin_queryUsers(java.lang.String sessionId,
                                                                  java.lang.String[] users,
                                                                  java.lang.String callManagerIP,
                                                                  CiscoExtensionMobility.Version version,
                                                                  java.lang.String appId,
                                                                  java.lang.String appCertificate,
                                                                  CiscoExtensionMobility.QueryUsersOptions options)

Begins a call to queryUsers. Queries one or more users, determining which device(s) each user is logged into. This action will invoke the QueryUsers Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node. Users in Cisco Unified Communications Manager with Extension Mobility profiles can log into one or more devices. QueryUsers is a means to discover this relationship. The action will query the Extension Mobility service to determine which devices one or more users are logged into at that moment in time. The QueryUsers action returns a complex data type that, without any help, requires a substantial amount of C# to parse. To alleviate the demand for repetitive C#, you can use the GetUserDevices action, which will help determine which device(s) a single user is logged into. The Users action parameter is of type string[], which does not map to a native type. There are two options for creating this type within a Cisco Unified Application Designer-based application. One is to create the string[] in a C# snippet in the action parameter, the other is to use the null () in a C# action parameter (which allows one to use an ArrayList variable). Both samples are listed below: Creating a string[] Dynamically Using ToArray() to convert an ArrayList to a string[]

Parameters:

sessionId - The session Id for this method call

users - The ID(s) of the user(s)

callManagerIP - The IP address and port of a CallManager node with the Extension Mobility service running, in the form '[IP]:[Port]'. Note that the Extension Mobility service is on port 80 by default in 3.x/4.x, and on port 8080 by default in 5.x/6.x.

version - The version of Cisco Unified Communications Manager. This version is used in conjuction with CallManagerHost to build the URL of the Extension Mobility Service. The possible values are described below: other - Specifiy other if the Cisco Unified Communications Manager version is anything above 3.3. v333 - Specify v333 if the Cisco Unified Communications Manager version is 3.3.3, 3.3.4, or 3.3.5. Undefined - This is the default value to when nothing is specified for the Version field. It is strongly recommended that this value not be used because the behavior is undefined as well.

appId - The name of a user configured in Cisco Unified Communications Manager that has the necessary permissions to invoke methods on the Extension Mobility service.

appCertificate - The password of the user specified by AppId.

options - An object holding all the optional parameters

Returns:

mailbox used to retrieve the result using _end_queryUsers.

See Also:

RemoteCiscoExtensionMobilityServer.queryUsers(java.lang.String, java.lang.String[], java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.QueryUsersOptions), _end_queryUsers(etch.bindings.java.support.Mailbox)

_end_queryUsers

public final CiscoExtensionMobility.QueryUsersResult _end_queryUsers(etch.bindings.java.support.Mailbox mb)

Ends a call to queryUsers. Queries one or more users, determining which device(s) each user is logged into. This action will invoke the QueryUsers Extension Mobility API method by communicating to the specified Cisco Unified Communications Manager node. Users in Cisco Unified Communications Manager with Extension Mobility profiles can log into one or more devices. QueryUsers is a means to discover this relationship. The action will query the Extension Mobility service to determine which devices one or more users are logged into at that moment in time. The QueryUsers action returns a complex data type that, without any help, requires a substantial amount of C# to parse. To alleviate the demand for repetitive C#, you can use the GetUserDevices action, which will help determine which device(s) a single user is logged into. The Users action parameter is of type string[], which does not map to a native type. There are two options for creating this type within a Cisco Unified Application Designer-based application. One is to create the string[] in a C# snippet in the action parameter, the other is to use the null () in a C# action parameter (which allows one to use an ArrayList variable). Both samples are listed below: Creating a string[] Dynamically Using ToArray() to convert an ArrayList to a string[]

Parameters:

mb - mailbox returned by _begin_queryUsers.

See Also:

RemoteCiscoExtensionMobilityServer.queryUsers(java.lang.String, java.lang.String[], java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.QueryUsersOptions), _begin_queryUsers(java.lang.String, java.lang.String[], java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.Version, java.lang.String, java.lang.String, cisco.uc.cuae.legacy.CiscoExtensionMobility.QueryUsersOptions)