iPhone OS Reference Library Apple Developer Connection spyglass button

GKPeerPickerController Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/GameKit.framework
Availability
Available in iPhone OS 3.0 and later.
Companion guide
Declared in
GKPeerPickerController.h
Related sample code

Overview

The GKPeerPickerController class provides a standard user interface to allow an iPhone to discover and connect to another iPhone. The result is a configured GKSession object connecting the two devices. To use a GKPeerPickerController object, your application creates the controller, adds a delegate, configures the allowed connection types, and then shows the peer picker. The delegate is called as the user makes selections within the peer picker interface.

In iPhone OS 3.0, the peer picker can be configured to select between Bluetooth and Internet connections.

Important: Although users can select internet connections in the peer picker, the GKPeerPickerController does not provide an user interface to configure them. If your application configures the peer picker to allow Internet connections, your application must also dismiss the peer picker and present its own interface to configure an internet connection.

Tasks

Setting and Getting the Delegate

Displaying the Picker Dialog

Configuring Connectivity Options

Properties

For more about Objective-C properties, see “Properties” in The Objective-C Programming Language.

connectionTypesMask

A mask that determines the types of connections a dialog presents to the user.

@property(nonatomic, assign) GKPeerPickerConnectionType connectionTypesMask
Discussion

Your application configures the connection types it allows before showing the peer picker. If your application allows more than one connection type, the peer picker offers the user a choice of which type of connection to use. The default value for the mask is GKPeerPickerConnectionTypeNearby.

Important: In iPhone OS 3.0, GKPeerPickerConnectionTypeNearby is required to be one of the allowed connection types. An exception is thrown if your application does not include it.

Availability
Declared In
GKPeerPickerController.h

delegate

The delegate of the peer picker controller.

@property(nonatomic, assign) id<GKPeerPickerControllerDelegate> delegate
Discussion

The delegate must adopt the GKPeerPickerControllerDelegate formal protocol.

Availability
Related Sample Code
Declared In
GKPeerPickerController.h

visible

A Boolean value that indicates whether the picker dialog is visible. (read-only)

@property(readonly, getter=isVisible) BOOL visible
Availability
Declared In
GKPeerPickerController.h

Instance Methods

dismiss

Hides the peer picker dialog.

- (void)dismiss

Discussion

The controller’s delegate is responsible for dismissing the peer picker when it is no longer needed.

Availability
  • Available in iPhone OS 3.0 and later.
Related Sample Code
Declared In
GKPeerPickerController.h

show

Displays the peer picker dialog to the user.

- (void)show

Availability
  • Available in iPhone OS 3.0 and later.
Related Sample Code
Declared In
GKPeerPickerController.h

Constants

GKPeerPickerConnectionType

Network connections available to the peer picker dialog.

enum {
   GKPeerPickerConnectionTypeOnline = 1 << 0,
   GKPeerPickerConnectionTypeNearby = 1 << 1
};
typedef NSUInteger GKPeerPickerConnectionType;
Constants
GKPeerPickerConnectionTypeOnline

An Internet-based connection.

Available in iPhone OS 3.0 and later.

Declared in GKPeerPickerController.h.

GKPeerPickerConnectionTypeNearby

A Bluetooth connection to a device.

Available in iPhone OS 3.0 and later.

Declared in GKPeerPickerController.h.



Last updated: 2009-05-26

Did this document help you? Yes It's good, but... Not helpful...