Public Member Functions | Static Public Member Functions | Properties

OFInvite Class Reference

#import <OFInvite.h>

List of all members.

Public Member Functions

(OFInvite *) - initWithInviteDefinition:
(OFRequestHandle *) - sendInviteToUsers:
(void) - displayAndSendInviteScreen
(OFRequestHandle *) - getInviteIcon

Static Public Member Functions

(void) + setDelegate:
(NSString *) + getResourceName

Properties

NSString * userMessage
NSString * senderParameter
NSString * receiverParameter
OFUsersenderUser
OFUserreceiverUser
NSString * clientApplicationName
NSString * clientApplicationID
NSString * inviteIdentifier
NSString * inviteIconURL
NSString * developerMessage
NSString * receiverNotification
NSString * senderNotification
NSString * state

Detailed Description

The public interface to OFInvite allows you to create invites and send them to other users You can also query invites a certain user has.


Member Function Documentation

- (void) displayAndSendInviteScreen

Displays the OpenFeint invite screen for this invite and prompts to user to send invites

Note:
You must init an invite with initWithInviteDefinition in order to call this function
- (OFRequestHandle*) getInviteIcon

Get the Invite Icon associated with this invite

Returns:
OFRequestHandle for the server request. Use this to cancel the request
Note:
Invokes - (void)didGetInviteIcon:(UIImage*)image OFInvite:(OFInvite*)invite; on success and
  • (void)didFailGetInviteIconOFInvite:(OFInvite*)invite; on failure
+ (NSString*) getResourceName
- (OFInvite*) initWithInviteDefinition: (OFInviteDefinition *)  inviteDefinitionIn

Initializes a OFInvite for sending.

Parameters:
inviteDefinitionWhich invite definition will define this invite?
Note:
You may optionally also fillout the userMessage
If userMessage is not filled out the userMessage will default to the Invite Definitions suggestedSenderMessage.
- (OFRequestHandle*) sendInviteToUsers: (NSArray *)  users

Send the invite to an array of users

Parameters:
usersThe users which will receive the invite.
Returns:
OFRequestHandle for the server request. Use this to cancel the request
Note:
Invokes - (void)didSendInvite:(OFInvite*)invite on success and
  • (void)didFailSendInvite:(OFInvite*)invite on failure
You must init an invite with initWithInviteDefinition in order to call this function
+ (void) setDelegate: (id< OFInviteSendDelegate >)  delegate

Set a delegate for all OFInvite related actions. Must adopt the OFInviteSendDelegate protocol.

Note:
Defaults to nil. Weak reference

Property Documentation

- (NSString *) clientApplicationID [read, assign]
- (NSString *) clientApplicationName [read, assign]
- (NSString *) developerMessage [read, assign]
- (NSString *) inviteIconURL [read, assign]
- (NSString *) inviteIdentifier [read, assign]
- (NSString *) receiverNotification [read, assign]
- (NSString *) receiverParameter [read, assign]

Copied from the definition when created

See also:
OFInviteDefinition
Note:
Only for Premium Members
- (OFUser *) receiverUser [read, assign]
- (NSString *) senderNotification [read, assign]
- (NSString *) senderParameter [read, assign]

Copied from the definition when created

See also:
OFInviteDefinition
Note:
Only for Premium Members
- (OFUser *) senderUser [read, assign]
- (NSString *) state [read, assign]
- (NSString *) userMessage [read, write, retain]

Actual user message after the user optionally edited it.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Enumerations Enumerator Properties