Starts an asynchronous removal of a user.
The user and its associated sessions will be removed, all sockets closed,
all services shut down and other internal resources released. When
removal is complete, the UserRemoved will be fired.
At that point, it is safe to dispose of the user.
Namespace:
Avaya.ClientServices
Assembly:
AvayaClientServices (in AvayaClientServices.dll) Version: 550.0.60.0
Syntaxpublic void RemoveUser(
User user,
bool gracefulRemove
)
Parameters
- user
- Type: Avaya.ClientServicesUser
The user to remove. - gracefulRemove
- Type: SystemBoolean
True if an attempt should be made to disconnect user from servers,
to wait for signaling completed, before cleanup of local resources
(a graceful removal). False if local-only removal should be performed
(an ungraceful removal).
Remarks
Removal may be graceful or ungraceful from the signaling perspective.
In a graceful removal, it will attempt to disconnect all established
connections used by the user and to unregister the user with servers
if applicable, before proceeding with shutdown and cleanup of internal
resources allocated for the user. It will wait to ensure that all the
required signaling is exchanged with the servers before the shutdown
operation is reported as complete. This graceful shutdown operation
may take some time as it may require waiting on timeouts if the server
or remote end of sessions are unreachable or unresponsive.
In an ungraceful removal, only shutdown of local services and local
resource cleanup for the user are performed.
See Also