Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Mesh SDK v0.28.0 file transfer methods: send files, images, voice and video notes, inspect transfer progress and cancel a transfer.
OfflineProtocol from @offline-protocol/mesh-sdk. These signatures match v0.28.0. Read the integration guide for prerequisites and complete usage.
sendMediasendFilesendImagesendVoiceNotesendVideoNotesendVideogetFileProgresscancelFileTransferprocessFileChunkfinalizeFilesendMedia(params: SendMediaParams): Promise<string>
sendFile(params: SendFileParams): Promise<string>
sendImage(recipient: string, fileData: string, fileName: string, metadata?: MediaMetadata): Promise<string>
sendVoiceNote(recipient: string, fileData: string, fileName: string, metadata?: MediaMetadata): Promise<string>
sendVideoNote(recipient: string, fileData: string, fileName: string, metadata?: MediaMetadata): Promise<string>
sendVideo(recipient: string, fileData: string, fileName: string, metadata?: MediaMetadata): Promise<string>
getFileProgress(fileId: string): Promise<FileProgress | null>
cancelFileTransfer(fileId: string): Promise<boolean>
processFileChunk(fileId: string, chunkIndex: number, totalChunks: number, fileSize: number, fileName: string, fileChecksum: string, data: number[]): Promise<void>
finalizeFile(fileId: string): Promise<void>
export interface SendMediaParams {
recipient: string;
fileData: string;
fileName: string;
contentType: ContentType;
mediaMetadata?: MediaMetadata;
caption?: string;
replyToMsg?: string;
replyContext?: ReplyContext;
forwardInfo?: ForwardInfo;
fileId?: string;
appId?: string;
}
export enum ContentType {
Text = 'text',
Image = 'image',
Video = 'video',
Audio = 'audio',
VoiceNote = 'voice_note',
VideoNote = 'video_note',
File = 'file',
FileChunk = 'file_chunk',
Poll = 'poll',
}
export interface MediaMetadata {
mimeType: string;
fileName: string;
fileSize: number;
durationMs?: number;
width?: number;
height?: number;
thumbnailBase64?: string;
mediaId?: string;
downloadUrl?: string;
thumbnailUrl?: string;
encryptionKey?: string;
iv?: string;
ciphertextHash?: string;
stickerProvider?: string;
stickerRemoteId?: string;
stickerKind?: string;
}
export interface ReplyContext {
sender: string;
text: string;
timestamp?: number;
reply_media_label?: string;
reply_content_type?: string;
}
export interface ForwardInfo {
original_sender: string;
original_message_id: string;
original_timestamp: number;
forward_count: number;
}
export interface SendFileParams {
recipient: string;
fileData: string;
fileName: string;
}
export interface FileProgress {
file_id: string;
chunks_sent: number;
total_chunks: number;
percentage: number;
}