Struct dittolive_ditto::identity::OnlinePlayground

pub struct OnlinePlayground { /* fields omitted */ }

Test a Ditto Cloud app without authentication (“Playground mode”). This mode offers no security and must only be used for development. Other behavior mirrors the Online identity.

Implementations

impl OnlinePlayground

pub fn new(
    ditto_root: Arc<dyn DittoRoot>,
    app_id: AppId,
    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 directory
• app_id - A unique AppId which must be a valid UUIDv4
• 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 later
• custom_auth_url - An optional Alternative URL for authentication requests. Defaults to https://<app_id>.cloud.ditto.live/

Trait Implementations

impl Identity for OnlinePlayground

fn site_id(&self) -> SiteId

Returns the current SiteId identifying the Ditto peer

fn auth_client(&self) -> Arc<BoxedAuthClient>

Returns a shared reference to the underlying AuthClient

fn app_id(&self) -> Option<&AppId>

Returns the current AppId

fn ditto_root(&self) -> Arc<dyn DittoRoot>

Returns the current DittoRoot

fn is_web_valid(&self) -> bool

Returns if the curernt web auth token is valid

fn is_x509_valid(&self) -> bool

Returns if the configured x509 certificate is valid

fn auth_url(&self) -> Result<String, DittoError>

Returns the configured URL for Auth

fn sync_url(&self) -> Result<String, DittoError>

Returns the configured URL for websocket sync

fn authenticator(&self) -> Option<DittoAuthenticator>

Returns the underlying DittoAuthenticator if specified

fn make_listener(
    &self,
    transports: Arc<RwLock<Transports>>
) -> Option<Arc<ValidityListener>>

Constructs a ValidityListener given a shared reference to the Ditto Transports

fn is_cloud_sync_enabled(&self) -> bool

Indicates if cloud sync should be enabled by default

fn requires_offline_only_license_token(&self) -> bool

Indicates whether the specific Identity type requires an offline only license token to be set.