UserAccount

@objc(GSUserAccount)
public protocol UserAccount : Facility

Facility that allows the application to register some user account identifier.

When such an identifier has been registered by the application, then flight blackboxes and full crash reports (which may contain user-related information) may be uploaded to the configured remote server. Upload HTTP requests for those data will contain this identifier.

When no identifier is registered, then:

  • Flight blackboxes are neither recorded nor uploaded to the configured remote server.
  • Only ‘light’ crash reports, which do not contain any user-related information, may be uploaded to the configured remote server. Furthermore, in the absence of an authenticated user, this utility allows to define the authorization to use anonymous data or not
  • Registers an user account.

    • Only one user account may be registered, calling this method erase any previously set user account.

    Declaration

    Swift

    @objc(setAccountProvider:accountId:accountlessPersonalDataPolicy:)
    func set(accountProvider: String, accountId: String, accountlessPersonalDataPolicy: AccountlessPersonalDataPolicy)

    Parameters

    accountProvider

    accountProvider identifies the account provider

    accountId

    accountId identifies the account

    accountlessPersonalDataPolicy

    true: Already collected data without account may be uploaded. false: Already collected data without account must not be uploaded and should be deleted.

  • Clears any registered user account.

    Declaration

    Swift

    func clear(anonymousDataPolicy: AnonymousDataPolicy)

    Parameters

    anonymousDataPolicy

    true if anonymous data are allowed, false otherwise