Struct GKAccessPoint

Source

pub struct GKAccessPoint { /* private fields */ }

Available on crate feature GKAccessPoint only.

Expand description

Apple’s documentation

Implementations§

Source §

impl GKAccessPoint

Source

pub unsafe fn shared() -> Retained<GKAccessPoint>

Source

pub unsafe fn isActive(&self) -> bool

set this true to enable access point in your app. Setting this will cause the access point to appear after the notification banner is presented. If it already was presented it will appear immediately

Source

pub unsafe fn setActive(&self, active: bool)

Setter for isActive.

Source

pub unsafe fn isFocused(&self) -> bool

set this on tvOS to put the accessPoint into focused mode

Source

pub unsafe fn setFocused(&self, focused: bool)

Setter for isFocused.

Source

pub unsafe fn isVisible(&self) -> bool

Source

pub unsafe fn isPresentingGameCenter(&self) -> bool

observable property that indicates when the access point is visible.

Source

pub unsafe fn showHighlights(&self) -> bool

👎Deprecated: No longer supported

Set this property to true if you wish to show the highlights for most recent achievement, current rank on default leaderboard, etc

Source

pub unsafe fn setShowHighlights(&self, show_highlights: bool)

👎Deprecated: No longer supported

Setter for showHighlights.

Source

pub unsafe fn location(&self) -> GKAccessPointLocation

These properties control the placement of the widget

Source

pub unsafe fn setLocation(&self, location: GKAccessPointLocation)

Setter for location.

Source

pub unsafe fn frameInScreenCoordinates(&self) -> NSRect

observable property that contains the current frame needed to display the widget

Source

pub unsafe fn parentWindow( &self, mtm: MainThreadMarker, ) -> Option<Retained<NSWindow>>

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

the following is a platform specific window that you wish to have the access point in. If not set then a best attempt will be made to choose the main window of the app.

Source

pub unsafe fn setParentWindow(&self, parent_window: Option<&NSWindow>)

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

Setter for parentWindow.

This is a weak property.

Source

pub unsafe fn triggerAccessPointWithHandler(&self, handler: &DynBlock<dyn Fn()>)

Available on crate feature block2 only.

this lets the developer trigger the access point as if the user had touched it. This is useful for games that use controllers or the remote on AppleTV. the argument lets you specify a specific state (default, profile, achievements, leaderboards) for GameCenterViewController

Source

pub unsafe fn triggerAccessPointWithState_handler( &self, state: GKGameCenterViewControllerState, handler: &DynBlock<dyn Fn()>, )

Available on crate features GKGameCenterViewController and block2 only.

Source

pub unsafe fn triggerAccessPointWithAchievementID_handler( &self, achievement_id: &NSString, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Source

pub unsafe fn triggerAccessPointWithLeaderboardSetID_handler( &self, leaderboard_set_id: &NSString, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Source

pub unsafe fn triggerAccessPointWithLeaderboardID_playerScope_timeScope_handler( &self, leaderboard_id: &NSString, player_scope: GKLeaderboardPlayerScope, time_scope: GKLeaderboardTimeScope, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate features GKLeaderboard and block2 only.

Source

pub unsafe fn triggerAccessPointWithPlayer_handler( &self, player: &GKPlayer, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate features GKBasePlayer and GKPlayer and block2 only.

Source

pub unsafe fn triggerAccessPointForPlayTogetherWithHandler( &self, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Displays the view that allows players to engage each other with activities and challenges.

Source

pub unsafe fn triggerAccessPointForChallengesWithHandler( &self, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Displays the view that allows players to engage each other with challenges.

Source

pub unsafe fn triggerAccessPointWithChallengeDefinitionID_handler( &self, challenge_definition_id: &NSString, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Displays the challenge creation view for the provided challenge definition ID.

Source

pub unsafe fn triggerAccessPointWithGameActivityDefinitionID_handler( &self, game_activity_definition_id: &NSString, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Displays the game activity creation view for the provided activity definition ID.

Source

pub unsafe fn triggerAccessPointWithGameActivity_handler( &self, game_activity: &GKGameActivity, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate features GKGameActivity and block2 only.

Displays the game activity view for the provided activity instance.

Source

pub unsafe fn triggerAccessPointForFriendingWithHandler( &self, handler: Option<&DynBlock<dyn Fn()>>, )

Available on crate feature block2 only.

Brings up the invite friends view.

Source §

impl GKAccessPoint

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