Hide navigation sidebar

Hide table of contents sidebar

Toggle site navigation sidebar

Symphony Python BDK documentation

Toggle table of contents sidebar

Symphony Python BDK documentation

Getting Started
Migration guide
Configuration
Authentication
Datafeed
Datahose
Activity API
Message service
Stream service
Connection service
Application service
Signal service
Presence service
User service
Session service
Health service
Extending the BDK
FAQ

symphony.bdk.core
Toggle child pages in navigation
- symphony.bdk.core.activity
  Toggle child pages in navigation
  - symphony.bdk.core.activity.api
    Toggle child pages in navigation
    - symphony.bdk.core.activity.api.AbstractActivity
    - symphony.bdk.core.activity.api.ActivityContext
  - symphony.bdk.core.activity.command
    Toggle child pages in navigation
  - symphony.bdk.core.activity.exception
    Toggle child pages in navigation
    - symphony.bdk.core.activity.exception.FatalActivityExecutionException
  - symphony.bdk.core.activity.form
    Toggle child pages in navigation
    - symphony.bdk.core.activity.form.FormReplyActivity
    - symphony.bdk.core.activity.form.FormReplyContext
  - symphony.bdk.core.activity.help_command
    Toggle child pages in navigation
    - symphony.bdk.core.activity.help_command.HelpCommand
  - symphony.bdk.core.activity.registry
    Toggle child pages in navigation
    - symphony.bdk.core.activity.registry.ActivityRegistry
  - symphony.bdk.core.activity.user_joined_room
    Toggle child pages in navigation
    - symphony.bdk.core.activity.user_joined_room.UserJoinedRoomActivity
    - symphony.bdk.core.activity.user_joined_room.UserJoinedRoomContext
- symphony.bdk.core.auth
  Toggle child pages in navigation
  - symphony.bdk.core.auth.auth_session
    Toggle child pages in navigation
  - symphony.bdk.core.auth.authenticator_factory
    Toggle child pages in navigation
    - symphony.bdk.core.auth.authenticator_factory.AuthenticatorFactory
  - symphony.bdk.core.auth.bot_authenticator
    Toggle child pages in navigation
  - symphony.bdk.core.auth.exception
    Toggle child pages in navigation
    - symphony.bdk.core.auth.exception.AuthInitializationError
    - symphony.bdk.core.auth.exception.AuthUnauthorizedError
  - symphony.bdk.core.auth.ext_app_authenticator
    Toggle child pages in navigation
  - symphony.bdk.core.auth.jwt_helper
    Toggle child pages in navigation
  - symphony.bdk.core.auth.obo_authenticator
    Toggle child pages in navigation
  - symphony.bdk.core.auth.tokens_repository
    Toggle child pages in navigation
    - symphony.bdk.core.auth.tokens_repository.InMemoryTokensRepository
    - symphony.bdk.core.auth.tokens_repository.TokensRepository
- symphony.bdk.core.client
  Toggle child pages in navigation
  - symphony.bdk.core.client.api_client_factory
    Toggle child pages in navigation
    - symphony.bdk.core.client.api_client_factory.ApiClientFactory
  - symphony.bdk.core.client.trace_id
    Toggle child pages in navigation
- symphony.bdk.core.config
  Toggle child pages in navigation
  - symphony.bdk.core.config.exception
    Toggle child pages in navigation
    - symphony.bdk.core.config.exception.BdkConfigError
    - symphony.bdk.core.config.exception.BotNotConfiguredError
  - symphony.bdk.core.config.loader
    Toggle child pages in navigation
    - symphony.bdk.core.config.loader.BdkConfigLoader
    - symphony.bdk.core.config.loader.BdkConfigParser
  - symphony.bdk.core.config.model
    Toggle child pages in navigation
    - symphony.bdk.core.config.model.bdk_app_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_app_config.BdkAppConfig
    - symphony.bdk.core.config.model.bdk_authentication_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_authentication_config.BdkAuthenticationConfig
    - symphony.bdk.core.config.model.bdk_bot_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_bot_config.BdkBotConfig
    - symphony.bdk.core.config.model.bdk_certificate_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_certificate_config.BdkCertificateConfig
    - symphony.bdk.core.config.model.bdk_client_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_client_config.BdkClientConfig
    - symphony.bdk.core.config.model.bdk_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_config.BdkConfig
    - symphony.bdk.core.config.model.bdk_datafeed_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_datafeed_config.log_dfv1_deprecation
      - symphony.bdk.core.config.model.bdk_datafeed_config.BdkDatafeedConfig
    - symphony.bdk.core.config.model.bdk_datahose_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_datahose_config.BdkDatahoseConfig
    - symphony.bdk.core.config.model.bdk_retry_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_retry_config.BdkRetryConfig
    - symphony.bdk.core.config.model.bdk_rsa_key_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_rsa_key_config.BdkRsaKeyConfig
    - symphony.bdk.core.config.model.bdk_server_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_server_config.BdkProxyConfig
      - symphony.bdk.core.config.model.bdk_server_config.BdkServerConfig
    - symphony.bdk.core.config.model.bdk_ssl_config
      Toggle child pages in navigation
      - symphony.bdk.core.config.model.bdk_ssl_config.BdkSslConfig
- symphony.bdk.core.extension
  Toggle child pages in navigation
- symphony.bdk.core.retry
  Toggle child pages in navigation
  - symphony.bdk.core.retry.retry
  - symphony.bdk.core.retry.strategy
    Toggle child pages in navigation
- symphony.bdk.core.service
  Toggle child pages in navigation
  - symphony.bdk.core.service.application
    Toggle child pages in navigation
    - symphony.bdk.core.service.application.application_service
      Toggle child pages in navigation
      - symphony.bdk.core.service.application.application_service.ApplicationService
  - symphony.bdk.core.service.connection
    Toggle child pages in navigation
    - symphony.bdk.core.service.connection.connection_service
      Toggle child pages in navigation
      - symphony.bdk.core.service.connection.connection_service.ConnectionService
      - symphony.bdk.core.service.connection.connection_service.OboConnectionService
    - symphony.bdk.core.service.connection.model
      Toggle child pages in navigation
      - symphony.bdk.core.service.connection.model.connection_status
        Toggle child pages in navigation
        
        symphony.bdk.core.service.connection.model.connection_status.ConnectionStatus
  - symphony.bdk.core.service.datafeed
    Toggle child pages in navigation
    - symphony.bdk.core.service.datafeed.abstract_ackId_event_loop
      Toggle child pages in navigation
      - symphony.bdk.core.service.datafeed.abstract_ackId_event_loop.AbstractAckIdEventLoop
    - symphony.bdk.core.service.datafeed.abstract_datafeed_loop
      Toggle child pages in navigation
    - symphony.bdk.core.service.datafeed.abstract_datahose_loop
      Toggle child pages in navigation
      - symphony.bdk.core.service.datafeed.abstract_datahose_loop.AbstractDatahoseLoop
    - symphony.bdk.core.service.datafeed.datafeed_loop_v1
      Toggle child pages in navigation
      - symphony.bdk.core.service.datafeed.datafeed_loop_v1.DatafeedLoopV1
    - symphony.bdk.core.service.datafeed.datafeed_loop_v2
      Toggle child pages in navigation
      - symphony.bdk.core.service.datafeed.datafeed_loop_v2.DatafeedLoopV2
    - symphony.bdk.core.service.datafeed.datahose_loop
      Toggle child pages in navigation
      - symphony.bdk.core.service.datafeed.datahose_loop.DatahoseLoop
    - symphony.bdk.core.service.datafeed.exception
      Toggle child pages in navigation
      - symphony.bdk.core.service.datafeed.exception.EventError
    - symphony.bdk.core.service.datafeed.on_disk_datafeed_id_repository
      Toggle child pages in navigation
      - symphony.bdk.core.service.datafeed.on_disk_datafeed_id_repository.DatafeedIdRepository
      - symphony.bdk.core.service.datafeed.on_disk_datafeed_id_repository.OnDiskDatafeedIdRepository
    - symphony.bdk.core.service.datafeed.real_time_event_listener
      Toggle child pages in navigation
      - symphony.bdk.core.service.datafeed.real_time_event_listener.RealTimeEventListener
  - symphony.bdk.core.service.exception
    Toggle child pages in navigation
    - symphony.bdk.core.service.exception.MessageCreationError
    - symphony.bdk.core.service.exception.MessageParserError
  - symphony.bdk.core.service.health
    Toggle child pages in navigation
    - symphony.bdk.core.service.health.health_service
      Toggle child pages in navigation
      - symphony.bdk.core.service.health.health_service.HealthService
  - symphony.bdk.core.service.message
    Toggle child pages in navigation
    - symphony.bdk.core.service.message.message_parser
      Toggle child pages in navigation
    - symphony.bdk.core.service.message.message_service
      Toggle child pages in navigation
      - symphony.bdk.core.service.message.message_service.MessageService
      - symphony.bdk.core.service.message.message_service.OboMessageService
    - symphony.bdk.core.service.message.messageml_util
      Toggle child pages in navigation
      - symphony.bdk.core.service.message.messageml_util.escape_special_chars
    - symphony.bdk.core.service.message.model
      Toggle child pages in navigation
      - symphony.bdk.core.service.message.model.Message
    - symphony.bdk.core.service.message.multi_attachments_messages_api
      Toggle child pages in navigation
      - symphony.bdk.core.service.message.multi_attachments_messages_api.MultiAttachmentsMessagesApi
  - symphony.bdk.core.service.obo_services
    Toggle child pages in navigation
    - symphony.bdk.core.service.obo_services.OboServices
  - symphony.bdk.core.service.pagination
    Toggle child pages in navigation
    - symphony.bdk.core.service.pagination.cursor_based_pagination
    - symphony.bdk.core.service.pagination.offset_based_pagination
  - symphony.bdk.core.service.presence
    Toggle child pages in navigation
    - symphony.bdk.core.service.presence.presence_service
      Toggle child pages in navigation
  - symphony.bdk.core.service.session
    Toggle child pages in navigation
    - symphony.bdk.core.service.session.session_service
      Toggle child pages in navigation
      - symphony.bdk.core.service.session.session_service.OboSessionService
      - symphony.bdk.core.service.session.session_service.SessionService
  - symphony.bdk.core.service.signal
    Toggle child pages in navigation
    - symphony.bdk.core.service.signal.signal_service
      Toggle child pages in navigation
      - symphony.bdk.core.service.signal.signal_service.OboSignalService
      - symphony.bdk.core.service.signal.signal_service.SignalService
  - symphony.bdk.core.service.stream
    Toggle child pages in navigation
    - symphony.bdk.core.service.stream.stream_service
      Toggle child pages in navigation
      - symphony.bdk.core.service.stream.stream_service.OboStreamService
      - symphony.bdk.core.service.stream.stream_service.StreamService
    - symphony.bdk.core.service.stream.stream_util
      Toggle child pages in navigation
      - symphony.bdk.core.service.stream.stream_util.from_url_safe_stream_id
      - symphony.bdk.core.service.stream.stream_util.to_url_safe_stream_id
  - symphony.bdk.core.service.user
    Toggle child pages in navigation
    - symphony.bdk.core.service.user.model
      Toggle child pages in navigation
      - symphony.bdk.core.service.user.model.delegate_action_enum
        Toggle child pages in navigation
        
        symphony.bdk.core.service.user.model.delegate_action_enum.DelegateActionEnum
      - symphony.bdk.core.service.user.model.role_id
        Toggle child pages in navigation
        
        symphony.bdk.core.service.user.model.role_id.RoleId
    - symphony.bdk.core.service.user.user_service
      Toggle child pages in navigation
      - symphony.bdk.core.service.user.user_service.OboUserService
      - symphony.bdk.core.service.user.user_service.UserService
    - symphony.bdk.core.service.user.user_util
      Toggle child pages in navigation
- symphony.bdk.core.service_factory
  Toggle child pages in navigation
  - symphony.bdk.core.service_factory.OboServiceFactory
  - symphony.bdk.core.service_factory.ServiceFactory
- symphony.bdk.core.symphony_bdk
  Toggle child pages in navigation

Toggle table of contents sidebar

symphony.bdk.core.service.user.model.role_id#

Classes

RoleId(value)

Static roles that have special logic attached to them.

symphony.bdk.core.service.user.model.role_id.RoleId

symphony.bdk.core.service.user.model.delegate_action_enum.DelegateActionEnum

Copyright © 2021, Symphony Communication Services LLC

Made with Sphinx and @pradyunsg's Furo