WebcomWrapper

The type of the wrapped instance, which has a callback-based API.

The wrapped instance, which has a callback-based API.

The authentication token.

The creation date of the user account.

The display name of the user, or nil when it is unavailable.

The expiration date of the authentication.

The provider of the current identity.

The providers used to get the different identities, starting from the current one.

By definition, the resulting array is never empty.

Additional data specific to the provider of the latest identity.

Typically, an OAuth2 provider may provide confidential data such as access or refresh tokens.

This property contains technical data while providerExtra contains data about the authenticated user.

The unique identifier of the user for the current identity.

The profile of the user for the provider of the latest identity.

This property contains data about the authenticated user while providerExtra contains technical data.

The previous provider identities.

The unique identifier of the user for the back-end.

The e-mail of the user, or nil when it is unavailable.

The identity of the user, or nil when it is unavailable.

When the provider is AuthenticationProvider.internal(_:), the returned value is the providerUID. Otherwise, it is the eMail value.

The URL of an avatar representing the user, or nil when it is unavailable.

The authentication provider corresponding to this method.

The provider.

The authentication mode.

The sender to be used by the AuthenticationProvider.InternalFamily.phone provider. When nil, the default sender, defined on the back-end, is used. This parameter is only meaningful when internalProvider is AuthenticationProvider.InternalFamily.phone. Otherwise, this value is ignored.

The unique identifier of the user for the provider.

The profile of the user.

This property is used by the attachIdentity(queue:then:) method.

It is not designed to store business applicative data about the user. For that purpose, use the DatasyncService.

The display name of the user.

This property is used by the attachIdentity(queue:then:) method.

The locale used for verification and one-time password messages sent to the user.

It must be in the ll-CC format, where ll is the ISO 639 alpha-2 code for the language and CC is the ISO 3166 alpha-2 code for the country variant.

Example: en-US

When nil, the preferred locale of the user contained in the main bundle is used.

This property is used by the requestPasswordResetLink(queue:then:), attachIdentity(queue:then:) and requestOneTimePassword(queue:then:) methods.

The identifier of the template, as defined on the developer console, to use for the password reset message.

This property is used by the requestPasswordResetLink(queue:then:) method.

The identifier of the template, as defined on the developer console, to use for the verification message.

This property is used by the attachIdentity(queue:then:) method.

The identifier of the template, as defined on the developer console, to use for the one-time password message.

This property is used by the requestOneTimePassword(queue:then:) method.

Sets the unique identifier of the user for the provider.

This method must be called after initializing this instance or just after AuthenticationService.initializeAuthentication(with:context:).

Sets the static password of the user.

Only use this method if the authentication mode is Mode.staticPassword.

Sets the verification token sent by the provider for sign-up.

Only use this method if the authentication mode is Mode.staticPassword. When authentication mode is Mode.oneTimePassword, use the setVerificationOneTimePassword(_:) method instead.

Sets the verification one-time password sent by the provider for sign-up.

Only use this method if the authentication mode is Mode.oneTimePassword. When authentication mode is Mode.staticPassword, use the setVerificationToken(_:) method instead.

Sets the one-time password sent by the provider for sign-in.

Only use this method when the authentication mode is Mode.oneTimePassword and for sign-in. To set the one-time password for sign-up, use the setVerificationOneTimePassword(_:) method instead. To set the static password for sign-up, use the setStaticPassword(_:) method instead.

The ongoing authentication process.

This property is nil when there is no ongoing authentication process.

Initializes an authentication process.

After using this method, the continueAuthentication(queue:then:) method must be called to continue the authentication process. Some additional steps, depending on the method, may be required between the two.

The method may be any authentication method, but single-steps ones should better use authenticate(with:queue:then:) directly, since it includes the call to continueAuthentication(queue:then:).

So, in practice, method should be an instance of AuthenticationMethodInternal.

Initializes an authentication process.

After using this method, the continueAuthentication(queue:then:) method must be called to continue the authentication process. Some additional steps, depending on the method, may be required between the two.

The method may be any authentication method, but single-steps ones should better use authenticate(with:queue:then:) directly, since it includes the call to continueAuthentication(queue:then:).

So, in practice, method should be a wrapped instance of AuthenticationMethodInternal.

Cancels the currently ongoing authentication process.

When there is no ongoing authentication process, this method is a no-op.

Subscribes to authentication events.

A subscription must always be stored somewhere in order to be cancelled when it is no longer used. Until a subscription is cancelled, it remains active and consumes resources. The easiest way is to let this instance store it by setting the stores parameter to true (which is its default value). Otherwise, the returned subscription instance must be stored by the application.

Subscriptions stored by a AuthenticationService are cancelled automatically when it is deinitialized.

They can also be cancelled manually:

• individually using the AuthenticationSubscription.cancel() method of the returned subscription instance,

• globally using the unsubscribeFromAll() method of this service instance, provided that the stores parameter was set to true.

Cancels all stored subscriptions.

Subscriptions are stored by the subscribe(stores:file:line:queue:callback:) method when the stores parameter is set to true (which is its default value).

Usually, there is no need to call this method since it is done automatically when this instance is deinitialized.

The absolute path of the node referred by this instance.

The path consists of the keys of the ancestors of this node, starting from the root of the tree, separated by / (slash) characters. The last segment of the path is the key of this node. The before last segment of the path, if any, is the key of the parent of this node. The path always begins with a /. The path of the root node is "/".

The key of the node represented by this instance.

It corresponds to the last segment of the path. It does not contain any / (slash) character. The key of the root node is the empty string ("").

The service from which this manager comes.

The policy applied by default to subscriptions created from this manager when they are completed.

A specific policy may be applied to a subscription by setting the DatasyncSubscription.completedSubscriptionPolicy property before the completion callback is called.

Cancels all stored subscriptions.

Subscriptions are stored by the DatasyncNode.subscribe(to:childrenConstraint:stores:file:line:queue:onEvent:onCompletion:) method with nodes belonging to this manager instance, when the stores parameter is set to true (which is its default value).

Usually, there is no need to call this method since it is done automatically when this instance is deinitialized.

Returns the creation date of a timestamp-based node key.

Encodes the input string to get a value that may be used as a valid node key. Returns a string that may be used as a valid node key to represent a given value.

The returned value may be decoded as follow to retrieve the input value:

• in Swift, use the removingPercentEncoding property,

• in JavaScript (e.g. for security rules), use the decodeURIComponent() global function.

Runs a block the first time this method is used for a given instance.

The first time this method is called for a given instance, the block is run. On subsequent calls on the same instance, this method is a no-operation, whether the block is the same of different from the first call.

This method is designed to be used in the viewDidAppear(_:) or the viewWillAppear(_:) method of a view controller to do some subscriptions, that need the user interface to be already loaded.

The absolute path of the node referred by this instance.

The path consists of the keys of the ancestors of this node, starting from the root of the tree, separated by / (slash) characters. The last segment of the path is the key of this node. The before last segment of the path, if any, is the key of the parent of this node. The path always begins with a /. The path of the root node is "/".

The key of the node represented by this instance.

It corresponds to the last segment of the path. It does not contain any / (slash) character. The key of the root node is the empty string ("").

The value of the node referred by this instance from the cache.

When there is no value available in the cache, the returned value is null (not to be confused with the Swift nil keyword).

In general, to get the value of a node, it is preferable to use the value(queue:then:) method.

Creates a subscription that assigns the children of the referred node to a dictionary.

In the dictionary:

• the keys are the keys of the children, as returned by DatasyncEvent.key,
• the values are decoded from the values of the children using DatasyncValue.decoded().

This method uses an underlying subscription to follow children additions, changes and removals. The dictionary is updated each time an event is received for that subscription. If the value of an added or changed child could not be decoded, the corresponding element in the dictionary is removed. If the subscription is revoked by the back-end, the dictionary is cleared.

Depending on stores, the subscription may be stored by the DatasyncManager of the referred node, as the subscribe(to:childrenConstraint:stores:file:line:queue:onEvent:onCompletion:) method does.

To avoid a retain cycle, the subscription does not keep a strong reference on the object. The developer must ensure that its lifetime is at least as long as that of the subscription. This is the case when the dictionary and the DatasyncManager are stored in the same object, provided that stores is true.

Example:

class EmployeeDirectory {

    struct Employee: Decodable {
        let name: String
        let yearOfBirth: Int
    }

    let datasyncManager = Webcom.defaultApplication.datasyncService.createManager()
    var employees: [String: Employee] = [:]

    func assignEmployees() {
        let employeesNode = datasyncManager / "employees"
        employeesNode?.assignChildren(to: \.employees, on: self)
    }

    ...
}

Cancels an operation registered using the DatasyncTime.nextDisconnection value for the node referred by this instance.

If no operation is currently registered, this method has no effect. This method cannot cancel an operation that has already been performed by the back-end.

The states of the web socket opened by this service.

Indicates whether the connection of the web socket associated to this service is enabled.

When an instance is initialized, this property is true. The SDK never modifies it from its own.

When this property is true, the web socket connects as soon as there is network connectivity and the application is in foreground. When this property is false, the web socket disconnects.

The cache.

See WebcomConfiguration.CacheMode for know when this property is usable or not.

The format of the returned string is opaque. A nil value indicates that the cache could not be retrieved.

Cleans the cache and stop updating it for all already cancelled subscriptions.

Calling this method is equivalent to having used the DatasyncCompletedSubscriptionPolicy.forgetData policy for all the DatasyncSubscription instances linked to this service completed so far. However, this has no effect on future cancellations or revocations.

Saves the cache.

See WebcomConfiguration.CacheMode for know when this method is usable or not.

Starts publishing the presence of the current user.

A user is said to be present when he/she is authenticated and connected on at least one device. A user is connected when the web socket of the Datasync service is connected with the back-end.

The presence is represented with the value of a node using an unspecified format. The presence is published until the stopPublishingMyPresence() method is called or the current user become unauthenticated.

The presence of the user can only be published on one node at a time. When this method is called, any presence publication already started is stopped before processing further.

Stops publishing the presence of the current user.

When the presence of the current user is currently not published, this method is a no-operation. Use the startPublishingMyPresence(on:file:line:) method to start publishing the presence of the current user.

Indicates whether a user is currently present.

This method is designed to work in concert with the startPublishingMyPresence(on:file:line:) method. This method analyzes the value of a node whose value corresponds to the presence state of another user, in the sense of the latter method.

The configuration corresponding to this application.

The URLSession instance used by this application.

When this property is nil, Webcom.defaultSession is used instead.

The DispatchQueue used by default to schedule callbacks.

When this property is nil, Webcom.defaultCallbackQueue is used instead.

The JSONEncoder instance used to serialize data for this application.

This property is initialized using the createDefaultJSONEncoder() static function.

The JSONDecoder instance used to deserialize data for this application.

This property is initialized using the createDefaultJSONDecoder() static function.

Returns a new JSON encoder.

The returned instance is configured with:

• iso8601 date encoding strategy,
• base64 data encoding strategy.

This function is used to initialize the jsonEncoder property of instances.

Returns a new JSON decoder.

The returned instance is configured with:

• iso8601 date decoding strategy,
• base64 data decoding strategy.

This function is used to initialize the jsonDecoder property of instances.

The identifier of this application on the back-end.