Struct GKAchievement 

pub struct GKAchievement { /* private fields */ }

Available on crate feature GKAchievement only.

Apple’s documentation

Implementations

impl GKAchievement

pub unsafe fn loadAchievementsWithCompletionHandler( completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<GKAchievement>, *mut NSError)>>, )

Available on crate feature block2 only.

Asynchronously load all achievements for the local player

pub unsafe fn resetAchievementsWithCompletionHandler( completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Reset the achievements progress for the local player. All the entries for the local player are removed from the server. Error will be nil on success. Possible reasons for error:

1. Local player not authenticated
2. Communications failure

pub unsafe fn initWithIdentifier( this: Allocated<Self>, identifier: &NSString, ) -> Retained<Self>

Designated initializer

pub unsafe fn initWithIdentifier_player( this: Allocated<Self>, identifier: &NSString, player: &GKPlayer, ) -> Retained<Self>

Available on crate features GKBasePlayer and GKPlayer only.

Initialize the achievement for a specific player. Use to submit participant achievements when ending a turn-based match.

pub unsafe fn reportAchievements_withCompletionHandler( achievements: &NSArray<GKAchievement>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

Available on crate feature block2 only.

Report an array of achievements to the server. Percent complete is required. Points, completed state are set based on percentComplete. isHidden is set to NO anytime this method is invoked. Date is optional. Error will be nil on success. Possible reasons for error:

1. Local player not authenticated
2. Communications failure
3. Reported Achievement does not exist

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

Achievement identifier

pub unsafe fn setIdentifier(&self, identifier: &NSString)

Setter for identifier.

This is copied when set.

pub unsafe fn percentComplete(&self) -> c_double

Required, Percentage of achievement complete.

pub unsafe fn setPercentComplete(&self, percent_complete: c_double)

Setter for percentComplete.

pub unsafe fn isCompleted(&self) -> bool

Set to NO until percentComplete = 100.

pub unsafe fn lastReportedDate(&self) -> Retained<NSDate>

Date the achievement was last reported. Read-only. Created at initialization

pub unsafe fn showsCompletionBanner(&self) -> bool

A banner will be momentarily displayed after reporting a completed achievement

pub unsafe fn setShowsCompletionBanner(&self, shows_completion_banner: bool)

Setter for showsCompletionBanner.

pub unsafe fn player(&self) -> Retained<GKPlayer>

Available on crate features GKBasePlayer and GKPlayer only.

The identifier of the player that earned the achievement.

impl GKAchievement

Methods declared on superclass NSObject.

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

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

impl GKAchievement

Deprecated.

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

👎Deprecated

Available on crate feature block2 only.

pub unsafe fn isHidden(&self) -> bool

👎Deprecated

impl GKAchievement

Obsoleted.

pub unsafe fn initWithIdentifier_forPlayer( this: Allocated<Self>, identifier: Option<&NSString>, player_id: &NSString, ) -> Option<Retained<Self>>

👎Deprecated

• This method is obsolete. Calling this initializer does nothing and will return nil **

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

👎Deprecated

• This property is obsolete. **

impl GKAchievement

GKChallenge.

pub unsafe fn selectChallengeablePlayers_withCompletionHandler( &self, players: &NSArray<GKPlayer>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<GKPlayer>, *mut NSError)>>, )

👎Deprecated

Available on crate features GKChallenge and GKBasePlayer and GKPlayer and block2 only.

Given a list of players, return a subset of that list containing only players that are eligible to receive a challenge for the achievement.

pub unsafe fn reportAchievements_withEligibleChallenges_withCompletionHandler( achievements: &NSArray<GKAchievement>, challenges: &NSArray<GKChallenge>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSError)>>, )

👎Deprecated

Available on crate features GKChallenge and block2 only.

Use this alternative to reportAchievements:withCompletionHandler: to allow only certain specific challenges to be completed. Pass nil to avoid completing any challenges.

impl GKAchievement

GKChallengeObsoleted.

pub unsafe fn issueChallengeToPlayers_message( &self, player_i_ds: Option<&NSArray<NSString>>, message: Option<&NSString>, )

👎Deprecated

Available on crate feature GKChallenge only.

• This method is obsolete. It will never be invoked and its implementation does nothing**

pub unsafe fn selectChallengeablePlayerIDs_withCompletionHandler( &self, player_i_ds: Option<&NSArray<NSString>>, completion_handler: Option<&DynBlock<dyn Fn(*mut NSArray<NSString>, *mut NSError)>>, )

👎Deprecated: This method is obsolete.

Available on crate features GKChallenge and block2 only.

• This method is obsolete. It will never be invoked and its implementation does nothing**

impl GKAchievement

GKChallengeUI.

pub unsafe fn challengeComposeControllerWithMessage_players_completionHandler( &self, message: Option<&NSString>, players: &NSArray<GKPlayer>, completion_handler: GKChallengeComposeCompletionBlock, mtm: MainThreadMarker, ) -> Retained<NSViewController>

👎Deprecated

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

Safety

completion_handler must be a valid pointer or null.

pub unsafe fn challengeComposeControllerWithMessage_players_completion( &self, message: Option<&NSString>, players: &NSArray<GKPlayer>, completion_handler: GKChallengeComposeHandler, mtm: MainThreadMarker, ) -> Retained<NSViewController>

👎Deprecated

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

Safety

completion_handler must be a valid pointer or null.

impl GKAchievement

GKChallengeObsoletedUI.

pub unsafe fn challengeComposeControllerWithPlayers_message_completionHandler( &self, player_i_ds: Option<&NSArray<NSString>>, message: Option<&NSString>, completion_handler: GKChallengeComposeCompletionBlock, mtm: MainThreadMarker, ) -> Option<Retained<NSViewController>>

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

• This method is obsolete. Calling this method does nothing and will return nil **

Safety

completion_handler must be a valid pointer or null.

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 GKAchievement

fn as_ref(&self) -> &AnyObject

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

impl AsRef<GKAchievement> for GKAchievement

fn as_ref(&self) -> &Self

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

impl AsRef<NSObject> for GKAchievement

fn as_ref(&self) -> &NSObject

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

impl Borrow<AnyObject> for GKAchievement

fn borrow(&self) -> &AnyObject

Immutably borrows from an owned value.

impl Borrow<NSObject> for GKAchievement

fn borrow(&self) -> &NSObject

Immutably borrows from an owned value.

impl ClassType for GKAchievement

const NAME: &'static str = "GKAchievement"

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

type Super = NSObject

The superclass of this class.

type ThreadKind = <<GKAchievement 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 GKAchievement

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

Formats the value using the given formatter.

impl Deref for GKAchievement

type Target = NSObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Hash for GKAchievement

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 GKAchievement

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

where Self: Sized,

Increment the reference count of the receiver.

impl NSCoding for GKAchievement

unsafe fn encodeWithCoder(&self, coder: &NSCoder)

where Self: Sized + Message,

Safety

unsafe fn initWithCoder( this: Allocated<Self>, coder: &NSCoder, ) -> Option<Retained<Self>>

where Self: Sized + Message,

Safety

impl NSObjectProtocol for GKAchievement

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 NSSecureCoding for GKAchievement

fn supportsSecureCoding() -> bool

where Self: Sized + ClassType,

impl PartialEq for GKAchievement

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 GKAchievement

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

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

impl DowncastTarget for GKAchievement

impl Eq for GKAchievement