Struct TVUserManager 

pub struct TVUserManager { /* private fields */ }

Available on crate feature TVUserManager only.

An object that provides facilities to best handle system users as it relates to their preferences like app-specific profiles.

Applications sometimes have their own notion of a “profile”, to track users’ preferences or other state. Those applications can rely on tvOS to handle separating each user’s data by adopting the “Runs as Current User” entitlement, with this entitlement reading and writing data will happen for the selected user.

Note: When running as the current user each user would have to sign in again to the app, to avoid that behavior it is highly recommended that those apps also use kSecUseUserIndependentKeychain to store their account credentials across users.

See also Apple’s documentation

Implementations

impl TVUserManager

pub unsafe fn shouldStorePreferencesForCurrentUser(&self) -> bool

Indicates if the system recommends that the app saves the user’s preferences.

Apps with the User Management capability “Runs as Current User” should remember the user’s choices, like which profile they use, that way people will immediately see the content they want without any interruptions like having to pick their profile again.

You can safely assume that storing the user’s preferences is the desirable behavior. In some situations though it might not be, and this method represents when the system believe it best to continue to, for example, show the profile picker.

This property will return NO if there is only one Apple TV user, or if your app doesn’t have the capability of running as the current user.

Note: If your app is deployed on tvOS 15 or earlier, you should treat those as if this property is returning NO.

pub unsafe fn currentUserIdentifier(&self) -> Option<Retained<TVUserIdentifier>>

👎Deprecated: User Management capability get-current-user is no longer supported. Please use runs-as-current-user-with-user-independent-keychain and kSecUseUserIndependentKeychain for sharing keychain items across users.

Retrieve the identifier for the current system user.

This value may be nil if no value is available to the application. When this is nil or the application has no existing mapping from the user to a preferred profile, the application can put up its profile picker or adopt some other appropriate behavior. For users which are part of the Home this Apple TV is in, this value is the same on all the Apple TVs that are part of that Home. This property is KVO-observable, to watch for changes. You will need to hold onto a TVUserManager instance to observe this property on it.

pub unsafe fn userIdentifiersForCurrentProfile( &self, ) -> Retained<NSArray<TVUserIdentifier>>

👎Deprecated: User Management capability get-current-user is no longer supported. Please use runs-as-current-user-with-user-independent-keychain and kSecUseUserIndependentKeychain for sharing keychain items across users.

Tell the system the user identifiers to which the current profile corresponds.

The value should be an NSArray with the system user identifiers that prefer the current profile in the application. An application which is maintaining system user identifer to profile mappings should write a new value to this set whenever the user changes the current profile within the application. The value of this property can be read, but it simply contains the last value stored in it, and starts empty when an application launches. This property is KVO-observable, to watch for changes. You will need to hold onto a TVUserManager instance to observe this property on it.

pub unsafe fn setUserIdentifiersForCurrentProfile( &self, user_identifiers_for_current_profile: &NSArray<TVUserIdentifier>, )

👎Deprecated: User Management capability get-current-user is no longer supported. Please use runs-as-current-user-with-user-independent-keychain and kSecUseUserIndependentKeychain for sharing keychain items across users.

Setter for userIdentifiersForCurrentProfile.

This is copied when set.

pub unsafe fn presentProfilePreferencePanelWithCurrentSettings_availableProfiles_completion( &self, current_settings: &NSDictionary<TVUserIdentifier, TVAppProfileDescriptor>, available_profiles: &NSArray<TVAppProfileDescriptor>, completion: &DynBlock<dyn Fn(NonNull<NSDictionary<TVUserIdentifier, TVAppProfileDescriptor>>)>, )

👎Deprecated: User Management capability get-current-user is no longer supported. Please use runs-as-current-user-with-user-independent-keychain and kSecUseUserIndependentKeychain for sharing keychain items across users.

Available on crate features TVAppProfileDescriptor and block2 only.

Present a user-to-profile configuration panel to the user.

Parameter currentSettings: All the mappings of system user identifiers to their preferred profile string labels that the application currently has. Profile descriptors with no name (or empty string) are ignored, along with the mapping in the dictionary. Profile descriptors which have names that aren’t also in the availableProfiles list are ignored, along with the mapping in the dictionary. Ignored mappings will not be present in the resulting newSettings dictionary. It is not required that the profile descriptor values in the dictionary are the exact instances in the availableProfiles list.

Parameter availableProfiles: A list of profile descriptors initialized with the third-party in-app profiles currently available in the application, from which the user can choose in the user interface. Profile descriptors with no name (or empty string) are ignored. Duplicate profile descriptors are ignored.

Parameter completion: A block to be called when the user interface is dismissed. The dictionary argument to the block will give the new settings as changed by the user. Note that entries in the original settings argument may be missing in the new dictionary, if the user set the preferred profile for a user back to the “no preference” setting. The descriptor objects in the dictionary argument of the completion block come from among the specific instances in the availableProfiles input argument. In other words, the instances in the availableProfiles array are preserved through to the argument to the completion block, and the values of the input existingSettings dictionary are not (unless they happen to be the same objects that appear in the availableProfiles list), but neither are entirely new TVAppProfileDescriptor objects manufactured.

The system will present a panel to the user which allows the user to configure all the preferred profiles for this application for all users on the system. Once the user dismisses the panel, the completion callback will give the new settings, which should be saved by the application. The application should invoke this method from some place in its user interface, perhaps a button in the app’s “settings” area. The completion block is executed on an arbitrary dispatch queue / thread. If invoked from within an extension, no UI will be presented and the dictionary parameter to the callback will be empty.

pub unsafe fn shouldStorePreferenceForCurrentUserToProfile_completion( &self, profile: &TVAppProfileDescriptor, completion: &DynBlock<dyn Fn(Bool)>, )

👎Deprecated: User Management capability get-current-user is no longer supported. Please use runs-as-current-user-with-user-independent-keychain and kSecUseUserIndependentKeychain for sharing keychain items across users.

Available on crate features TVAppProfileDescriptor and block2 only.

Ask the system if a new mapping from the current system user to a user-chosen profile should be created.

Parameter profile: A profile descriptor initialized with the third-party in-app profile information. If the profile descriptor has no name or an empty string name, the answer to the completion block will be NO.

Parameter completion: A block to be called upon completion of the request. The parameter of the block indicates whether or not the application should create a mapping or skip it.

An application uses this method to confirm with the system that the application should adopt a profile chosen from a profile picker as the preferred profile for that user identifier. The system will usually then ask the user with some user interface what the user wants to do. If the answer is NO, the application should not store the chosen profile as the user’s preferred profile. An application should only ask this once per user identifier and profile pair, so even if the answer is NO, the application needs to record that the system has been asked, for that identifier + profile pair. The completion block is executed on an arbitrary dispatch queue / thread. If invoked from within an extension, no UI will be presented and the result will always be NO.

impl TVUserManager

Methods declared on superclass NSObject.

pub unsafe fn init(this: Allocated<Self>) -> Retained<Self>

pub unsafe fn new() -> Retained<Self>

Methods from Deref<Target = NSObject>

pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>

pub fn class(&self) -> &'static AnyClass

Dynamically find the class of this object.

Panics

May panic if the object is invalid (which may be the case for objects returned from unavailable init/new methods).

Example

Check that an instance of NSObject has the precise class NSObject.

use objc2::ClassType;
use objc2::runtime::NSObject;

let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());

pub unsafe fn get_ivar<T>(&self, name: &str) -> &T

where T: Encode,

👎Deprecated: this is difficult to use correctly, use Ivar::load instead.

Use Ivar::load instead.

Safety

The object must have an instance variable with the given name, and it must be of type T.

See Ivar::load_ptr for details surrounding this.

pub fn downcast_ref<T>(&self) -> Option<&T>

where T: DowncastTarget,

Attempt to downcast the object to a class of type T.

This is the reference-variant. Use Retained::downcast if you want to convert a retained object to another type.

Mutable classes

Some classes have immutable and mutable variants, such as NSString and NSMutableString.

When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable “under the hood”.

So using this method to convert a NSString to a NSMutableString, while not unsound, is generally frowned upon unless you created the string yourself, or the API explicitly documents the string to be mutable.

See Apple’s documentation on mutability and on isKindOfClass: for more details.

Generic classes

Objective-C generics are called “lightweight generics”, and that’s because they aren’t exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.

You can, however, safely downcast to generic collections where all the type-parameters are AnyObject.

Panics

This works internally by calling isKindOfClass:. That means that the object must have the instance method of that name, and an exception will be thrown (if CoreFoundation is linked) or the process will abort if that is not the case. In the vast majority of cases, you don’t need to worry about this, since both root objects NSObject and NSProxy implement this method.

Examples

Cast an NSString back and forth from NSObject.

use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};

let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();

Try (and fail) to cast an NSObject to an NSString.

use objc2_foundation::{NSObject, NSString};

let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());

Try to cast to an array of strings.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();

This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.

Downcast when processing each element instead.

use objc2_foundation::{NSArray, NSObject, NSString};

let arr = NSArray::from_retained_slice(&[NSObject::new()]);

for elem in arr {
    if let Some(data) = elem.downcast_ref::<NSString>() {
        // handle `data`
    }
}

Trait Implementations

impl AsRef<AnyObject> for TVUserManager

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<NSObject> for TVUserManager

fn as_ref(&self) -> &NSObject

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<TVUserManager> for TVUserManager

fn as_ref(&self) -> &Self

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<AnyObject> for TVUserManager

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for TVUserManager

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for TVUserManager

const NAME: &'static str = "TVUserManager"

The name of the Objective-C class that this type represents.

type Super = NSObject

The superclass of this class.

type ThreadKind = <<TVUserManager as ClassType>::Super as ClassType>::ThreadKind

Whether the type can be used from any thread, or from only the main thread.

fn class() -> &'static AnyClass

Get a reference to the Objective-C class that this type represents.

fn as_super(&self) -> &Self::Super

Get an immutable reference to the superclass.

impl Debug for TVUserManager

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for TVUserManager

type Target = NSObject

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Hash for TVUserManager

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Message for TVUserManager

fn retain(&self) -> Retained<Self>

where Self: Sized,

Increment the reference count of the receiver.

impl NSObjectProtocol for TVUserManager

fn isEqual(&self, other: Option<&AnyObject>) -> bool

where Self: Sized + Message,

Check whether the object is equal to an arbitrary other object.

fn hash(&self) -> usize

where Self: Sized + Message,

An integer that can be used as a table address in a hash table structure.

fn isKindOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of the class, or one of its subclasses.

fn is_kind_of<T>(&self) -> bool

where T: ClassType, Self: Sized + Message,

👎Deprecated: use isKindOfClass directly, or cast your objects with AnyObject::downcast_ref

Check if the object is an instance of the class type, or one of its subclasses.

fn isMemberOfClass(&self, cls: &AnyClass) -> bool

where Self: Sized + Message,

Check if the object is an instance of a specific class, without checking subclasses.

fn respondsToSelector(&self, aSelector: Sel) -> bool

where Self: Sized + Message,

Check whether the object implements or inherits a method with the given selector.

fn conformsToProtocol(&self, aProtocol: &AnyProtocol) -> bool

where Self: Sized + Message,

Check whether the object conforms to a given protocol.

fn description(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object.

fn debugDescription(&self) -> Retained<NSObject>

where Self: Sized + Message,

A textual representation of the object to use when debugging.

fn isProxy(&self) -> bool

where Self: Sized + Message,

Check whether the receiver is a subclass of the NSProxy root class instead of the usual NSObject.

fn retainCount(&self) -> usize

where Self: Sized + Message,

The reference count of the object.

impl PartialEq for TVUserManager

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefEncode for TVUserManager

const ENCODING_REF: Encoding = <NSObject as ::objc2::RefEncode>::ENCODING_REF

The Objective-C type-encoding for a reference of this type.

impl DowncastTarget for TVUserManager

impl Eq for TVUserManager