objc2_metric_kit/generated/
MXMetricPayload.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ptr::NonNull;
4use objc2::__framework_prelude::*;
5use objc2_foundation::*;
6
7use crate::*;
8
9extern_class!(
10    /// A wrapper class which contains a metric payload and associated properties of that payload.
11    ///
12    /// 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.
13    ///
14    /// 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.
15    ///
16    /// 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.
17    ///
18    /// 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.
19    ///
20    /// See also [Apple's documentation](https://developer.apple.com/documentation/metrickit/mxmetricpayload?language=objc)
21    #[unsafe(super(NSObject))]
22    #[derive(Debug, PartialEq, Eq, Hash)]
23    pub struct MXMetricPayload;
24);
25
26unsafe impl NSCoding for MXMetricPayload {}
27
28unsafe impl NSObjectProtocol for MXMetricPayload {}
29
30unsafe impl NSSecureCoding for MXMetricPayload {}
31
32impl MXMetricPayload {
33    extern_methods!(
34        /// An NSString representation of the application version from which this payload was generated.
35        ///
36        /// 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.
37        #[unsafe(method(latestApplicationVersion))]
38        #[unsafe(method_family = none)]
39        pub unsafe fn latestApplicationVersion(&self) -> Retained<NSString>;
40
41        /// A bool which indicates whether or not this payload contains data from multiple application versions.
42        ///
43        /// A value of YES indicates that this payload's data reflects multiple application versions.
44        ///
45        /// A value of NO indicates that this payload only reflects data from the application version specified by latestApplicationVersion.
46        #[unsafe(method(includesMultipleApplicationVersions))]
47        #[unsafe(method_family = none)]
48        pub unsafe fn includesMultipleApplicationVersions(&self) -> bool;
49
50        /// An NSDate object that indicates the time which the payload was generated.
51        #[unsafe(method(timeStampBegin))]
52        #[unsafe(method_family = none)]
53        pub unsafe fn timeStampBegin(&self) -> Retained<NSDate>;
54
55        /// An NSDate object that indicates the time which the payload was generated.
56        #[unsafe(method(timeStampEnd))]
57        #[unsafe(method_family = none)]
58        pub unsafe fn timeStampEnd(&self) -> Retained<NSDate>;
59
60        #[cfg(all(feature = "MXCPUMetric", feature = "MXMetric"))]
61        /// An object containing CPU metrics for this application.
62        #[unsafe(method(cpuMetrics))]
63        #[unsafe(method_family = none)]
64        pub unsafe fn cpuMetrics(&self) -> Option<Retained<MXCPUMetric>>;
65
66        #[cfg(all(feature = "MXGPUMetric", feature = "MXMetric"))]
67        /// An object containing GPU metrics for this application.
68        #[unsafe(method(gpuMetrics))]
69        #[unsafe(method_family = none)]
70        pub unsafe fn gpuMetrics(&self) -> Option<Retained<MXGPUMetric>>;
71
72        #[cfg(all(feature = "MXCellularConditionMetric", feature = "MXMetric"))]
73        /// An object containing a cellular condition metrics for this application.
74        #[unsafe(method(cellularConditionMetrics))]
75        #[unsafe(method_family = none)]
76        pub unsafe fn cellularConditionMetrics(
77            &self,
78        ) -> Option<Retained<MXCellularConditionMetric>>;
79
80        #[cfg(all(feature = "MXAppRunTimeMetric", feature = "MXMetric"))]
81        /// An object containing running mode metrics for this application.
82        #[unsafe(method(applicationTimeMetrics))]
83        #[unsafe(method_family = none)]
84        pub unsafe fn applicationTimeMetrics(&self) -> Option<Retained<MXAppRunTimeMetric>>;
85
86        #[cfg(all(feature = "MXLocationActivityMetric", feature = "MXMetric"))]
87        /// An object containing location activity metrics for this application.
88        #[unsafe(method(locationActivityMetrics))]
89        #[unsafe(method_family = none)]
90        pub unsafe fn locationActivityMetrics(&self) -> Option<Retained<MXLocationActivityMetric>>;
91
92        #[cfg(all(feature = "MXMetric", feature = "MXNetworkTransferMetric"))]
93        /// An object containing network transfer metrics for this application.
94        #[unsafe(method(networkTransferMetrics))]
95        #[unsafe(method_family = none)]
96        pub unsafe fn networkTransferMetrics(&self) -> Option<Retained<MXNetworkTransferMetric>>;
97
98        #[cfg(all(feature = "MXAppLaunchMetric", feature = "MXMetric"))]
99        /// An object containing launch metrics for this application.
100        #[unsafe(method(applicationLaunchMetrics))]
101        #[unsafe(method_family = none)]
102        pub unsafe fn applicationLaunchMetrics(&self) -> Option<Retained<MXAppLaunchMetric>>;
103
104        #[cfg(all(feature = "MXAppResponsivenessMetric", feature = "MXMetric"))]
105        /// An object containing hang metrics for this application.
106        #[unsafe(method(applicationResponsivenessMetrics))]
107        #[unsafe(method_family = none)]
108        pub unsafe fn applicationResponsivenessMetrics(
109            &self,
110        ) -> Option<Retained<MXAppResponsivenessMetric>>;
111
112        #[cfg(all(feature = "MXDiskIOMetric", feature = "MXMetric"))]
113        /// An object containing disk IO metrics for this application.
114        #[unsafe(method(diskIOMetrics))]
115        #[unsafe(method_family = none)]
116        pub unsafe fn diskIOMetrics(&self) -> Option<Retained<MXDiskIOMetric>>;
117
118        #[cfg(all(feature = "MXMemoryMetric", feature = "MXMetric"))]
119        /// An object containing memory metrics for this application.
120        #[unsafe(method(memoryMetrics))]
121        #[unsafe(method_family = none)]
122        pub unsafe fn memoryMetrics(&self) -> Option<Retained<MXMemoryMetric>>;
123
124        #[cfg(all(feature = "MXDisplayMetric", feature = "MXMetric"))]
125        /// An object containing display metrics for this application.
126        #[unsafe(method(displayMetrics))]
127        #[unsafe(method_family = none)]
128        pub unsafe fn displayMetrics(&self) -> Option<Retained<MXDisplayMetric>>;
129
130        #[cfg(all(feature = "MXAnimationMetric", feature = "MXMetric"))]
131        /// An object containing animation metrics for this application.
132        #[unsafe(method(animationMetrics))]
133        #[unsafe(method_family = none)]
134        pub unsafe fn animationMetrics(&self) -> Option<Retained<MXAnimationMetric>>;
135
136        #[cfg(all(feature = "MXAppExitMetric", feature = "MXMetric"))]
137        /// An object containing exit metrics for this application.
138        #[unsafe(method(applicationExitMetrics))]
139        #[unsafe(method_family = none)]
140        pub unsafe fn applicationExitMetrics(&self) -> Option<Retained<MXAppExitMetric>>;
141
142        #[cfg(all(feature = "MXMetric", feature = "MXSignpostMetric"))]
143        /// An array containing signpost metrics for this application.
144        #[unsafe(method(signpostMetrics))]
145        #[unsafe(method_family = none)]
146        pub unsafe fn signpostMetrics(&self) -> Option<Retained<NSArray<MXSignpostMetric>>>;
147
148        #[cfg(feature = "MXMetaData")]
149        /// An object containing extra metadata for this payload.
150        #[unsafe(method(metaData))]
151        #[unsafe(method_family = none)]
152        pub unsafe fn metaData(&self) -> Option<Retained<MXMetaData>>;
153
154        /// Convenience method to return a JSON representation of this payload.
155        ///
156        /// Returns: An NSData object containing the JSON representation
157        #[unsafe(method(JSONRepresentation))]
158        #[unsafe(method_family = none)]
159        pub unsafe fn JSONRepresentation(&self) -> Retained<NSData>;
160
161        /// Convenience method to return a NSDictionary representation of this payload.
162        ///
163        /// Returns: An NSDictionary object containing the dictionary representation
164        #[deprecated]
165        #[unsafe(method(DictionaryRepresentation))]
166        #[unsafe(method_family = none)]
167        pub unsafe fn DictionaryRepresentation(&self) -> Retained<NSDictionary>;
168
169        /// Convenience method to return a NSDictionary representation of this payload.
170        ///
171        /// Returns: An NSDictionary object containing the dictionary representation
172        #[unsafe(method(dictionaryRepresentation))]
173        #[unsafe(method_family = none)]
174        pub unsafe fn dictionaryRepresentation(&self) -> Retained<NSDictionary>;
175    );
176}
177
178/// Methods declared on superclass `NSObject`.
179impl MXMetricPayload {
180    extern_methods!(
181        #[unsafe(method(init))]
182        #[unsafe(method_family = init)]
183        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
184
185        #[unsafe(method(new))]
186        #[unsafe(method_family = new)]
187        pub unsafe fn new() -> Retained<Self>;
188    );
189}
objc2_metric_kit/generated/MXMetricPayload.rs

objc2_metric_kit/generated/
MXMetricPayload.rs
