openfloor.events

class openfloor.events.ByeEvent(eventType='bye', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents an agent leaving the conversation

eventType: str = 'bye'

parameters: Parameters

class openfloor.events.ContextEvent(eventType='context', to=None, reason=None, parameters=<factory>, dialogHistory=None)

Bases: Event

Represents a context event providing additional information to recipient agents

dialogHistory: Optional[DialogHistory] = None

eventType: str = 'context'

parameters: Parameters

class openfloor.events.DeclineInviteEvent(eventType='declineInvite', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents declining an invitation to join the conversation

eventType: str = 'declineInvite'

class openfloor.events.GetManifestsEvent(eventType='getManifests', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents a request for agent manifests

eventType: str = 'getManifests'

parameters: Parameters

class openfloor.events.GrantFloorEvent(eventType='grantFloor', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents granting the conversational floor to an agent

eventType: str = 'grantFloor'

class openfloor.events.InviteEvent(eventType='invite', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents an invitation for an agent to join the conversation

eventType: str = 'invite'

class openfloor.events.PublishManifestsEvent(eventType='publishManifests', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents publishing agent manifests

eventType: str = 'publishManifests'

parameters: Parameters

class openfloor.events.RequestFloorEvent(eventType='requestFloor', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents a request for the conversational floor

eventType: str = 'requestFloor'

class openfloor.events.RevokeFloorEvent(eventType='revokeFloor', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents revoking the conversational floor from an agent

eventType: str = 'revokeFloor'

class openfloor.events.UninviteEvent(eventType='uninvite', to=None, reason=None, parameters=<factory>)

Bases: Event

Represents removing an agent from the conversation

eventType: str = 'uninvite'

class openfloor.events.UtteranceEvent(eventType='utterance', to=None, reason=None, parameters=<factory>, dialogEvent=None)

Bases: Event

Represents an utterance event in the conversation

dialogEvent: Optional[DialogEvent] = None

eventType: str = 'utterance'

parameters: Parameters