Module types

Expand description

Type definitions for iFlow SDK

This module contains all the type definitions used throughout the iFlow SDK, including configuration options and message types.

Structs§

AgentInfo: Agent information
EnvVariable: An environment variable to set when launching an MCP server.
Error: JSON-RPC error object.
ErrorMessageDetails: Error message details
FileAccessConfig: Configuration for file access
IFlowOptions: Configuration options for iFlow SDK
Icon: Icon for tool calls
ImageContent: An image provided to or from an LLM.
LoggingConfig: Configuration for logging
Plan: An execution plan for accomplishing complex tasks.
PlanEntry: Plan entry for task planning
ProcessConfig: Configuration for process management
SessionId: A unique identifier for a conversation session between a client and agent.
TextContent: Text provided to or from an LLM.
ToolCall: Represents a tool call that the language model has requested.
ToolCallConfirmation: Tool call confirmation details
ToolCallContent: Tool call content
ToolCallLocation: File location for a tool call
ToolCallMessage: Tool call message
ToolCallUpdate: An update to an existing tool call.
UserMessage: User message
WebSocketConfig: Configuration for WebSocket connection

ContentBlock: Content blocks represent displayable information in the Agent Client Protocol.
McpServer: Configuration for connecting to an MCP (Model Context Protocol) server.
Message: Message types for communication with iFlow
PermissionMode: Permission mode for tool calls
PlanPriority: Plan entry priority levels
PlanStatus: Plan entry status
StopReason: Reasons why an agent stops processing a prompt turn.
ToolCallStatus: Tool call status
UserMessageChunk: User message chunk