ZMVideoSDKReceiveFile Class Reference

Represents a file being received in the session. More...

#include <ZMVideoSDKSession.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- startReceive:
	Starts receive the file.
(ZMVideoSDKErrors)	- cancelReceive
	Cancels receive the file.

Properties
time_t	timeStamp
	The file transfer's timestamp.
BOOL	isSendToAll
	Determines whether the file transfer is send to all.
unsigned long long	fileSize
	The file size of the file transfer.
NSString *	fileName
	The file name of the file transfer.
ZMVideoSDKFileStatus *	status
	The file transfer's status.
ZMVideoSDKUser *_Nullable	sender
	The file transfer's sender.

Detailed Description

Represents a file being received in the session.

Definition at line 91 of file ZMVideoSDKSession.h.

Method Documentation

cancelReceive

- (ZMVideoSDKErrors) cancelReceive

Cancels receive the file.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

startReceive:

- (ZMVideoSDKErrors) startReceive:

(NSString *)

downloadPath

Starts receive the file.

Parameters

downloadPath

The download path. Pass the complete path, including the file name and file format.

Returns

If the function succeeds, it returns ZMVideoSDKErrors_Success. Otherwise, this function returns an error.

Property Documentation

fileName

- (NSString*) fileName

readnonatomiccopy

The file name of the file transfer.

Definition at line 107 of file ZMVideoSDKSession.h.

fileSize

- (unsigned long long) fileSize

readnonatomicassign

The file size of the file transfer.

Definition at line 103 of file ZMVideoSDKSession.h.

isSendToAll

- (BOOL) isSendToAll

readnonatomicassign

Determines whether the file transfer is send to all.

Definition at line 99 of file ZMVideoSDKSession.h.

sender

- (ZMVideoSDKUser* _Nullable) sender

readnonatomicassign

The file transfer's sender.

Definition at line 115 of file ZMVideoSDKSession.h.

status

- (ZMVideoSDKFileStatus*) status

readnonatomicretain

The file transfer's status.

Definition at line 111 of file ZMVideoSDKSession.h.

timeStamp

- (time_t) timeStamp

readnonatomicassign

The file transfer's timestamp.

Definition at line 95 of file ZMVideoSDKSession.h.