UseChatStorageResult

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

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:324

Clear all queued operations without writing them.

Returns

void

conversationId

conversationId: string | null

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

Inherited from

BaseUseChatStorageResult.conversationId

createConversation()

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

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

Parameters

Parameter	Type
`options?`	`CreateConversationOptions`

Returns

Promise<StoredConversation>

Inherited from

BaseUseChatStorageResult.createConversation

createMemoryEngineTool()

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

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

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

Parameter	Type	Description
`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:302

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

Parameters

Parameter	Type
`options?`	`MemoryVaultToolOptions`

Returns

ToolConfig

createRecallTool()

createRecallTool: (toolOptions?: RecallToolOptions, callbacks?: RecallToolCallbacks) => ToolConfig

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

Create the unified recall tool — single chat-completion tool that searches both vault facts and conversation chunks via recall(). Replaces the legacy createMemoryEngineTool / vault search pair.

Parameters

Parameter	Type
`toolOptions?`	`RecallToolOptions`
`callbacks?`	`RecallToolCallbacks`

Returns

ToolConfig

deleteConversation()

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

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

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<boolean>

Inherited from

BaseUseChatStorageResult.deleteConversation

deleteVaultMemory()

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

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

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

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<boolean>

flushQueue()

flushQueue: () => Promise<FlushResult>

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

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:786

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<StoredConversation | null>

Inherited from

BaseUseChatStorageResult.getConversation

getConversations()

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

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

Returns

Promise<StoredConversation[]>

Inherited from

BaseUseChatStorageResult.getConversations

getMessages()

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

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

Parameters

Parameter	Type
`conversationId`	`string`

Returns

Promise<StoredMessage[]>

Inherited from

BaseUseChatStorageResult.getMessages

getVaultMemories()

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

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

Get all vault memories for context injection.

Parameters

Parameter	Type
`options?`	`object`
`options.scopes?`	`string`[]

Returns

Promise<StoredVaultMemory[]>

isLoading

isLoading: boolean

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

Inherited from

BaseUseChatStorageResult.isLoading

queueStatus

queueStatus: QueueStatus

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

Current status of the write queue.

sendMessage()

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

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

Send a message and automatically store it (Expo version)

Parameters

Parameter	Type
`args`	`SendMessageWithStorageArgs`

Returns

Promise<BaseSendMessageWithStorageResult>

setConversationId()

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

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

Parameters

Parameter	Type
`id`	`string` \| `null`

Returns

void

Inherited from

BaseUseChatStorageResult.setConversationId

stop()

stop: () => void

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

Returns

void

Inherited from

BaseUseChatStorageResult.stop

updateConversationPinned()

updateConversationPinned: (id: string, pinned: boolean) => Promise<boolean>

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

Parameters

Parameter	Type
`id`	`string`
`pinned`	`boolean`

Returns

Promise<boolean>

Inherited from

BaseUseChatStorageResult.updateConversationPinned

updateConversationTitle()

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

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

Parameters

Parameter	Type
`id`	`string`
`title`	`string`

Returns

Promise<boolean>

Inherited from

BaseUseChatStorageResult.updateConversationTitle