Public Member Functions | Static Public Member Functions | Protected Attributes | Properties

OFInviteDefinition Class Reference

#import <OFInviteDefinition.h>

List of all members.

Public Member Functions

(OFRequestHandle *) - getInviteIcon

Static Public Member Functions

(void) + setDelegate:
(OFRequestHandle *) + getPrimaryInviteDefinition
(OFRequestHandle *) + getInviteDefinition:
(NSString *) + getResourceName

Protected Attributes

package NSString * clientApplicationName
OFPointer< OFHttpService > mHttpService
OFPointer
< OFImageViewHttpServiceObserver > 
mHttpServiceObserver

Properties

NSString * clientApplicationName
NSString * clientApplicationID
NSString * inviteIdentifier
NSString * senderParameter
NSString * receiverParameter
NSString * developerMessage
NSString * receiverNotification
NSString * senderNotification
NSString * senderIncentiveText
NSString * suggestedSenderMessage
NSString * inviteIconURL

Detailed Description

The public interface to OFInviteDefinition allows you to get Invite Definitions that are defined on the developer dashboard.


Member Function Documentation

+ (OFRequestHandle*) getInviteDefinition: (NSString *)  inviteId

Get an invite Definition by its invite id defined on the developer dashboard.

Returns:
OFRequestHandle for the server request. Use this to cancel the request
Note:
Invokes - (void)didGetInviteDefinition:(OFInviteDefinition*)definition on success and
  • (void)didFailGetInviteDefinition on failure
- (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
+ (OFRequestHandle*) getPrimaryInviteDefinition

Get the Primary Invite definition as defined on the developer dashboard

Returns:
OFRequestHandle for the server request. Use this to cancel the request
Note:
Invokes - (void)didGetPrimaryInviteDefinition:(OFInviteDefinition*)definition on success and
  • (void)didFailGetPrimaryInviteDefinition on failure.
+ (NSString*) getResourceName
+ (void) setDelegate: (id< OFInviteDefinitionDelegate >)  delegate

Set a delegate for all OFInviteDefinition related actions. Must adopt the OFInviteDefinitionDelegate protocol.

Note:
Defaults to nil. Weak reference

Member Data Documentation

- (package NSString*) clientApplicationName [protected]
- (OFPointer<OFHttpService>) mHttpService [protected]
- (OFPointer<OFImageViewHttpServiceObserver>) mHttpServiceObserver [protected]

Property Documentation

- (NSString *) clientApplicationID [read, assign]

The Application ID that this invite definition belongs to

- (NSString*) clientApplicationName [read, assign]

Name of the application associated with this invite definition.

- (NSString *) developerMessage [read, assign]

The user-uneditable string for this invite definition as seen on the developer dashboard

- (NSString *) inviteIconURL [read, assign]
- (NSString *) inviteIdentifier [read, assign]

Identifier as input on the developer dashboard

- (NSString *) receiverNotification [read, assign]

Receiver Notification as seen on the developer dashboard.

- (NSString *) receiverParameter [read, assign]

Receiver Parameter as defined in the developer dashboard

Note:
Only for Premium Members
- (NSString *) senderIncentiveText [read, assign]

The "Call to Action" field input on the developer dashboard.

- (NSString *) senderNotification [read, assign]

Sender Notification as seen on the developer dashboard.

- (NSString *) senderParameter [read, assign]

Sender Parameter as defined in the developer dashboard

Note:
Only for Premium Members
- (NSString *) suggestedSenderMessage [read, assign]

The suggested, user editable message as seen on the developer dashboard.


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