Struct dittolive_ditto::identity::OnlinePlaygroundV2
source · [−]pub struct OnlinePlaygroundV2 { /* 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 Online identity.
Implementations
sourceimpl OnlinePlaygroundV2
impl OnlinePlaygroundV2
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 OnlinePlaygroundV2 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 OnlinePlaygroundV2 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
sourceimpl Identity for OnlinePlaygroundV2
impl Identity for OnlinePlaygroundV2
sourcefn auth_client(&self) -> Arc<BoxedAuthClient>
fn auth_client(&self) -> Arc<BoxedAuthClient>
Returns a shared reference to the underlying AuthClient
sourcefn ditto_root(&self) -> Arc<dyn DittoRoot>
fn ditto_root(&self) -> Arc<dyn DittoRoot>
Returns the current DittoRoot
sourcefn is_web_valid(&self) -> bool
fn is_web_valid(&self) -> bool
Returns if the curernt web auth token is valid
sourcefn is_x509_valid(&self) -> bool
fn is_x509_valid(&self) -> bool
Returns if the configured x509 certificate is valid
sourcefn auth_url(&self) -> Result<String, DittoError>
fn auth_url(&self) -> Result<String, DittoError>
Returns the configured URL for Auth
sourcefn sync_url(&self) -> Result<String, DittoError>
fn sync_url(&self) -> Result<String, DittoError>
Returns the configured URL for websocket sync
sourcefn authenticator(&self) -> Option<DittoAuthenticator>
fn authenticator(&self) -> Option<DittoAuthenticator>
Returns the underlying DittoAuthenticator if specified
sourcefn make_listener(
&self,
transports: Arc<RwLock<Transports>>
) -> Option<Arc<ValidityListener>>
fn make_listener(
&self,
transports: Arc<RwLock<Transports>>
) -> Option<Arc<ValidityListener>>
Constructs a ValidityListener given a shared reference to the Ditto
Transports Read more
sourcefn is_cloud_sync_enabled(&self) -> bool
fn is_cloud_sync_enabled(&self) -> bool
Indicates if cloud sync should be enabled by default
sourcefn 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.
Auto Trait Implementations
impl !RefUnwindSafe for OnlinePlaygroundV2
impl Send for OnlinePlaygroundV2
impl Sync for OnlinePlaygroundV2
impl Unpin for OnlinePlaygroundV2
impl !UnwindSafe for OnlinePlaygroundV2
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more