Issues an asynchronous request to refresh the fax cache.

Namespace: ININ.IceLib.UnifiedMessaging
Assembly: ININ.IceLib.UnifiedMessaging (in ININ.IceLib.UnifiedMessaging.dll) Version: 0.0.0.0 (22.3.0.218)

Syntax

C#
public void RefreshFaxCacheAsync(
	int maxMessages,
	AsyncCompletedEventHandler completedCallback,
	Object userState
)
Visual Basic
Public Sub RefreshFaxCacheAsync ( _
	maxMessages As Integer, _
	completedCallback As AsyncCompletedEventHandler, _
	userState As Object _
)

Parameters

maxMessages
Type: System..::..Int32
The number of messages to refresh, -1 to refresh them all.
completedCallback
Type: System.ComponentModel..::..AsyncCompletedEventHandler
The callback to invoke when the asynchronous operation completes.
userState
Type: System..::..Object
An optional object that contains state information for this request. This object is a way for the caller to store context information which will be provided to the AsyncCompleted event. If no context information is desired then nullNothingnullptra null reference (Nothing in Visual Basic) may be supplied.

Remarks

Any subsequent calls to this method or its synchronous version (RefreshFaxCache(Int32)) within a 5 second period will be rejected with a RateLimitedException. This restriction is per message type, a call to RefreshFaxCacheAsync(Int32, AsyncCompletedEventHandler, Object) followed by a call to RefreshVoicemailCache(Int32) or RefreshVoicemailCacheAsync(Int32, AsyncCompletedEventHandler, Object) within a 5 second period will be successful.

Remarks

When completed, the completedCallback delegate is invoked on a thread appropriate to the application-model, such as the GUI thread in a UI application. The Error property of the AsyncCompletedEventArgs-derived object passed to the delegate will contain any exceptions thrown while executing the asynchronous task. See the synchronous version of this method for more detailed error information. For more information on async method calls, see How Async Calls Work.

Version Information

Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.

See Also