ChatRoomSession.BeginDownloadFile Method

Reference

Definition

Namespace:: Microsoft.Rtc.Collaboration.PersistentChat

Assembly:: Microsoft.Rtc.Collaboration.PersistentChat.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Downloads a file from the chat room.

public:
 IAsyncResult ^ BeginDownloadFile(Microsoft::Rtc::Collaboration::PersistentChat::ChatRoomFileDownloadJob ^ job, AsyncCallback ^ userCallback, System::Object ^ state);

public IAsyncResult BeginDownloadFile (Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob job, AsyncCallback userCallback, object state);

member this.BeginDownloadFile : Microsoft.Rtc.Collaboration.PersistentChat.ChatRoomFileDownloadJob * AsyncCallback * obj -> IAsyncResult

Public Function BeginDownloadFile (job As ChatRoomFileDownloadJob, userCallback As AsyncCallback, state As Object) As IAsyncResult

Parameters

job: ChatRoomFileDownloadJob

The file download job.

userCallback: AsyncCallback

The callback method to be invoked when this asynchronous operation completes.

state: Object

An object to be passed back to the callback.

Returns

IAsyncResult

An IAsyncResult object that references this operation.

Exceptions

ArgumentNullException

job is null.

ChatServerConnectionException

The PersistentChatEndpoint is not established.

ChatRoomSessionStateException

The State is not Established.

InvalidOperationException

The chat server connection is not in a valid state to send the command or job contains invalid data. The exception contains detailed information about the error.

RealTimeException

The PersistentChatEndpoint encountered an error communicating with the persistent chat server.

SoapException

The persistent chat web service encountered an error processing the request.

Remarks

This request will be processed asynchronously. Call EndDownloadFile(IAsyncResult) to complete this asynchronous operation.

Applies to