Skip to content

participant

Participant service module

Classes

ParticipantService 

ParticipantService(
    sa_session: SASession, neo4j_session: NJSession
)

Bases: BaseService

Participant service layer

Attributes

agent_service instance-attribute 
agent_service = AgentService(
    sa_session=sa_session, neo4j_session=neo4j_session
)
participant_dao instance-attribute 
participant_dao = ParticipantDao(session=sa_session)
user_service instance-attribute 
user_service = UserService(
    sa_session=sa_session, neo4j_session=neo4j_session
)

Functions

get_participant 
get_participant(
    *,
    namespace: str,
    participant: str,
    error_deleted: bool = True,
    error_disabled: bool = True
) -> Union[User, Agent]

Retrieve a participant from the specified namespace.

Parameters:

  • namespace (str) –

    The namespace in which to search for the participant.

  • participant (str) –

    The identifier of the participant to retrieve.

  • error_deleted (bool, default: True ) –

    Whether to raise an error if the participant is deleted. Defaults to True.

  • error_disabled (bool, default: True ) –

    Whether to raise an error if the participant is disabled. Defaults to True.

Returns:

  • Union[User, Agent] –

    Union[orm.User, orm.Agent]: The retrieved participant, either a User or an Agent.

Raises:

  • ServiceError –

    If the participant is not found, is deleted, is disabled, or has an invalid participant type.