ZMVideoSDKReceiveFile Class Reference

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

#include <ZMVideoSDKSession.h>

Inherits NSObject.

Instance Methods
(ZMVideoSDKErrors)	- startReceive:
	Start receive the file.
(ZMVideoSDKErrors)	- cancelReceive
	Cancel receive the file.

Properties
time_t	timeStamp
	The timestamp of the file transfer.
BOOL	isSendToAll
	Determine 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 status of the file transfer.
ZMVideoSDKUser *_Nullable	sender
	The sender of the file transfer.

Detailed Description

Represents a file being received in the session.

Definition at line 91 of file ZMVideoSDKSession.h.

Method Documentation

cancelReceive

- (ZMVideoSDKErrors) cancelReceive

Cancel receive the file.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

startReceive:

- (ZMVideoSDKErrors) startReceive:

(NSString *)

downloadPath

Start receive the file.

Parameters

downloadPath

The download path, you need to pass the complete path, including the file name and file format.

Returns

If the function succeeds, it will return ZMVideoSDKErrors_Success.

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

Determine whether the file transfer is send to all.

Definition at line 99 of file ZMVideoSDKSession.h.

sender

- (ZMVideoSDKUser* _Nullable) sender

readnonatomicassign

The sender of the file transfer.

Definition at line 115 of file ZMVideoSDKSession.h.

status

- (ZMVideoSDKFileStatus*) status

readnonatomicretain

The status of the file transfer.

Definition at line 111 of file ZMVideoSDKSession.h.

timeStamp

- (time_t) timeStamp

readnonatomicassign

The timestamp of the file transfer.

Definition at line 95 of file ZMVideoSDKSession.h.