Video SDK for iOS API Reference
Loading...
Searching...
No Matches
ZoomVideoSDKReceiveFile Class Reference

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

#include <ZoomVideoSDKFileTranserHandle.h>

Inherits ZoomVideoSDKFileTransferBaseInfo.

Instance Methods

(ZoomVideoSDKUser *_Nullable) - getSender
 Gets the sender of the file.
 
(ZoomVideoSDKError- cancelReceive
 Cancels receiving the file.
 
(ZoomVideoSDKError- startReceive:
 Starts receiving the file.
 
- Instance Methods inherited from ZoomVideoSDKFileTransferBaseInfo
(NSTimeInterval) - getTimeStamp
 Gets the timestamp.
 
(BOOL) - isSendToAll
 Determines whether the file is sent to all users.
 
(NSUInteger) - getFileSize
 Gets the file size.
 
(NSString *_Nullable) - getFileName
 Gets the file name.
 
(ZoomVideoSDKFileStatus *_Nullable) - getStatus
 Gets the file transfer status.
 

Detailed Description

Represents a file being received in the session.

Definition at line 99 of file ZoomVideoSDKFileTranserHandle.h.

Method Documentation

◆ cancelReceive

- (ZoomVideoSDKError) cancelReceive

Cancels receiving the file.

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

◆ getSender

- (ZoomVideoSDKUser *_Nullable) getSender

Gets the sender of the file.

Returns
If the function succeeds, it returns the sender. Otherwise, this function fails and returns nil.

◆ startReceive:

- (ZoomVideoSDKError) startReceive: (NSString *_Nullable) path

Starts receiving the file.

Parameters
pathThe path to save the file.
Returns
If the function succeeds, it returns Errors_Success. Otherwise, this function returns an error.