Struct ASIdentifierManager

Source

#[repr(C)]
pub struct ASIdentifierManager { /* private fields */ }

Available on crate feature ASIdentifierManager only.

Expand description

The object that contains the advertising identifier.

Implementations§

Source §

impl ASIdentifierManager

Source

pub unsafe fn sharedManager() -> Retained<ASIdentifierManager>

The shared instance of the identifier manager class.

Returns: Returns the shared instance of the AdSupport identifier manager class.

Source

pub unsafe fn advertisingIdentifier(&self) -> Retained<NSUUID>

The UUID that is specific to a device.

The ASIdentifierManager/advertisingIdentifier is an alphanumeric string that’s unique to each device, and which you only use for advertising. Use this string for frequency capping, attribution, conversion events, estimating the number of unique users, advertising fraud detection, and debugging. On devices running iOS 14.5 and later and iPadOS 14.5 and later, your app must request tracking authorization before it can get the advertising identifier. For more information on getting the advertising identifier, see AdSupport.

The advertising identifier returns either a unique UUID, or all zeros. It returns a unique UUID in the following cases:

If Settings

Privacy

Tracking

Allow Apps to Request to Track is On, you’ve requested tracking authorization from the user by calling the <doc ://com.apple.documentation/documentation/apptrackingtransparency> APIs, and received authorization, indicated by <doc ://com.apple.documentation/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus/authorized>.

If the user changes Settings

Privacy

Tracking

Allow Apps to Request to Track to Off after authorizing your app, and leaves the permissions On for your app.

The advertising identifier returns all zeros (00000000-0000-0000-0000-000000000000) in the following cases:

In Simulator, regardless of any settings.
When you call this API on a device running macOS.
When you call this API in a compatible iPad or iPhone app running in visionOS.
On devices running iOS 14.5 and later and iPadOS 14.5 and later, if you haven’t requested authorization using the <doc ://com.apple.documentation/documentation/apptrackingtransparency> framework.
If you’ve requested authorization using the <doc ://com.apple.documentation/documentation/apptrackingtransparency> framework and the user declines, which results in an authorization status of <doc ://com.apple.documentation/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus/denied>.
When a profile or configuration restricts access to the advertising identifier. For more information about restrictions, see <doc ://com.apple.documentation/documentation/apptrackingtransparency/attrackingmanager/authorizationstatus/restricted>.

As a best practice, don’t store the advertising identifier value; access ASIdentifierManager/advertisingIdentifier instead. Users can change their authorization for tracking at any time in Settings

Privacy

Tracking. Check your app’s authorization using the App Tracking Transparency API <doc ://com.apple.documentation/documentation/apptrackingtransparency/attrackingmanager/3547038-trackingauthorizationstatus> to determine the user’s intent.

For more information about asking users for permission to track, see User Privacy and Data Use.

Source

pub unsafe fn isAdvertisingTrackingEnabled(&self) -> bool

👎Deprecated: This has been replaced by functionality in AppTrackingTransparency’s ATTrackingManager class.

A Boolean value that indicates whether the user has limited ad tracking enabled.

Warning: This property is deprecated. Functionality has been replaced by the <doc ://com.apple.documentation/documentation/apptrackingtransparency> framework.

Source §

impl ASIdentifierManager

Methods declared on superclass NSObject.

Source

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

Source

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

Methods from Deref<Target = NSObject>§

Source

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

Handle messages the object doesn’t recognize.

See Apple’s documentation for details.

Methods from Deref<Target = AnyObject>§

Source

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());

Source

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.

Source

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`
    }
}