GKFriendRequestComposeViewController Class Reference

Inherits from
Conforms to
Framework
/System/Library/Frameworks/GameKit.framework
Availability
Available in OS X v10.8 and later.
Companion guide
Declared in
GKFriendRequestComposeViewController.h

Overview

Your game uses the GKFriendRequestComposeViewController class to present a screen that allows the local player to send friend requests to other players.

To show a friend request, initialize a new GKFriendRequestComposeViewController object and set the delegate. Optionally, you can customize the request by adding a text message or a list of recipients. Then, present the new view controller and wait for the delegate to be called. Once the delegate is called, dismiss the view controller.

On iOS, you present and dismiss the view controller from another view controller in your game, using the methods provided by the UIViewController class. On OS X, you use the GKDialogController class to present and dismiss the view controller.

Subclassing Notes

The GKFriendRequestComposeViewController class is not intended to be subclassed.

Tasks

Determining the Maximum Number of Recipients

Delegate

Adding Recipients

Setting an Invitation Message

Properties

composeViewDelegate

The view controller’s delegate

@property(nonatomic, assign) id<GKFriendRequestComposeViewControllerDelegate> composeViewDelegate
Discussion

Before displaying the friend request, your game must set a delegate.

Availability
  • Available in OS X v10.8 and later.
Declared In
GKFriendRequestComposeViewController.h

Class Methods

maxNumberOfRecipients

Returns the maximum number of recipients permitted in a single request.

+ (NSUInteger)maxNumberOfRecipients
Return Value

The maximum number of recipients.

Discussion

If you add more recipients than the value returned from this method, Game Kit throws an exception.

Availability
  • Available in OS X v10.8 and later.
Declared In
GKFriendRequestComposeViewController.h

Instance Methods

addRecipientsWithEmailAddresses:

Adds recipients based on their email addresses..

- (void)addRecipientsWithEmailAddresses:(NSArray *)emailAddresses
Parameters
emailAddresses

An array with one or more NSString objects, each containing an email address.

Discussion

If you do not add at least once recipient, the recipients field is selected when the view controller is presented so that the player can type a list of recipients.

Availability
  • Available in OS X v10.8 and later.
Declared In
GKFriendRequestComposeViewController.h

addRecipientsWithPlayerIDs:

Adds recipients based on their Game Center player identifiers.

- (void)addRecipientsWithPlayerIDs:(NSArray *)playerIDs
Parameters
playerIDs

An array with one or more NSString objects, each containing an player identifier.

Discussion

If you do not add at least once recipient, the recipients field is selected when the view controller is presented so that the player can type a list of recipients.

Availability
  • Available in OS X v10.8 and later.
Declared In
GKFriendRequestComposeViewController.h

setMessage:

Sets the text message included in the friend invitation.

- (void)setMessage:(NSString *)message
Parameters
message

The text message.

Discussion

If you do not set a text message, Game Kit sets a default text message.

Availability
  • Available in OS X v10.8 and later.
Declared In
GKFriendRequestComposeViewController.h