objc2_intents/generated/
INMediaUserContext.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::ffi::*;
4use core::ptr::NonNull;
5use objc2::__framework_prelude::*;
6use objc2_foundation::*;
7
8use crate::*;
9
10/// [Apple's documentation](https://developer.apple.com/documentation/intents/inmediausercontextsubscriptionstatus?language=objc)
11// NS_ENUM
12#[repr(transparent)]
13#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
14pub struct INMediaUserContextSubscriptionStatus(pub NSInteger);
15impl INMediaUserContextSubscriptionStatus {
16    /// The app does not offer subscriptions, or the subscription status is unavailable
17    #[doc(alias = "INMediaUserContextSubscriptionStatusUnknown")]
18    pub const Unknown: Self = Self(0);
19    /// The user is not a subscriber, but subscriptions are offered
20    #[doc(alias = "INMediaUserContextSubscriptionStatusNotSubscribed")]
21    pub const NotSubscribed: Self = Self(1);
22    /// The user is registered with a subscription (free, trial, or paid)
23    #[doc(alias = "INMediaUserContextSubscriptionStatusSubscribed")]
24    pub const Subscribed: Self = Self(2);
25}
26
27unsafe impl Encode for INMediaUserContextSubscriptionStatus {
28    const ENCODING: Encoding = NSInteger::ENCODING;
29}
30
31unsafe impl RefEncode for INMediaUserContextSubscriptionStatus {
32    const ENCODING_REF: Encoding = Encoding::Pointer(&Self::ENCODING);
33}
34
35extern_class!(
36    /// [Apple's documentation](https://developer.apple.com/documentation/intents/inmediausercontext?language=objc)
37    #[unsafe(super(INUserContext, NSObject))]
38    #[derive(Debug, PartialEq, Eq, Hash)]
39    #[cfg(feature = "INUserContext")]
40    pub struct INMediaUserContext;
41);
42
43#[cfg(feature = "INUserContext")]
44extern_conformance!(
45    unsafe impl NSCoding for INMediaUserContext {}
46);
47
48#[cfg(feature = "INUserContext")]
49extern_conformance!(
50    unsafe impl NSObjectProtocol for INMediaUserContext {}
51);
52
53#[cfg(feature = "INUserContext")]
54extern_conformance!(
55    unsafe impl NSSecureCoding for INMediaUserContext {}
56);
57
58#[cfg(feature = "INUserContext")]
59impl INMediaUserContext {
60    extern_methods!(
61        #[unsafe(method(init))]
62        #[unsafe(method_family = init)]
63        pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>;
64
65        /// Used as a signal of user affinity for the app
66        #[unsafe(method(subscriptionStatus))]
67        #[unsafe(method_family = none)]
68        pub unsafe fn subscriptionStatus(&self) -> INMediaUserContextSubscriptionStatus;
69
70        /// Setter for [`subscriptionStatus`][Self::subscriptionStatus].
71        #[unsafe(method(setSubscriptionStatus:))]
72        #[unsafe(method_family = none)]
73        pub unsafe fn setSubscriptionStatus(
74            &self,
75            subscription_status: INMediaUserContextSubscriptionStatus,
76        );
77
78        /// Approximate number of relevant items available in the user's library (playlists, songs, podcasts, albums, etc.) - used as a signal of user affinity for the app
79        #[unsafe(method(numberOfLibraryItems))]
80        #[unsafe(method_family = none)]
81        pub unsafe fn numberOfLibraryItems(&self) -> Option<Retained<NSNumber>>;
82
83        /// Setter for [`numberOfLibraryItems`][Self::numberOfLibraryItems].
84        ///
85        /// This is [copied][objc2_foundation::NSCopying::copy] when set.
86        #[unsafe(method(setNumberOfLibraryItems:))]
87        #[unsafe(method_family = none)]
88        pub unsafe fn setNumberOfLibraryItems(&self, number_of_library_items: Option<&NSNumber>);
89    );
90}
91
92/// Methods declared on superclass `NSObject`.
93#[cfg(feature = "INUserContext")]
94impl INMediaUserContext {
95    extern_methods!(
96        #[unsafe(method(new))]
97        #[unsafe(method_family = new)]
98        pub unsafe fn new() -> Retained<Self>;
99    );
100}