SITDiagnosticsOptions

Objective-C

@interface SITDiagnosticsOptions : NSObject <SITMapperProtocol, NSCopying>

Swift

class SITDiagnosticsOptions : NSObject, SITMapperProtocol, NSCopying

Configuration options related to remote diagnostic and telemetry.

  • Configures whether or not to upload diagnostics and telemetry data. Enabling this option is beneficial for support purposes, as the telemetry data contains valuable insights that the Situm team can analyze to identify and resolve positioning issues more effectively.

    Note

    Uploading diagnostics and telemetry data consumes network bandwidth. Developers should carefully consider the application’s context and user preferences before disabling this feature. Default value is true

    Declaration

    Objective-C

    @property (nonatomic) BOOL uploadDiagnosticsData;

    Swift

    var uploadDiagnosticsData: Bool { get set }

  • Constructor for SITDiagnosticsOptions

    Declaration

    Objective-C

    - (instancetype _Nonnull)initWithUploadDiagnosticsData:
    (BOOL)uploadDiagnosticsData;

    Swift

    init(uploadDiagnosticsData: Bool)

  • Compares the receiving SITDiagnosticsOptions to another SITDiagnosticsOptions

    Declaration

    Objective-C

    - (BOOL)isEqualTo:(SITDiagnosticsOptions *_Nonnull)options;

    Swift

    func isEqual(to options: SITDiagnosticsOptions) -> Bool

    Parameters

    options

    SITDiagnosticsOptions The instance to compare with the receiver

    Return Value

    YES if options is equivalent to the receiving SITDiagnosticsOptions, otherwise NO.

  • Mix values between two objects.

    Note

    you should not use this method directly.

    Declaration

    Objective-C

    - (SITDiagnosticsOptions *_Nonnull)merge:
    (SITDiagnosticsOptions *_Nonnull)options;

    Swift

    func merge(_ options: SITDiagnosticsOptions) -> SITDiagnosticsOptions

    Return Value

    new `SITDiagnosticsOptions’ object.