Skip to Content

UseChatStorageResult

Defined in: src/expo/useChatStorage.ts:266 

Result returned by useChatStorage hook (Expo version)

Extends base result with Expo-specific sendMessage signature.

Extends

  • BaseUseChatStorageResult

Properties

clearQueue()

clearQueue: () => void

Defined in: src/expo/useChatStorage.ts:300 

Clear all queued operations without writing them.

Returns

void


conversationId

conversationId: string | null

Defined in: src/lib/db/chat/types.ts:718 

Inherited from

BaseUseChatStorageResult.conversationId


createConversation()

createConversation: (options?: CreateConversationOptions) => Promise<StoredConversation>

Defined in: src/lib/db/chat/types.ts:720 

Parameters

ParameterType

options?

CreateConversationOptions

Returns

Promise<StoredConversation>

Inherited from

BaseUseChatStorageResult.createConversation


createMemoryEngineTool()

createMemoryEngineTool: (searchOptions?: Partial<MemoryEngineSearchOptions>) => ToolConfig

Defined in: src/expo/useChatStorage.ts:285 

Create a memory engine tool for LLM to search past conversations. The tool is pre-configured with the hook’s storage context and auth.

Parameters

ParameterTypeDescription

searchOptions?

Partial<MemoryEngineSearchOptions>

Optional search configuration (limit, minSimilarity, etc.)

Returns

ToolConfig

A ToolConfig that can be passed to sendMessage’s clientTools

Example

const memoryTool = createMemoryEngineTool({ limit: 5 }); await sendMessage({ messages: [...], clientTools: [memoryTool], });

createMemoryVaultTool()

createMemoryVaultTool: (options?: MemoryVaultToolOptions) => ToolConfig

Defined in: src/expo/useChatStorage.ts:288 

Create a memory vault tool pre-configured with hook’s vault context and encryption.

Parameters

ParameterType

options?

MemoryVaultToolOptions

Returns

ToolConfig


deleteConversation()

deleteConversation: (id: string) => Promise<boolean>

Defined in: src/lib/db/chat/types.ts:724 

Parameters

ParameterType

id

string

Returns

Promise<boolean>

Inherited from

BaseUseChatStorageResult.deleteConversation


deleteVaultMemory()

deleteVaultMemory: (id: string) => Promise<boolean>

Defined in: src/expo/useChatStorage.ts:294 

Delete a vault memory by its ID (soft delete).

Parameters

ParameterType

id

string

Returns

Promise<boolean>


flushQueue()

flushQueue: () => Promise<FlushResult>

Defined in: src/expo/useChatStorage.ts:297 

Manually flush all queued operations for the current wallet.

Returns

Promise<FlushResult>


getConversation()

getConversation: (id: string) => Promise<StoredConversation | null>

Defined in: src/lib/db/chat/types.ts:721 

Parameters

ParameterType

id

string

Returns

Promise<StoredConversation | null>

Inherited from

BaseUseChatStorageResult.getConversation


getConversations()

getConversations: () => Promise<StoredConversation[]>

Defined in: src/lib/db/chat/types.ts:722 

Returns

Promise<StoredConversation[]>

Inherited from

BaseUseChatStorageResult.getConversations


getMessages()

getMessages: (conversationId: string) => Promise<StoredMessage[]>

Defined in: src/lib/db/chat/types.ts:725 

Parameters

ParameterType

conversationId

string

Returns

Promise<StoredMessage[]>

Inherited from

BaseUseChatStorageResult.getMessages


getVaultMemories()

getVaultMemories: (options?: object) => Promise<StoredVaultMemory[]>

Defined in: src/expo/useChatStorage.ts:291 

Get all vault memories for context injection.

Parameters

ParameterType

options?

object

options.scopes?

string[]

Returns

Promise<StoredVaultMemory[]>


isLoading

isLoading: boolean

Defined in: src/lib/db/chat/types.ts:716 

Inherited from

BaseUseChatStorageResult.isLoading


queueStatus

queueStatus: QueueStatus

Defined in: src/expo/useChatStorage.ts:303 

Current status of the write queue.


sendMessage()

sendMessage: (args: SendMessageWithStorageArgs) => Promise<BaseSendMessageWithStorageResult>

Defined in: src/expo/useChatStorage.ts:268 

Send a message and automatically store it (Expo version)

Parameters

ParameterType

args

SendMessageWithStorageArgs

Returns

Promise<BaseSendMessageWithStorageResult>


setConversationId()

setConversationId: (id: string | null) => void

Defined in: src/lib/db/chat/types.ts:719 

Parameters

ParameterType

id

string | null

Returns

void

Inherited from

BaseUseChatStorageResult.setConversationId


stop()

stop: () => void

Defined in: src/lib/db/chat/types.ts:717 

Returns

void

Inherited from

BaseUseChatStorageResult.stop


updateConversationTitle()

updateConversationTitle: (id: string, title: string) => Promise<boolean>

Defined in: src/lib/db/chat/types.ts:723 

Parameters

ParameterType

id

string

title

string

Returns

Promise<boolean>

Inherited from

BaseUseChatStorageResult.updateConversationTitle

Last updated on