SDK Documentation

Audience: two groups, not one. Developer API, Actor Interface, Attributes and Buckets, and Authenticated Views are core reference for any application developer using ActingWeb – the property/attribute/ trust/subscription APIs your hooks call every day, just documented in more depth than the quickstart guides. Handler Architecture, Custom Framework Integration, and Advanced Topics are for developers extending ActingWeb itself or integrating a framework it doesn’t ship support for – skip these unless you’re doing that.

This section provides in-depth documentation for advanced users and developers building on top of ActingWeb.

Contents

• Developer API
  • Overview
  • ActorInterface
  • PropertyStore
  • TrustManager
  • SubscriptionManager
  • Authenticated Views
  • Async Operations
  • Best Practices
  • See Also
• Authenticated Views
  • Overview
  • Access Modes
  • AuthenticatedActorView
  • Handler Integration
  • Trust Relationships and Permissions
  • Context Properties
  • Best Practices
  • See Also
• Handler Architecture
  • Overview
  • Handler Hierarchy
  • Handler Lifecycle
  • Handler Responsibilities
  • Developer API Integration
  • Hook Execution
  • Authentication Flow
  • Error Handling
  • Testing Handlers
  • See Also
• Async Operations
  • Overview
  • Async Methods
  • Usage Examples
  • Implementation Details
  • Best Practices
  • Performance Considerations
  • See Also
• Custom Framework Integration
  • Overview
  • AWWebObj Interface
  • Handler Invocation
  • URL Routing
  • Django Integration Example
  • Starlette Integration Example
  • BaseActingWebIntegration
  • Handler Arguments
  • See Also
• ActorInterface
  • Overview
  • Quick Start
  • Creating and Loading Actors
  • Properties (Key–Value)
  • Trust and Subscriptions
  • Next
• Advanced Topics
  • Access Core Components
  • Custom Framework Integration
  • Error Handling
  • Custom Route Authentication
  • Async Peer Communication
  • Migration
• Attributes and Buckets (Global)
  • Overview
  • Basic Usage
  • Global Storage
  • Atomic Operations (v3.8.2+)
  • Complete Bucket Reference
  • Data Type Details
  • Data Lifecycle and Cleanup
  • Known Issues and Gaps
  • Maintenance Recommendations
  • Client Registry Example
  • Best Practices
  • See Also

Overview

The ActingWeb SDK documentation covers:

Developer API

The high-level interfaces (ActorInterface, PropertyStore, TrustManager, SubscriptionManager) used in hooks and custom code.

Authenticated Views

Permission-enforced access patterns for peer and client access to actor resources.

Handler Architecture

How ActingWeb’s HTTP handlers work internally and delegate to the developer API.

Async Operations

Async variants for peer communication in FastAPI and other async frameworks.

Custom Framework Integration

Integrating ActingWeb with Django, Starlette, or other Python web frameworks.

Actor Interface

Detailed reference for the ActorInterface wrapper class.

Advanced Topics

Database operations, migrations, and low-level internals.

Attributes and Buckets

A second, app-facing storage API alongside properties – for data that should never be reachable through a trust relationship (secrets, service credentials, internal state), not an internal-only mechanism.

Learning Path

For SDK developers, we recommend this order:

1. Developer API - Understand the core interfaces

2. Authenticated Views - Learn permission enforcement

3. Handler Architecture - See how handlers use the developer API

4. Async Operations - Master async patterns for peer communication

5. Custom Framework - Build integrations for other frameworks

Prerequisites

Before diving into SDK documentation, you should:

• Complete the Getting Started

• Understand Trust Manager

• Be familiar with Hooks

See Also

• Getting Started - Getting started guide

• Guides - Feature guides

• API Reference - API reference