Struct GKChallengeDefinition

Source

pub struct GKChallengeDefinition { /* private fields */ }

Available on crate feature GKChallengeDefinition only.

Expand description

Apple’s documentation

Implementations§

Source §

impl GKChallengeDefinition

Source

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

The developer defined identifier for a given challenge definition.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

The group identifier for the challenge definition, if one exists.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

A short title for the challenge definition.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

A more detailed description of the challenge definition.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn durationOptions(&self) -> Retained<NSArray<NSDateComponents>>

The duration options for the challenge, like 1 day or 1 week.

Note: If set, the amount of weeks is stored in the weekOfYear field.
Important: The actual duration of the challenge may be dynamically adjusted in order to accommodate different factors like players’ timezones.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn isRepeatable(&self) -> bool

Indicates if a challenge can be attempted more than once.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn leaderboard(&self) -> Option<Retained<GKLeaderboard>>

Available on crate feature GKLeaderboard only.

Scores submitted to this leaderboard will also be submitted as scores in this challenge.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn releaseState(&self) -> GKReleaseState

Available on crate feature GKReleaseState only.

The release state of the challenge definition in App Store Connect.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn loadImageWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(mut NSImage, mut NSError)>, )

Available on crate feature block2 and crate feature objc2-app-kit and macOS only.

Loads the image set on the challenge definition, which may be nil if none was set.

Source §

impl GKChallengeDefinition

Methods declared on superclass NSObject.

Source

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

Source

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

Source §

impl GKChallengeDefinition

State.

Source

pub unsafe fn loadChallengeDefinitionsWithCompletionHandler( completion_handler: &DynBlock<dyn Fn(mut NSArray<GKChallengeDefinition>, mut NSError)>, )

Available on crate feature block2 only.

Loads all the challenge definitions for the current game, returns an empty array if none exist.

Important: Archived challenge definitions are excluded.

Source

pub unsafe fn hasActiveChallengesWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(Bool, *mut NSError)>, )

Available on crate feature block2 only.

Indicates if this definition has active challenges associated with it.

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