<CPTApplication> Protocol Reference

#import <CPTApplication.h>

Inheritance diagram for <CPTApplication>:

Instance Methods
(nonnull NSDictionary< NSString *, id< CPTAsset >> *)	- getAssetsByType:
Instance Methods inherited from <CPTObject>
(nonnull instancetype)	- initWithDictionary:
(nonnull NSDictionary< NSString *, id > *)	- toDictionary

Properties
NSString *	appId
NSString *	logoURL
NSString *	name
NSString *	applicationURL
id< CPTGameCenter >	gameCenterDetails
id< CPTTheme >	theme
NSDictionary< NSString *, id< CPTBadge > > *	badges
NSArray< id< CPTActionSettings > > *	actionSettings
NSArray< id< CPTLevel > > *	levels
NSUInteger	ratio
NSDictionary< NSString *, id< CPTRewardType > > *	rewardTypes
NSDictionary< NSString *, id< CPTAsset > > *	assets
NSDictionary< NSString *, id< CPTCurrencySettings > > *	currencySettings
Properties inherited from <CPTObject>
NSDictionary< NSString *, id > *	sourceDictionary

Detailed Description

An app holds the information about the Captain Up experience in your site or app. The app resource holds all the settings and configurations related to your app, including information about the app's actions and levels

Method Documentation

getAssetsByType:()

- (nonnull NSDictionary<NSString*,id<CPTAsset>>*) getAssetsByType:

(CPTAssetType)

type

A map of application assets by asset type

Parameters

type	CPTAssetType

Returns

a map of all the application assets of a type

Property Documentation

actionSettings

- (NSArray<id <CPTActionSettings> >*) actionSettings

readnonatomicassign

The app's action's settings.

Returns

the app's action's settings. Each element in the array conforms to the CPTActionSettings protocol.

appId

- (NSString*) appId

readnonatomicassign

The ID of the app.

Returns

the ID of the app.

applicationURL

- (NSString*) applicationURL

readnonatomicassign

The URL of the application.

Returns

the URL of the application.

assets

- (NSDictionary<NSString*,id<CPTAsset> >*) assets

readnonatomicassign

A map of all the application assets by their Asset Type ID.

Returns

a map of all the application assets types by their Asset ID.

badges

- (NSDictionary<NSString*,id<CPTBadge> >*) badges

readnonatomicassign

A map of all the application badges by their Badge ID.

Returns

a map of all the application badges by their Badge ID (NSString). The value conforms to the CPTBadge protocol.

currencySettings

- (NSDictionary<NSString*,id<CPTCurrencySettings> >*) currencySettings

readnonatomicassign

the app Currency Settings Map. where key is currency name and value is CPTCurrencySettings object.

gameCenterDetails

- (id<CPTGameCenter>) gameCenterDetails

readnonatomicassign

The details of the app's game center display (like the title and text).

Returns

the app's game center's details.

levels

- (NSArray<id <CPTLevel> >*) levels

readnonatomicassign

List of the app's levels

Returns

list of the app's levels. Each element in the array conforms to the CPTLevel protocol.

logoURL

- (NSString*) logoURL

readnonatomicassign

The URL to your app's logo. Will default to a community logo.

Returns

the URL to the app's logo.

name

- (NSString*) name

readnonatomicassign

The name of the app.

Returns

the name of the app.

ratio

- (NSUInteger) ratio

readnonatomicassign

App currency ratio (default is 1)

rewardTypes

- (NSDictionary<NSString*,id <CPTRewardType> >*) rewardTypes

readnonatomicassign

map of the app's reward types

Returns

map of the app's reward types by their reward type id The value conforms to the CPTRewardType protocol.

theme

- (id<CPTTheme>) theme

readnonatomicassign

The details of the theme defined for the app.

Returns

the app's theme.

---

The documentation for this protocol was generated from the following file:

• /Users/yogs/Desktop/CaptainUp/Headers/CPTApplication.h