Home Home WebcomCore.DatasyncState Structure

DatasyncState

public struct DatasyncState : Codable, Equatable, CustomStringConvertible, CustomDebugStringConvertible

A value used to represent the state of the web socket opened by a DatasyncService instance.

Types

ConnectionState
A value representing the connection state of the web socket.
See more
Declaration
Swift

@frozen public enum ConnectionState : Codable, Equatable, CustomStringConvertible

Stored Properties

isReachable
Indicates that the back-end can be reached with the current network configuration.
Declaration
Swift

public let isReachable: Bool
connectionState
The connection state of the web socket.
Declaration
Swift

public let connectionState: ConnectionState
authenticationState
The authentication state of the web socket.

While the web socket remains in the AuthenticationState.invalid state, all Datasync operations are suspended until the web socket goes to the AuthenticationState.unauthenticated or to the AuthenticationState.authenticated(details:) state. At that time, these operations are flushed to the back-end, which may accept or reject each of them, depending on the corresponding security rules and the authentication token.
Declaration
Swift

public let authenticationState: AuthenticationState

Initializers

init()
Creates a new value with an unreachable, disconnected and unauthenticated state.
Declaration
Swift

public init()


                    
                    
                    init(from:)

Declaration

Swift

public init(from decoder: Decoder) throws

API

isConnected
Indicates whether the web socket is connected.

This property is true if and only if the connectionState property matches the ConnectionState.connected(backEndTimeOffsetMS:) case.
Declaration
Swift

public var isConnected: Bool { get }
isInitializing
Indicates whether the web socket is initializing.

This property is true if and only if the connectionState property matches the ConnectionState.disconnected(backEndTimeOffsetMS: _, isInitializing: true) case.
Declaration
Swift

public var isInitializing: Bool { get }
isAuthenticated
Indicates whether there is currently a valid authentication token on the web socket.

This property is true if and only if the authenticationState property matches the AuthenticationState.authenticated(details:) case.
Declaration
Swift

public var isAuthenticated: Bool { get }
authenticationDetails
The authentication details of the user currently authenticated on the web socket.

This property is nil when there is currently no valid authentication token on the web socket, i.e. when the authenticationState property does not match the AuthenticationState.authenticated(details:) case.
Declaration
Swift

public var authenticationDetails: AuthenticationDetails? { get }

CustomStringConvertible Protocol

description
Declaration
Swift

public var description: String { get }

CustomDebugStringConvertible Protocol


                    
                    
                    debugDescription

Declaration

Swift

public var debugDescription: String { get }