Struct GKGameActivityDefinition

Source

pub struct GKGameActivityDefinition { /* private fields */ }

Available on crate feature GKGameActivityDefinition only.

Expand description

Apple’s documentation

Implementations§

Source §

impl GKGameActivityDefinition

Source

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

The developer defined identifier for a given game activity.

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 activity, 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 game activity.

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 game activity.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn defaultProperties( &self, ) -> Retained<NSDictionary<NSString, NSString>>

Default properties defined by the developer for this type of game activity.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

A fallback URL that can be used to construct a game-specific URL for players to share or join, if the joining device does not support the default URL.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn supportsPartyCode(&self) -> bool

Whether the activity can be joined by others via a party code.

SeeAlso: -[GKGameActivityListener player:wantsToPlayGameActivity:completionHandler:] where you can receive and handle game activities that players want to play in a party with friends.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn maxPlayers(&self) -> Option<Retained<NSNumber>>

The maximum number of participants that can join the activity. Returns nil when no maximum is set (unlimited players) or when player range is undefined. When not nil, the value is always greater than or equal to minPlayers.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn minPlayers(&self) -> Option<Retained<NSNumber>>

The minimum number of participants that can join the activity.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn supportsUnlimitedPlayers(&self) -> bool

True if the activity supports an unlimited number of players. False if maxPlayers is set to a defined limit or if no player range is provided.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

pub unsafe fn playStyle(&self) -> GKGameActivityPlayStyle

Available on crate feature GKGameActivityPlayStyle only.

The play style of the game activity.

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 game activity definition in App Store Connect.

This property is not atomic.

§Safety

This might not be thread-safe.

Source

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

Source

pub unsafe fn loadAchievementDescriptionsWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(mut NSArray<GKAchievementDescription>, mut NSError)>, )

Available on crate features GKAchievementDescription and block2 only.

Loads all associated achievements that have defined deep links to this game activity definition.

Source

pub unsafe fn loadLeaderboardsWithCompletionHandler( &self, completion_handler: &DynBlock<dyn Fn(mut NSArray<GKLeaderboard>, mut NSError)>, )

Available on crate features GKLeaderboard and block2 only.

Loads all associated leaderboards that have defined deep links to this game activity definition.

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.

Asynchronously load the image. Error will be nil on success.

Source §

impl GKGameActivityDefinition

Methods declared on superclass NSObject.

Source

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

Source §

impl GKGameActivityDefinition

State.

Source

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

Available on crate feature block2 only.

Loads all the game activity definitions for the current game.

Source

pub unsafe fn loadGameActivityDefinitionsWithIDs_completionHandler( activity_definition_i_ds: Option<&NSArray<NSString>>, completion_handler: &DynBlock<dyn Fn(mut NSArray<GKGameActivityDefinition>, mut NSError)>, )

Available on crate feature block2 only.

Loads game activity definitions with the supplied App Store Connect identifiers.

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