symphony.bdk.core.symphony_bdk.SymphonyBdk#

class symphony.bdk.core.symphony_bdk.SymphonyBdk(config)#

Bases: object

BDK entry point

__init__(config)#

Methods

__init__(config)

activities()

Get the ActivityRegistry from the BDK entry point.

app_authenticator()

Get the extension app authenticator.

applications()

Get the ApplicationService from the BDK entry point.

bot_session()

Get the Bot authentication session.

close_clients()

Close all the existing api clients created by the api client factory.

connections()

Get the ConnectionService from the BDK entry point.

datafeed()

Get the Datafeed loop from the BDK entry point.

datahose()

return

extensions()

return

The ExtensionService instance

health()

Get the HealthService from the BDK entry point.

messages()

Get the MessageService from the BDK entry point.

obo([user_id, username])

Get the Obo authentication session.

obo_services(obo_session)

Return the entry point of all OBO-enabled services and endpoints.

presence()

Get the PresenceService from the BDK entry point.

sessions()

Get the SessionService from the BDK entry point.

signals()

Get the SignalService from the BDK entry point.

streams()

Get the StreamService from the BDK entry point.

users()

Get the UserService from the BDK entry point.

activities() symphony.bdk.core.activity.registry.ActivityRegistry#

Get the ActivityRegistry from the BDK entry point.

Returns

The ActivityRegistry instance.

app_authenticator() symphony.bdk.core.auth.ext_app_authenticator.ExtensionAppAuthenticator#

Get the extension app authenticator.

Returns

a new instance of symphony.bdk.core.auth.ext_app_authenticator.ExtensionAppAuthenticator

applications() symphony.bdk.core.service.application.application_service.ApplicationService#

Get the ApplicationService from the BDK entry point.

Returns

The ApplicationService instance.

bot_session() symphony.bdk.core.auth.auth_session.AuthSession#

Get the Bot authentication session. If the bot is not authenticated yet, perform the authentication for a new session.

Returns

The bot authentication session.

async close_clients()#

Close all the existing api clients created by the api client factory.

connections() symphony.bdk.core.service.connection.connection_service.ConnectionService#

Get the ConnectionService from the BDK entry point.

Returns

The ConnectionService instance.

datafeed() symphony.bdk.core.service.datafeed.abstract_datafeed_loop.AbstractDatafeedLoop#

Get the Datafeed loop from the BDK entry point.

Returns

The Datafeed Loop instance.

datahose() symphony.bdk.core.service.datafeed.abstract_datahose_loop.AbstractDatahoseLoop#
Returns

extensions() symphony.bdk.core.extension.ExtensionService#
Returns

The ExtensionService instance

health() symphony.bdk.core.service.health.health_service.HealthService#

Get the HealthService from the BDK entry point.

Returns

The HealthService instance.

messages() symphony.bdk.core.service.message.message_service.MessageService#

Get the MessageService from the BDK entry point.

Returns

The MessageService instance.

obo(user_id: int = None, username: str = None) symphony.bdk.core.auth.auth_session.OboAuthSession#

Get the Obo authentication session.

Returns

The obo authentication session

obo_services(obo_session: symphony.bdk.core.auth.auth_session.OboAuthSession) symphony.bdk.core.service.obo_services.OboServices#

Return the entry point of all OBO-enabled services and endpoints.

Parameters

obo_session – the obo_session to use.

Returns

a new OboServices instance.

presence() symphony.bdk.core.service.presence.presence_service.PresenceService#

Get the PresenceService from the BDK entry point.

Returns

The PresenceService instance.

sessions() symphony.bdk.core.service.session.session_service.SessionService#

Get the SessionService from the BDK entry point.

Returns

The SessionService instance.

signals() symphony.bdk.core.service.signal.signal_service.SignalService#

Get the SignalService from the BDK entry point.

Returns

The SignalService instance.

streams() symphony.bdk.core.service.stream.stream_service.StreamService#

Get the StreamService from the BDK entry point.

Returns

The StreamService instance.

users() symphony.bdk.core.service.user.user_service.UserService#

Get the UserService from the BDK entry point.

Returns

The UserService instance.