Package apple.metrickit

Class MXMetricPayload

  • All Implemented Interfaces:
    NSCoding, NSSecureCoding, NSObject
    public class MXMetricPayload
extends NSObject
implements NSSecureCoding
    MXMetricPayload A wrapper class which contains a metric payload and associated properties of that payload. MXMetricPayload encapsulates currently supported metric types that can be vended by MetricKit. MXMetric subclasses on MXMetricPayload are nullable. If an MXMetric subclass is nil, it indicates that the data is not available for this payload. MXMetricPayload exposes a convenience function, JSONRepresentation, to convert the contents of the payload to a human readable JSON. This should be used in conjunction with other APIs that accept NSData. An MXMetricPayload contains data that covers a 24 hour period of application usage. The properties timeStampBegin and timeStampEnd should be used to determine which time range the payload covers. It is possible for an MXMetricPayload to cover regions of time where an application was updated, and thus had multiple different app version strings. The property latestApplicationVersion will always reflect the latest appVersion at the time the metric payload was created. Use includesMultipleApplicationVersions to determine if an application changed versions during the time range the payload covers. API-Since: 13.0

    • Constructor Detail

      • MXMetricPayload

        protected MXMetricPayload​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • DictionaryRepresentation

        @NotNull
@Deprecated
public @NotNull NSDictionary<?,​?> DictionaryRepresentation()
        Deprecated.
        DictionaryRepresentation Convenience method to return a NSDictionary representation of this payload.
        Returns:
        An NSDictionary object containing the dictionary representation API-Since: 13.0 Deprecated-Since: 100000.0

      • JSONRepresentation

        @NotNull
public @NotNull NSData JSONRepresentation()
        JSONRepresentation Convenience method to return a JSON representation of this payload.
        Returns:
        An NSData object containing the JSON representation

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static MXMetricPayload allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • applicationLaunchMetrics

        @Nullable
public @Nullable MXAppLaunchMetric applicationLaunchMetrics()
        [@property] applicationLaunchMetrics An object containing launch metrics for this application.

      • applicationResponsivenessMetrics

        @Nullable
public @Nullable MXAppResponsivenessMetric applicationResponsivenessMetrics()
        [@property] applicationResponsivenessMetrics An object containing hang metrics for this application.

      • applicationTimeMetrics

        @Nullable
public @Nullable MXAppRunTimeMetric applicationTimeMetrics()
        [@property] applicationTimeMetrics An object containing running mode metrics for this application.

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(@NotNull
                                                                         @NotNull java.lang.Object aTarget,
                                                                         @NotNull
                                                                         @NotNull org.moe.natj.objc.SEL aSelector,
                                                                         @Nullable
                                                                         @Nullable java.lang.Object anArgument)

      • cellularConditionMetrics

        @Nullable
public @Nullable MXCellularConditionMetric cellularConditionMetrics()
        [@property] cellularConditionMetrics An object containing a cellular condition metrics for this application.

      • classFallbacksForKeyedArchiver

        @NotNull
public static @NotNull NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull org.moe.natj.objc.Class classForKeyedUnarchiver()

      • cpuMetrics

        @Nullable
public @Nullable MXCPUMetric cpuMetrics()
        [@property] cpuMetrics An object containing CPU metrics for this application.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • diskIOMetrics

        @Nullable
public @Nullable MXDiskIOMetric diskIOMetrics()
        [@property] diskIOMetrics An object containing disk IO metrics for this application.

      • displayMetrics

        @Nullable
public @Nullable MXDisplayMetric displayMetrics()
        [@property] displayMetrics An object containing display metrics for this application.

      • gpuMetrics

        @Nullable
public @Nullable MXGPUMetric gpuMetrics()
        [@property] gpuMetrics An object containing GPU metrics for this application.

      • hash_static

        public static long hash_static()

      • includesMultipleApplicationVersions

        public boolean includesMultipleApplicationVersions()
        [@property] includesMultipleApplicationVersions A bool which indicates whether or not this payload contains data from multiple application versions. A value of YES indicates that this payload's data reflects multiple application versions. A value of NO indicates that this payload only reflects data from the application version specified by latestApplicationVersion.

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        @NotNull
public static @NotNull NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(@NotNull
                                                                                     @NotNull java.lang.String key)

      • latestApplicationVersion

        @NotNull
public @NotNull java.lang.String latestApplicationVersion()
        [@property] latestApplicationVersion An NSString representation of the application version from which this payload was generated. If the application version was changed during the aggregation of this data, this value will reflect the latest application version at the time of retrieval.

      • locationActivityMetrics

        @Nullable
public @Nullable MXLocationActivityMetric locationActivityMetrics()
        [@property] locationActivityMetrics An object containing location activity metrics for this application.

      • memoryMetrics

        @Nullable
public @Nullable MXMemoryMetric memoryMetrics()
        [@property] memoryMetrics An object containing memory metrics for this application.

      • metaData

        @Nullable
public @Nullable MXMetaData metaData()
        [@property] metaData An object containing extra metadata for this payload.

      • networkTransferMetrics

        @Nullable
public @Nullable MXNetworkTransferMetric networkTransferMetrics()
        [@property] networkTransferMetrics An object containing network transfer metrics for this application.

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • signpostMetrics

        @Nullable
public @Nullable NSArray<? extends MXSignpostMetric> signpostMetrics()
        [@property] signpostMetrics An array containing signpost metrics for this application.

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • supportsSecureCoding

        public static boolean supportsSecureCoding()

      • _supportsSecureCoding

        public boolean _supportsSecureCoding()
        Description copied from interface: NSSecureCoding
        This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
        Specified by:
        _supportsSecureCoding in interface NSSecureCoding

      • timeStampBegin

        @NotNull
public @NotNull NSDate timeStampBegin()
        [@property] timeStampBegin An NSDate object that indicates the time which the payload was generated.

      • timeStampEnd

        @NotNull
public @NotNull NSDate timeStampEnd()
        [@property] timeStampEnd An NSDate object that indicates the time which the payload was generated.

      • version_static

        public static long version_static()

      • animationMetrics

        @Nullable
public @Nullable MXAnimationMetric animationMetrics()
        [@property] animationMetrics An object containing animation metrics for this application. API-Since: 14.0

      • applicationExitMetrics

        @Nullable
public @Nullable MXAppExitMetric applicationExitMetrics()
        [@property] applicationExitMetrics An object containing exit metrics for this application. API-Since: 14.0

      • dictionaryRepresentation

        @NotNull
public @NotNull NSDictionary<?,​?> dictionaryRepresentation()
        dictionaryRepresentation Convenience method to return a NSDictionary representation of this payload.
        Returns:
        An NSDictionary object containing the dictionary representation API-Since: 14.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.