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

OFChallengeDefinition Class Reference

#import <OFChallengeDefinition.h>

List of all members.

Public Member Functions

(OFRequestHandle *) - getIcon

Static Public Member Functions

(void) + setDelegate:
(OFRequestHandle *) + downloadAllChallengeDefinitions
(OFRequestHandle *) + downloadChallengeDefinitionWithId:
(NSString *) + getResourceName

Protected Attributes

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

Properties

NSString * title
BOOL multiAttempt
NSString * clientApplicationId
NSString * iconUrl

Detailed Description

The public interface for OFChallengeDefinition allows you to see details on a challenge Definition. These are the objects related to the challenge types you've defined in the developer dashboard.


Member Function Documentation

+ (OFRequestHandle*) downloadAllChallengeDefinitions

download all challenge definitions

Returns:
OFRequestHandle for the server request. Use this to cancel the request
Note:
Invokes - (void)didDownloadAllChallengeDefinitions:(NSArray*)challengeDefinitions on success and
  • (void)didFailDownloadChallengeDefinitions on failure.
+ (OFRequestHandle*) downloadChallengeDefinitionWithId: (NSString *)  challengeDefinitionId

get a challenge definition from the server.

Parameters:
challengeDefinitionIdThe resource id of the OFChallengeDefinition to return
Returns:
OFRequestHandle for the server request. Use this to cancel the request
Note:
Invokes - (void)didDownloadChallengeDefinition:(OFChallengeDefinition*)challengeDefinition on success and
  • (void)didFailDownloadChallengeDefinition on failure
- (OFRequestHandle*) getIcon

Get the challenge icon image

Returns:
OFRequestHandle for the server request. Use this to cancel the request
Note:
Invokes - (void)didGetIcon:(UIImage*)image OFChallengeDefintion:(OFChallengeDefinition*)challengeDef; on success and
  • (void)getFailGetIconOFChallengeDefinition:(OFChallengeDefinition*)challengeDef; on failure
+ (NSString*) getResourceName
+ (void) setDelegate: (id< OFChallengeDefinitionDelegate >)  delegate

Set a delegate for all OFChallengeDefinition related actions. Must adopt the OFChallengeDefinitionDelegate protocol.

Note:
Defaults to nil. Weak reference

Member Data Documentation

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

Property Documentation

- (NSString *) clientApplicationId [read, assign]
- (NSString *) iconUrl [read, assign]
- (BOOL) multiAttempt [read, assign]

Wether or not the receiver of this challenge can attempt it multiple times to complete.

- (NSString*) title [read, assign]

The title defined on the developer dashboard for this challenge definition


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