AgoraChatFileMessageBody Class Reference

#import <AgoraChatFileMessageBody.h>

Inheritance diagram for AgoraChatFileMessageBody:

Instance Methods
(instancetype _Nonnull)	- initWithLocalPath:displayName:
(instancetype _Nonnull)	- initWithData:displayName:

Properties
NSString *	displayName
NSString *	localPath
NSString *	remotePath
NSString *	secretKey
long long	fileLength
AgoraChatDownloadStatus	downloadStatus
Properties inherited from AgoraChatMessageBody
AgoraChatMessageBodyType	type
NSUInteger	operationTime
NSString *	operatorId
NSUInteger	operatorCount

Detailed Description

The file message body.

Method Documentation

initWithData:displayName:

- (instancetype _Nonnull) initWithData:		(NSData *_Nullable)	aData
displayName:		(NSString *_Nullable)	aDisplayName

Initializes a file message instance.

Parameters

aData	The data of the attachment file.
aDisplayName	The display name of the attachment.

@Result The file message instance.

initWithLocalPath:displayName:

- (instancetype _Nonnull) initWithLocalPath:		(NSString *_Nullable)	aLocalPath
displayName:		(NSString *_Nullable)	aDisplayName

Initializes a file message instance.

Parameters

aLocalPath	The path of the file attachment in the local device.
aDisplayName	The display name of the file attachment.

Returns

The file message instance.

Property Documentation

displayName

- (NSString*) displayName

readwritenonatomiccopy

The display name of the attachment.

downloadStatus

- (AgoraChatDownloadStatus) downloadStatus

readwritenonatomicassign

The downloading status of the attachment.

fileLength

- (long long) fileLength

readwritenonatomicassign

The data length (bytes) of the attachment.

localPath

- (NSString*) localPath

readwritenonatomiccopy

The path of the attachment on the local device.

remotePath

- (NSString*) remotePath

readwritenonatomiccopy

The path of the attachment in the server.

secretKey

- (NSString*) secretKey

readwritenonatomiccopy

The secret key for downloading the message attachment.

---

The documentation for this class was generated from the following file:

• AgoraChat.framework/Headers/AgoraChatFileMessageBody.h