UseFilesResult

Result returned by useFiles hook.

Properties

createBlobUrl()

createBlobUrl: (mediaId: string) => Promise<string | null>

Create a blob URL for a file (auto-managed lifecycle)

Parameters

Parameter	Type
`mediaId`	`string`

Returns

Promise<string | null>

createMedia()

createMedia: (options: CreateMediaOptions) => Promise<StoredMedia>

Defined in: src/react/useFiles.ts:74

Create a new file record

Parameters

Parameter	Type
`options`	`CreateMediaOptions`

Returns

Promise<StoredMedia>

createMediaBatch()

createMediaBatch: (optionsArray: CreateMediaOptions[]) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:76

Create multiple file records in a batch

Parameters

Parameter	Type
`optionsArray`	`CreateMediaOptions`[]

Returns

Promise<StoredMedia[]>

deleteMedia()

deleteMedia: (mediaId: string) => Promise<boolean>

Defined in: src/react/useFiles.ts:90

Soft delete a file record

Parameters

Parameter	Type
`mediaId`	`string`

Returns

Promise<boolean>

deleteMediaByConversation()

deleteMediaByConversation: (conversationId: string) => Promise<number>

Defined in: src/react/useFiles.ts:126

Delete all files for a conversation

Parameters

Parameter	Type
`conversationId`	`string`

Returns

Promise<number>

deleteMediaByMessage()

deleteMediaByMessage: (messageId: string) => Promise<number>

Defined in: src/react/useFiles.ts:128

Delete all files for a message

Parameters

Parameter	Type
`messageId`	`string`

Returns

Promise<number>

getAIGeneratedMedia()

getAIGeneratedMedia: (limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:112

Get AI-generated files

Parameters

Parameter	Type
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getAudio()

getAudio: (limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:104

Get all audio files

Parameters

Parameter	Type
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getDocuments()

getDocuments: (limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:106

Get all documents

Parameters

Parameter	Type
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getImages()

getImages: (limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:100

Get all images

Parameters

Parameter	Type
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getMedia()

getMedia: (filters: MediaFilterOptions) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:96

Get all files with optional filters

Parameters

Parameter	Type
`filters`	`MediaFilterOptions`

Returns

Promise<StoredMedia[]>

getMediaByConversation()

getMediaByConversation: (conversationId: string, limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:108

Get files by conversation

Parameters

Parameter	Type
`conversationId`	`string`
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getMediaById()

getMediaById: (mediaId: string) => Promise<StoredMedia | null>

Defined in: src/react/useFiles.ts:78

Get a file record by its media_id

Parameters

Parameter	Type
`mediaId`	`string`

Returns

Promise<StoredMedia | null>

getMediaByIds()

getMediaByIds: (mediaIds: string[], includeDeleted?: boolean) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:82

Get files by an array of media IDs

Parameters

Parameter	Type
`mediaIds`	`string`[]
`includeDeleted?`	`boolean`

Returns

Promise<StoredMedia[]>

getMediaByMessage()

getMediaByMessage: (messageId: string) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:84

Get files by message ID

Parameters

Parameter	Type
`messageId`	`string`

Returns

Promise<StoredMedia[]>

getMediaByModel()

getMediaByModel: (model: string, limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:116

Get files by AI model

Parameters

Parameter	Type
`model`	`string`
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getMediaByRole()

getMediaByRole: (role: MediaRole, limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:110

Get files by role (user uploads vs AI generated)

Parameters

Parameter	Type
`role`	`MediaRole`
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getMediaBySourceUrl()

getMediaBySourceUrl: (sourceUrl: string) => Promise<StoredMedia | null>

Defined in: src/react/useFiles.ts:80

Get a file record by its source URL

Parameters

Parameter	Type
`sourceUrl`	`string`

Returns

Promise<StoredMedia | null>

getMediaByType()

getMediaByType: (mediaType: MediaType, limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:98

Get files by type

Parameters

Parameter	Type
`mediaType`	`MediaType`
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getMediaCount()

getMediaCount: (mediaType?: MediaType) => Promise<number>

Defined in: src/react/useFiles.ts:122

Get file count

Parameters

Parameter	Type
`mediaType?`	`MediaType`

Returns

Promise<number>

getMediaCountsByType()

getMediaCountsByType: () => Promise<Record<MediaType, number>>

Defined in: src/react/useFiles.ts:124

Get file counts by type

Returns

Promise<Record<MediaType, number>>

getRecentMedia()

getRecentMedia: (limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:118

Get recent files for library homepage

Parameters

Parameter	Type
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getUserUploadedMedia()

getUserUploadedMedia: (limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:114

Get user-uploaded files

Parameters

Parameter	Type
`limit?`	`number`

Returns

Promise<StoredMedia[]>

getVideos()

getVideos: (limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:102

Get all videos

Parameters

Parameter	Type
`limit?`	`number`

Returns

Promise<StoredMedia[]>

hardDeleteMedia()

hardDeleteMedia: (mediaId: string) => Promise<boolean>

Defined in: src/react/useFiles.ts:92

Permanently delete a file record

Parameters

Parameter	Type
`mediaId`	`string`

Returns

Promise<boolean>

isLoading

isLoading: boolean

Defined in: src/react/useFiles.ts:70

Whether files are being loaded

isReady

isReady: boolean

Defined in: src/react/useFiles.ts:68

Whether the file system is ready (database table exists)

readFile()

readFile: (mediaId: string) => Promise<File>

Defined in: src/react/useFiles.ts:132

Read a file from OPFS by its media ID

Parameters

Parameter	Type
`mediaId`	`string`

Returns

Promise<File>

resolveFilePlaceholders()

resolveFilePlaceholders: (content: string) => Promise<string>

Defined in: src/react/useFiles.ts:140

Resolve SDKFILE placeholders in content to blob URLs

Parameters

Parameter	Type
`content`	`string`

Returns

Promise<string>

revokeAllBlobUrls()

revokeAllBlobUrls: () => void

Defined in: src/react/useFiles.ts:138

Revoke all blob URLs (cleanup)

Returns

void

revokeBlobUrl()

revokeBlobUrl: (mediaId: string) => void

Defined in: src/react/useFiles.ts:136

Revoke a specific blob URL

Parameters

Parameter	Type
`mediaId`	`string`

Returns

void

searchMedia()

searchMedia: (query: string, limit?: number) => Promise<StoredMedia[]>

Defined in: src/react/useFiles.ts:120

Search files by name

Parameters

Parameter	Type
`query`	`string`
`limit?`	`number`

Returns

Promise<StoredMedia[]>

updateMedia()

updateMedia: (mediaId: string, options: UpdateMediaOptions) => Promise<StoredMedia | null>

Defined in: src/react/useFiles.ts:86

Update a file record

Parameters

Parameter	Type
`mediaId`	`string`
`options`	`UpdateMediaOptions`

Returns

Promise<StoredMedia | null>

updateMediaMessageIdBatch()

updateMediaMessageIdBatch: (mediaIds: string[], messageId: string) => Promise<number>

Defined in: src/react/useFiles.ts:88

Batch update file records with a messageId

Parameters

Parameter	Type
`mediaIds`	`string`[]
`messageId`	`string`

Returns

Promise<number>