Video SDK for MacOS API Reference
Loading...
Searching...
No Matches
ZMVideoSDKSendFile Class Reference

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

#include <ZMVideoSDKSession.h>

Inherits NSObject.

Instance Methods

(ZMVideoSDKErrors- cancelSend
 Cancels the file transfer.
 

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.
 
ZMVideoSDKFileStatusstatus
 The file transfer's status.
 
ZMVideoSDKUser *_Nullable receiver
 The file transfer's receiver.
 

Detailed Description

Represents a file being sent in the session.

Definition at line 53 of file ZMVideoSDKSession.h.

Method Documentation

◆ cancelSend

- (ZMVideoSDKErrors) cancelSend

Cancels the file transfer.

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 69 of file ZMVideoSDKSession.h.

◆ fileSize

- (unsigned long long) fileSize
readnonatomicassign

The file size of the file transfer.

Definition at line 65 of file ZMVideoSDKSession.h.

◆ isSendToAll

- (BOOL) isSendToAll
readnonatomicassign

Determines whether the file transfer is send to all.

Definition at line 61 of file ZMVideoSDKSession.h.

◆ receiver

- (ZMVideoSDKUser* _Nullable) receiver
readnonatomicassign

The file transfer's receiver.

Definition at line 77 of file ZMVideoSDKSession.h.

◆ status

- (ZMVideoSDKFileStatus*) status
readnonatomicretain

The file transfer's status.

Definition at line 73 of file ZMVideoSDKSession.h.

◆ timeStamp

- (time_t) timeStamp
readnonatomicassign

The file transfer's timestamp.

Definition at line 57 of file ZMVideoSDKSession.h.