Struct UIEventAttribution

Source

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

Available on crate feature UIEventAttribution only.

Expand description

Apple’s documentation

Implementations§

Source §

impl UIEventAttribution

Source

pub unsafe fn sourceIdentifier(&self) -> u8

An identifier that is associated with the source of the attribution. For example, you may choose to use this as a campaign identifier to measure the effectiveness of different advertisement campaigns.

This field corresponds to source_id in the subsequent attribution report.

Source

pub unsafe fn destinationURL(&self) -> Retained<NSURL>

The destination URL of an attribution. For example, the link opened when an advertisement is tapped.

This field corresponds to attributed_on_site in the subsequent attribution report.

Source

pub unsafe fn reportEndpoint(&self) -> Option<Retained<NSURL>>

The URL to which the attribution report will be sent. You do not provide this field at creation time. Instead, you must define the URL as a string in your app’s Info.plist under the NSAdvertisingAttributionReportEndpoint key.

This field corresponds to source_site in the subsequent attribution report.

Source

pub unsafe fn sourceDescription(&self) -> Retained<NSString>

A high-level description of the source of the attribution. For example, this could be a description of the content of an advertisement a user taps on.

The system may truncate this field if it is too long.

Source

pub unsafe fn purchaser(&self) -> Retained<NSString>

The name of the party that purchased the content to be attributed. For example, this could be the name of the party that purchased the placement of an advertisement.

The system may truncate this field if it is too long.

Source

pub unsafe fn initWithSourceIdentifier_destinationURL_sourceDescription_purchaser( this: Allocated<Self>, source_identifier: u8, destination_url: &NSURL, source_description: &NSString, purchaser: &NSString, ) -> Retained<Self>

Create a UIEventAttribution object.

Parameter sourceIdentifier: An identifier associated with the attribution.

Parameter destinationURL: The destination URL of the attribution.

Parameter sourceDescription: A high-level description of the content to be attributed. Pass in an empty string if no description is available.

Parameter purchaser: The name of the party that purchased the content to be attributed. Pass in an empty string if no name is available.

Returns: An instance of UIEventAttribution with the specified values for each field.

The sourceDescription and purchaser fields may be truncated by the system if they are too long.

Source

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

Source

pub unsafe fn new(mtm: MainThreadMarker) -> 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

Available on crate feature UIIndirectScribbleInteraction only.

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.

Available on crate feature UIIndirectScribbleInteraction only.

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,

Available on crate feature UIIndirectScribbleInteraction only.

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