MXMetricPayload (moe.platform.ios API)

java.lang.Object
- org.moe.natj.general.NativeObject
- - org.moe.natj.objc.ObjCObject
  - - apple.NSObject
    - - apple.metrickit.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.

Nested Class Summary
- Nested classes/interfaces inherited from class apple.NSObject
  NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors
Modifier Constructor and Description

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

Constructors
Modifier	Constructor and Description
`protected`	`MXMetricPayload(org.moe.natj.general.Pointer peer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`_supportsSecureCoding()` This property must return YES on all classes that allow secure coding.
`static boolean`	`accessInstanceVariablesDirectly()`
`static MXMetricPayload`	`alloc()`
`static MXMetricPayload`	`allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)`
`MXAnimationMetric`	`animationMetrics()` [@property] animationMetrics
`MXAppExitMetric`	`applicationExitMetrics()` [@property] applicationExitMetrics
`MXAppLaunchMetric`	`applicationLaunchMetrics()` [@property] applicationLaunchMetrics
`MXAppResponsivenessMetric`	`applicationResponsivenessMetrics()` [@property] applicationResponsivenessMetrics
`MXAppRunTimeMetric`	`applicationTimeMetrics()` [@property] applicationTimeMetrics
`static boolean`	`automaticallyNotifiesObserversForKey(java.lang.String key)`
`static void`	`cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)`
`static void`	`cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)`
`MXCellularConditionMetric`	`cellularConditionMetrics()` [@property] cellularConditionMetrics
`static NSArray<java.lang.String>`	`classFallbacksForKeyedArchiver()`
`static org.moe.natj.objc.Class`	`classForKeyedUnarchiver()`
`MXCPUMetric`	`cpuMetrics()` [@property] cpuMetrics
`static java.lang.String`	`debugDescription_static()`
`static java.lang.String`	`description_static()`
`NSDictionary<?,?>`	`dictionaryRepresentation()` dictionaryRepresentation
`NSDictionary<?,?>`	`DictionaryRepresentation()` DictionaryRepresentation
`MXDiskIOMetric`	`diskIOMetrics()` [@property] diskIOMetrics
`MXDisplayMetric`	`displayMetrics()` [@property] displayMetrics
`void`	`encodeWithCoder(NSCoder coder)`
`MXGPUMetric`	`gpuMetrics()` [@property] gpuMetrics
`static long`	`hash_static()`
`boolean`	`includesMultipleApplicationVersions()` [@property] includesMultipleApplicationVersions
`MXMetricPayload`	`init()`
`MXMetricPayload`	`initWithCoder(NSCoder coder)` NS_DESIGNATED_INITIALIZER
`static NSObject.Function_instanceMethodForSelector_ret`	`instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)`
`static NSMethodSignature`	`instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`isSubclassOfClass(org.moe.natj.objc.Class aClass)`
`NSData`	`JSONRepresentation()` JSONRepresentation
`static NSSet<java.lang.String>`	`keyPathsForValuesAffectingValueForKey(java.lang.String key)`
`java.lang.String`	`latestApplicationVersion()` [@property] latestApplicationVersion
`MXLocationActivityMetric`	`locationActivityMetrics()` [@property] locationActivityMetrics
`MXMemoryMetric`	`memoryMetrics()` [@property] memoryMetrics
`MXMetaData`	`metaData()` [@property] metaData
`MXNetworkTransferMetric`	`networkTransferMetrics()` [@property] networkTransferMetrics
`static MXMetricPayload`	`new_objc()`
`static boolean`	`resolveClassMethod(org.moe.natj.objc.SEL sel)`
`static boolean`	`resolveInstanceMethod(org.moe.natj.objc.SEL sel)`
`static void`	`setVersion_static(long aVersion)`
`NSArray<? extends MXSignpostMetric>`	`signpostMetrics()` [@property] signpostMetrics
`static org.moe.natj.objc.Class`	`superclass_static()`
`static boolean`	`supportsSecureCoding()`
`NSDate`	`timeStampBegin()` [@property] timeStampBegin
`NSDate`	`timeStampEnd()` [@property] timeStampEnd
`static long`	`version_static()`

Methods inherited from class apple.NSObject
accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject
equals, toString

Methods inherited from class org.moe.natj.general.NativeObject
finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MXMetricPayload
```
protected MXMetricPayload(org.moe.natj.general.Pointer peer)
```
- Method Detail
  - DictionaryRepresentation
```
public NSDictionary<?,?> DictionaryRepresentation()
```
    DictionaryRepresentation
    Convenience method to return a NSDictionary representation of this payload.
    
    Returns:
    
    An NSDictionary object containing the dictionary representation
  - JSONRepresentation
```
public 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()
```
  - alloc
```
public static MXMetricPayload alloc()
```
  - allocWithZone
```
public static MXMetricPayload allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
```
  - applicationLaunchMetrics
```
public MXAppLaunchMetric applicationLaunchMetrics()
```
    [@property] applicationLaunchMetrics
    An object containing launch metrics for this application.
  - applicationResponsivenessMetrics
```
public MXAppResponsivenessMetric applicationResponsivenessMetrics()
```
    [@property] applicationResponsivenessMetrics
    An object containing hang metrics for this application.
  - applicationTimeMetrics
```
public MXAppRunTimeMetric applicationTimeMetrics()
```
    [@property] applicationTimeMetrics
    An object containing running mode metrics for this application.
  - automaticallyNotifiesObserversForKey
```
public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)
```
  - cancelPreviousPerformRequestsWithTarget
```
public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
```
  - cancelPreviousPerformRequestsWithTargetSelectorObject
```
public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)
```
  - cellularConditionMetrics
```
public MXCellularConditionMetric cellularConditionMetrics()
```
    [@property] cellularConditionMetrics
    An object containing a cellular condition metrics for this application.
  - classFallbacksForKeyedArchiver
```
public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()
```
  - classForKeyedUnarchiver
```
public static org.moe.natj.objc.Class classForKeyedUnarchiver()
```
  - cpuMetrics
```
public 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
```
public MXDiskIOMetric diskIOMetrics()
```
    [@property] diskIOMetrics
    An object containing disk IO metrics for this application.
  - displayMetrics
```
public MXDisplayMetric displayMetrics()
```
    [@property] displayMetrics
    An object containing display metrics for this application.
  - encodeWithCoder
```
public void encodeWithCoder(NSCoder coder)
```
    Specified by:
    
    encodeWithCoder in interface NSCoding
  - gpuMetrics
```
public 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.
  - init
```
public MXMetricPayload init()
```
    Overrides:
    
    init in class NSObject
  - initWithCoder
```
public MXMetricPayload initWithCoder(NSCoder coder)
```
    Description copied from interface: NSCoding
    
    NS_DESIGNATED_INITIALIZER
    
    Specified by:
    
    initWithCoder in interface NSCoding
  - instanceMethodForSelector
```
public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
```
  - 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
```
public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)
```
  - latestApplicationVersion
```
public 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
```
public MXLocationActivityMetric locationActivityMetrics()
```
    [@property] locationActivityMetrics
    An object containing location activity metrics for this application.
  - memoryMetrics
```
public MXMemoryMetric memoryMetrics()
```
    [@property] memoryMetrics
    An object containing memory metrics for this application.
  - metaData
```
public MXMetaData metaData()
```
    [@property] metaData
    An object containing extra metadata for this payload.
  - networkTransferMetrics
```
public MXNetworkTransferMetric networkTransferMetrics()
```
    [@property] networkTransferMetrics
    An object containing network transfer metrics for this application.
  - new_objc
```
public static MXMetricPayload new_objc()
```
  - 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
```
public 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
```
public NSDate timeStampBegin()
```
    [@property] timeStampBegin
    An NSDate object that indicates the time which the payload was generated.
  - timeStampEnd
```
public NSDate timeStampEnd()
```
    [@property] timeStampEnd
    An NSDate object that indicates the time which the payload was generated.
  - version_static
```
public static long version_static()
```
  - animationMetrics
```
public MXAnimationMetric animationMetrics()
```
    [@property] animationMetrics
    An object containing animation metrics for this application.
  - applicationExitMetrics
```
public MXAppExitMetric applicationExitMetrics()
```
    [@property] applicationExitMetrics
    An object containing exit metrics for this application.
  - dictionaryRepresentation
```
public NSDictionary<?,?> dictionaryRepresentation()
```
    dictionaryRepresentation
    Convenience method to return a NSDictionary representation of this payload.
    
    Returns:
    
    An NSDictionary object containing the dictionary representation

Class MXMetricPayload

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

Constructor Summary

Method Summary

Methods inherited from class apple.NSObject

Methods inherited from class org.moe.natj.objc.ObjCObject

Methods inherited from class org.moe.natj.general.NativeObject

Methods inherited from class java.lang.Object

Constructor Detail

MXMetricPayload

Method Detail

DictionaryRepresentation

JSONRepresentation

accessInstanceVariablesDirectly

alloc

allocWithZone

applicationLaunchMetrics

applicationResponsivenessMetrics

applicationTimeMetrics

automaticallyNotifiesObserversForKey

cancelPreviousPerformRequestsWithTarget

cancelPreviousPerformRequestsWithTargetSelectorObject

cellularConditionMetrics

classFallbacksForKeyedArchiver

classForKeyedUnarchiver

cpuMetrics

debugDescription_static

description_static

diskIOMetrics

displayMetrics

encodeWithCoder

gpuMetrics

hash_static

includesMultipleApplicationVersions

init

initWithCoder

instanceMethodForSelector

instanceMethodSignatureForSelector

instancesRespondToSelector

isSubclassOfClass

keyPathsForValuesAffectingValueForKey

latestApplicationVersion

locationActivityMetrics

memoryMetrics

metaData

networkTransferMetrics

new_objc

resolveClassMethod

resolveInstanceMethod

setVersion_static

signpostMetrics

superclass_static

supportsSecureCoding

_supportsSecureCoding

timeStampBegin

timeStampEnd

version_static

animationMetrics

applicationExitMetrics

dictionaryRepresentation