openfloor.envelope

class openfloor.envelope.Conversant(identification, persistentState=<factory>)

Bases: JsonSerializableDataclass

Represents a conversant in the conversation

classmethod from_dict(data)

Create a Conversant instance from a dictionary

Return type:

Conversant

identification: Identification

persistentState: PersistentState

class openfloor.envelope.Conversation(id=None, conversants=<factory>)

Bases: JsonSerializableDataclass

Represents the conversation section of an Open Floor message envelope

conversants: List[Conversant]

classmethod from_dict(data)

Create a Conversation instance from a dictionary

Return type:

Conversation

id: Optional[str] = None

class openfloor.envelope.Envelope(conversation=<factory>, sender=<factory>, schema=<factory>, events=<factory>)

Bases: JsonSerializableDataclass

Represents the root Open Floor message envelope

conversation: Conversation

events: List[Event]

classmethod from_dict(data)

Create an OpenFloor instance from a dictionary

Return type:

Envelope

classmethod from_file(filename, as_payload=False, **kwargs)

Create from JSON file, optionally unwrapped from a payload

Return type:

Envelope

classmethod from_json(json_str, as_payload=False, **kwargs)

Create from JSON string, optionally unwrapped from a payload

Return type:

Envelope

schema: Schema

sender: Sender

to_file(filename, as_payload=False, **kwargs)

Save to JSON file, optionally wrapped in a payload

Return type:

None

to_json(as_payload=False, **kwargs)

Convert to JSON string, optionally wrapped in a payload

Return type:

str

class openfloor.envelope.Event(eventType, to=None, reason=None, parameters=<factory>)

Bases: JsonSerializableDataclass

Represents an event in the events section of an Open Floor message envelope

eventType: str

classmethod from_dict(data)

Create an Event instance from a dictionary

Return type:

Event

parameters: Parameters

reason: Optional[str] = None

to: Optional[To] = None

class openfloor.envelope.Parameters(*args, **kwargs)

Bases: JsonSerializableDict

Represents a dictionary of parameters that can be serialized to JSON

class openfloor.envelope.Payload(openFloor)

Bases: JsonSerializableDataclass

Represents a payload containing an Open Floor message envelope

classmethod from_dict(data)

Create a Payload instance from a dictionary

Return type:

Payload

openFloor: Envelope

class openfloor.envelope.PersistentState(*args, **kwargs)

Bases: JsonSerializableDict

Represents the persistent state of a conversant that can be serialized to JSON

class openfloor.envelope.Schema(version='1.0.0', url=None)

Bases: JsonSerializableDataclass

Represents the schema section of an Open Floor message envelope

url: Optional[str] = None

version: str = '1.0.0'

class openfloor.envelope.Sender(speakerUri, serviceUrl=None)

Bases: JsonSerializableDataclass

Represents the sender section of an Open Floor message envelope

serviceUrl: Optional[str] = None

speakerUri: str

class openfloor.envelope.To(speakerUri=None, serviceUrl=None, private=False)

Bases: JsonSerializableDataclass

Represents the ‘to’ section of an event

private: bool = False

serviceUrl: Optional[str] = None

speakerUri: Optional[str] = None