MSALTelemetry

Objective-C

@interface MSALTelemetry : NSObject

Swift

class MSALTelemetry : NSObject

The central class for MSAL telemetry.

Usage: Get a singleton instance of MSALTelemetry; register a callback (telemetryCallback) for receiving telemetry events.

Note

MSALTelemetry is deprecated. Use MSALTelemetryConfig instead to register a telemetryCallback and changing telemetry configuration.

Unavailable initializers

  • Unavailable

    Get a singleton instance of MSALTelemetry instead.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Unavailable

    Get a singleton instance of MSALTelemetry instead.

    Declaration

    Objective-C

    + (nonnull instancetype)new;

Getting a shared instance

  • Deprecated

    use MSALGlobalConfig.telemetryConfig instead

    Get a singleton instance of MSALTelemetry.

    Declaration

    Objective-C

    + (nonnull MSALTelemetry *)sharedInstance;

    Swift

    class func sharedInstance() -> MSALTelemetry

Configuring telemetry collection

  • Deprecated

    use MSALGlobalConfig.telemetryConfig.piiEnabled instead

    Setting piiEnabled to YES, will allow MSAL to return fields with user information in the telemetry events. MSAL does not send telemetry data by itself to any server. If apps want to collect MSAL telemetry with user information they must setup the telemetry callback and set this flag on. By default MSAL will not return any user information in telemetry.

    Declaration

    Objective-C

    @property BOOL piiEnabled;

    Swift

    var piiEnabled: Bool { get set }

  • Deprecated

    use MSALGlobalConfig.telemetryConfig.notifyOnFailureOnly instead

    If set YES, telemetry events are only dispatched when errors occurred; If set NO, MSAL will dispatch all events.

    Declaration

    Objective-C

    @property BOOL notifyOnFailureOnly;

    Swift

    var notifyOnFailureOnly: Bool { get set }

  • Deprecated

    use MSALGlobalConfig.telemetryConfig.telemetryCallback instead

    Invoked when telemetry data is received.

    Declaration

    Objective-C

    @property (copy, nullable) MSALTelemetryCallback telemetryCallback;