@API(status=STABLE)
public class SymphonyBdk
extends java.lang.Object
Modifier | Constructor and Description |
---|---|
|
SymphonyBdk(BdkConfig config)
Default public constructor.
|
protected |
SymphonyBdk(BdkConfig config,
ApiClientFactory apiClientFactory,
AuthenticatorFactory authenticatorFactory) |
Modifier and Type | Method and Description |
---|---|
ActivityRegistry |
activities()
Returns the
ActivityRegistry in order to register Command or Form activities. |
ExtensionAppAuthenticator |
appAuthenticator()
Returns the
ExtensionAppAuthenticator . |
ApplicationService |
applications()
Get the
ApplicationService from a Bdk entry point. |
UserV2 |
botInfo()
Returns the bot information.
|
AuthSession |
botSession()
Returns the Bot session.
|
static SymphonyBdkBuilder |
builder()
Returns a new
SymphonyBdkBuilder for fluent initialization. |
BdkConfig |
config()
Returns the current configuration object.
|
ConnectionService |
connections()
Get the
ConnectionService from a Bdk entry point. |
DatafeedLoop |
datafeed()
Get the
DatafeedLoop from a Bdk entry point. |
DisclaimerService |
disclaimers()
Get the
DisclaimerService from a Bdk entry point. |
protected ExtensionAppAuthenticator |
getExtensionAppAuthenticator() |
protected OboAuthenticator |
getOboAuthenticator() |
HealthService |
health()
Get the
HealthService from a Bdk entry point. |
com.symphony.bdk.http.api.HttpClient.Builder |
http()
Get the
HttpClient.Builder from a Bdk entry point. |
MessageService |
messages()
Get the
MessageService from a Bdk entry point. |
OboServices |
obo(AuthSession oboSession)
Get an
OboServices gathering all OBO enabled services |
AuthSession |
obo(java.lang.Long id)
OBO Authenticate by using user Id.
|
AuthSession |
obo(java.lang.String username)
OBO Authenticate by using username.
|
PresenceService |
presences()
Get the
PresenceService from a Bdk entry point. |
SessionService |
sessions()
Get the
SessionService from a Bdk entry point. |
SignalService |
signals()
Get the
SignalService from a Bdk entry point. |
StreamService |
streams()
Get the
StreamService from a Bdk entry point. |
UserService |
users()
Get the
UserService from a Bdk entry point. |
public SymphonyBdk(@Nonnull BdkConfig config) throws AuthInitializationException, AuthUnauthorizedException
For more advanced initialization, consider using builder()
that
provides advanced options through the SymphonyBdkBuilder
.
config
- Configuration properties, usually loaded from BdkConfigLoader
.AuthInitializationException
- when unable to read/parse a RSA Private Key or a certificateAuthUnauthorizedException
- authentication issue (e.g. 401)protected SymphonyBdk(@Nonnull BdkConfig config, @Nullable ApiClientFactory apiClientFactory, @Nullable AuthenticatorFactory authenticatorFactory) throws AuthInitializationException, AuthUnauthorizedException
@API(status=EXPERIMENTAL) public static SymphonyBdkBuilder builder()
SymphonyBdkBuilder
for fluent initialization.SymphonyBdkBuilder
.public com.symphony.bdk.http.api.HttpClient.Builder http()
HttpClient.Builder
from a Bdk entry point.
The returned HttpClient builder instance depends on which ApiClientBuilderProvider
is implemented.HttpClient.Builder
HttpClient builder instance.public MessageService messages()
MessageService
from a Bdk entry point.
The returned message service instance.MessageService
message service instance.public DatafeedLoop datafeed()
DatafeedLoop
from a Bdk entry point.
The returned datafeed service instance depends on the configuration of datafeed version.DatafeedLoop
datafeed service instance.public UserService users()
UserService
from a Bdk entry point.UserService
user service instance.public StreamService streams()
StreamService
from a Bdk entry point.StreamService
user service instance.public DisclaimerService disclaimers()
DisclaimerService
from a Bdk entry point.DisclaimerService
disclaimer service instance.public PresenceService presences()
PresenceService
from a Bdk entry point.PresenceService
presence service instance.public ConnectionService connections()
ConnectionService
from a Bdk entry point.ConnectionService
connection service instance.public SignalService signals()
SignalService
from a Bdk entry point.SignalService
signal service instance.public ApplicationService applications()
ApplicationService
from a Bdk entry point.ApplicationService
application service instance.public HealthService health()
HealthService
from a Bdk entry point.HealthService
health service instance.public SessionService sessions()
SessionService
from a Bdk entry point.SessionService
session service instance.public ActivityRegistry activities()
ActivityRegistry
in order to register Command or Form activities.ActivityRegistry
public AuthSession obo(java.lang.Long id) throws AuthUnauthorizedException
id
- User idAuthUnauthorizedException
public AuthSession obo(java.lang.String username) throws AuthUnauthorizedException
username
- UsernameAuthUnauthorizedException
public OboServices obo(AuthSession oboSession)
OboServices
gathering all OBO enabled servicesoboSession
- the OBO session to useOboServices
instance using the provided OBO sessionpublic ExtensionAppAuthenticator appAuthenticator()
ExtensionAppAuthenticator
.ExtensionAppAuthenticator
@API(status=EXPERIMENTAL) public AuthSession botSession()
AuthSession
@API(status=EXPERIMENTAL) public UserV2 botInfo()
public BdkConfig config()
protected ExtensionAppAuthenticator getExtensionAppAuthenticator()
protected OboAuthenticator getOboAuthenticator()