@openfloor/protocol - v0.0.4
    Preparing search index...

    Class ConvenerAgent

    Convener agent with special privileges for managing multi-party conversations Extends BotAgent with floor management capabilities

    const convener = new ConvenerAgent({
      identification: {
        speakerUri: 'tag:example.com,2025:convener',
        serviceUrl: 'https://example.com/convener',
        organization: 'Example Corp',
        conversationalName: 'Convener'
      }
    });

    await convener.grantFloor('tag:example.com,2025:agent1');

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    activeConversation currentContext hasFloor manifest serviceUrl speakerUri

    Methods

    grantFloor inviteAgent off on processEnvelope revokeFloor uninviteAgent

    Constructors

    Accessors

    • get hasFloor(): boolean

      Check if agent currently has the floor

      Returns boolean

    • get serviceUrl(): string

      Get the agent's service URL from the manifest

      Returns string

    • get speakerUri(): string

      Get the agent's speaker URI from the manifest

      Returns string

    Methods

    • Grant the floor to a specific agent

      Parameters

      • speakerUri: string

        URI of agent to grant floor to

      • Optionalreason: string

        Optional reason for granting floor

      Returns GrantFloorEvent

      GrantFloorEvent that can be sent

    • Invite an agent to join the conversation

      Parameters

      • serviceUrl: string

        Service URL of agent to invite

      • OptionalspeakerUri: string

        Optional specific speaker URI

      • Optionalreason: string

        Optional reason for invitation

      Returns InviteEvent

      InviteEvent that can be sent

    • Remove an event handler

      Parameters

      • eventType: keyof AgentEventHandlers

        Type of event

      • handler: (...args: any[]) => Promise<void>

        Handler function to remove

      Returns void

    • Add an event handler for a specific event type

      Parameters

      • eventType: keyof AgentEventHandlers

        Type of event to handle

      • handler: (...args: any[]) => Promise<void>

        Handler function

      Returns void

    • Process an incoming envelope and generate a response This is the main entry point for agent message processing

      Parameters

      • inEnvelope: Envelope

        Incoming envelope to process

      Returns Promise<Envelope>

      Promise resolving to response envelope

    • Revoke the floor from a specific agent

      Parameters

      • speakerUri: string

        URI of agent to revoke floor from

      • Optionalreason: string

        Reason for revoking floor (should include reason token)

      Returns RevokeFloorEvent

      RevokeFloorEvent that can be sent

    • Uninvite an agent from the conversation

      Parameters

      • speakerUri: string

        URI of agent to uninvite

      • Optionalreason: string

        Reason for uninviting (should include reason token)

      Returns UninviteEvent

      UninviteEvent that can be sent

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods