Meeting SDK for iOS API Reference
Loading...
Searching...
No Matches
MobileRTCFileReceiver Class Reference

A class for file receiver. More...

#include <MobileRTCMeetingChat.h>

Inherits NSObject.

Instance Methods

(NSInteger) - getSenderUserId
 Gets the file sender's user ID.
 
(MobileRTCSDKError- cancelReceive
 Cancels the file receive.
 
(MobileRTCSDKError- startReceive:
 Starts receiving the file.
 

Properties

MobileRTCFileTransferInfotransferInfo
 The basic information of the transfer file.
 

Detailed Description

A class for file receiver.

Definition at line 89 of file MobileRTCMeetingChat.h.

Method Documentation

◆ cancelReceive

- (MobileRTCSDKError) cancelReceive

Cancels the file receive.

Returns
The error type of the cancel action.

◆ getSenderUserId

- (NSInteger) getSenderUserId

Gets the file sender's user ID.

Returns
The sender user ID. -1 specifies an internal error getting the user ID.

◆ startReceive:

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

Starts receiving the file.

Parameters
pathThe path to receive the file.
Returns
The error type of the start receive action.

Property Documentation

◆ transferInfo

- (MobileRTCFileTransferInfo*) transferInfo
readwritenonatomicstrong

The basic information of the transfer file.

Definition at line 94 of file MobileRTCMeetingChat.h.