Struct dittolive_ditto::identity::OnlinePlayground
source · pub struct OnlinePlayground { /* private fields */ }
Expand description
Test a Ditto Cloud app with a simple shared token (“Playground mode”). This
mode offers no security and must only be used for development. Other
behavior mirrors the OnlineWithAuthentication
identity.
Implementations§
source§impl OnlinePlayground
impl OnlinePlayground
sourcepub fn new(
ditto_root: Arc<dyn DittoRoot>,
app_id: AppId,
shared_token: String,
enable_cloud_sync: bool,
custom_auth_url: Option<&str>
) -> Result<Self, DittoError>
pub fn new(
ditto_root: Arc<dyn DittoRoot>,
app_id: AppId,
shared_token: String,
enable_cloud_sync: bool,
custom_auth_url: Option<&str>
) -> Result<Self, DittoError>
Construct a new OnlinePlayground identity.
ditto_root
- Instance of DittoRoot indicating local storage directoryapp_id
- A unique AppId which must be a valid UUIDv4shared_token
- A shared token used to set up the OnlinePlayground session. This token is provided by the portal when setting up the application.enable_cloud_sync
- Should WebSocket sync with wss://<app_id>.cloud.ditto.live be enabled by default. Do not enable this if you want to provide a custom sync URL latercustom_auth_url
- An optional Alternative URL for authentication requests. Defaults tohttps://<app_id>.cloud.ditto.live/
Trait Implementations§
source§impl Identity for OnlinePlayground
impl Identity for OnlinePlayground
source§fn auth_client(&self) -> Arc<BoxedAuthClient>
fn auth_client(&self) -> Arc<BoxedAuthClient>
Returns a shared reference to the underlying AuthClient
source§fn is_web_valid(&self) -> bool
fn is_web_valid(&self) -> bool
Returns if the current web auth token is valid
source§fn is_x509_valid(&self) -> bool
fn is_x509_valid(&self) -> bool
Returns if the configured x509 certificate is valid
source§fn sync_url(&self) -> Result<String, DittoError>
fn sync_url(&self) -> Result<String, DittoError>
Returns the configured URL for websocket sync
source§fn authenticator(&self) -> Option<DittoAuthenticator>
fn authenticator(&self) -> Option<DittoAuthenticator>
Returns the underlying
DittoAuthenticator
if specifiedsource§fn make_listener(
&self,
transports: Weak<RwLock<TransportSync>>
) -> Option<Arc<ValidityListener>>
fn make_listener(
&self,
transports: Weak<RwLock<TransportSync>>
) -> Option<Arc<ValidityListener>>
Constructs a
ValidityListener
given a shared reference to the Ditto
Transports
source§fn is_cloud_sync_enabled(&self) -> bool
fn is_cloud_sync_enabled(&self) -> bool
Indicates if cloud sync should be enabled by default
source§fn requires_offline_only_license_token(&self) -> bool
fn requires_offline_only_license_token(&self) -> bool
Indicates whether the specific Identity type requires an offline only license token to be
set.