// // GameAnalytics.h // GA-SDK-IOS // // Copyright (c) 2015 GameAnalytics. All rights reserved. // #import /*! @enum @discussion This enum is used to specify flow in resource events @constant GAResourceFlowTypeSource Used when adding to a resource currency @constant GAResourceFlowTypeSink Used when subtracting from a resource currency */ typedef enum GAResourceFlowType : NSInteger { GAResourceFlowTypeSource = 1, GAResourceFlowTypeSink = 2 } GAResourceFlowType; /*! @enum @discussion his enum is used to specify status for progression event @constant GAProgressionStatusStart User started progression @constant GAProgressionStatusComplete User succesfully ended a progression @constant GAProgressionStatusFail User failed a progression */ typedef enum GAProgressionStatus : NSInteger { GAProgressionStatusStart = 1, GAProgressionStatusComplete = 2, GAProgressionStatusFail = 3 } GAProgressionStatus; /*! @enum @discussion his enum is used to specify severity of an error event @constant GAErrorSeverityDebug @constant GAErrorSeverityInfo @constant GAErrorSeverityWarning @constant GAErrorSeverityError @constant GAErrorSeverityCritical */ typedef enum GAErrorSeverity : NSInteger { GAErrorSeverityDebug = 1, GAErrorSeverityInfo = 2, GAErrorSeverityWarning = 3, GAErrorSeverityError = 4, GAErrorSeverityCritical = 5 } GAErrorSeverity; //Similar to ICommandCenterListener in the GameAnalytics Android library @protocol GACommandCenterDelegate @optional - (void) onCommandCenterUpdated; // Updated everytime when configurations are added @end @class GameAnalytics; @interface GameAnalytics : NSObject /*! @method @abstract Define available 1st custom dimensions @discussion Example usage: 

 NSArray *dimensionArray = @[@"dimA", @"dimB", @"dimC"];

 [GameAnalytics configureAvailableCustomDimensions01:dimensionArray];
@param customDimensions Must be an array of strings.
Array max length=20, String max length=32) @availability Available since 2.0.0 @attribute Note! This method must be called before initializing the SDK */ + (void)configureAvailableCustomDimensions01:(NSArray *)customDimensions; /*! @method @abstract Set available 2nd custom dimensions @discussion Example usage: 

 NSArray *available = @[@"dimD", @"dimE", @"dimF"];

 [GameAnalytics configureAvailableCustomDimensions02:dimensionArray;
@param customDimensions Must be an array of strings.
(Array max length=20, String max length=32) @availability Available since 2.0.0 @attribute Note! This method must be called before initializing the SDK */ + (void)configureAvailableCustomDimensions02:(NSArray *)customDimensions; /*! @method @abstract Set available 3rd custom dimensions @discussion Example usage: 

 NSArray *available = @[@"dimA", @"dimB", @"dimC"];

 [GameAnalytics configureAvailableCustomDimensions03:dimensionArray];
@param customDimensions Must be an array of strings.
(Array max length=20, String max length=32) @availability Available since 2.0.0 @attribute Note! This method must be called before initializing the SDK */ + (void)configureAvailableCustomDimensions03:(NSArray *)customDimensions; /*! @method @abstract Set available resource currencies @discussion Example usage: 

 NSArray *availableCurrencies = @[@"gems", @"gold"];

 [GameAnalytics configureAvailableResourceCurrencies:availableCurrencies];
@param resourceCurrencies Must be an array of strings.
(Array max length=20, String max length=32) @availability Available since 2.0.0 @attribute Note! This method must be called before initializing the SDK */ + (void)configureAvailableResourceCurrencies:(NSArray *)resourceCurrencies; /*! @method @abstract Set available resource item types @discussion Example usage: 

 NSArray *availableItemTypes = @[@"upgrades", @"powerups"];

 [GameAnalytics configureAvailableResourceItemTypes:availableItemTypes];
@param resourceItemTypes Must be an array of strings.
(Array max length=20, String max length=32) @availability Available since 2.0.0 @attribute Note! This method must be called before initializing the SDK */ + (void)configureAvailableResourceItemTypes:(NSArray *)resourceItemTypes; /*! @method @abstract Set app build version @discussion Example usage: 

 [GameAnalytics configureBuild:@"0.0.1"];
@param build (String max length=32) @availability Available since 2.0.0 @attribute Note! This method must be called before initializing the SDK */ + (void)configureBuild:(NSString *)build; /*! @method @abstract Set a custom unique user_id identifying the user. @discussion Example usage: 

 [GameAnalytics configureUserId:@"24566"];
@param userId (String max length=64) @availability Available since 2.2.0 @attribute Note! This method must be called before initializing the SDK */ + (void)configureUserId:(NSString *)userId; /*! @method @abstract Set app engine version @discussion Example usage: 

 [GameAnalytics configureEngineVersion:@"unreal 4.8.1"];
@param engineVersion (String) @availability Available since 2.0.0 @attribute Note! This method must be called before initializing the SDK */ + (void)configureEngineVersion:(NSString *)engineVersion; /*! @method @abstract Configure the game key and secret key before initializing. Used by certain frameworks (like Frabric.io) needing to set the keys during configure phase. @discussion Example usage: 

 [GameAnalytics configureGameKey:@"123456789ABCDEFGHIJKLMNOPQRSTU" gameSecret:@"123456789ABCDEFGHIJKLMNOPQRSTU12345678"];
@param gameKey (String) @param gameSecret (String) @availability Available since 2.0.8 */ + (void)configureGameKey:(NSString *)gameKey gameSecret:(NSString *)gameSecret; /*! @method @abstract Initialize GameAnalytics SDK @discussion Example usage: 

 [GameAnalytics initializeWithGameKey:@"123456789ABCDEFGHIJKLMNOPQRSTU" gameSecret:@"123456789ABCDEFGHIJKLMNOPQRSTU12345678"];
@param gameKey (String) @param gameSecret (String) @availability Available since 2.0.0 */ + (void)initializeWithGameKey:(NSString *)gameKey gameSecret:(NSString *)gameSecret; /*! @method @abstract Initialize GameAnalytics SDK when the game key and game secret has been configured earlier. @discussion Example usage: 

 [GameAnalytics initializeWithConfiguredGameKeyAndGameSecret];
@availability Available since 2.0.8 @attribute Note! This method can only be used if the configureGameKey:gameSecret: method is called before. */ + (void)initializeWithConfiguredGameKeyAndGameSecret; /*! @method @abstract Add new business event with receipt @param currency Currency code in ISO 4217 format. (e.g. USD) @param amount Amount in cents (int). (e.g. 99) @param itemType Item Type bought. (e.g. Gold Pack) @param itemId Item bought. (e.g. 1000 gold) @param receipt Transaction receipt string. (Optional, can be nil) @availability Available since 2.0.0 @attribute Note! This method cannot be called before initialize method has been triggered */ + (void)addBusinessEventWithCurrency:(NSString *)currency amount:(NSInteger)amount itemType:(NSString *)itemType itemId:(NSString *)itemId cartType:(NSString *)cartType receipt:(NSString *)receipt; /*! @method @abstract Add new business event @param currency Currency code in ISO 4217 format. (e.g. USD) @param amount (Integer) Amount in cents. (e.g. 99) @param itemType Item Type bought. (e.g. Gold Pack) @param itemId Item bought. (e.g. 1000 gold) @param autoFetchReceipt Should the SDK automatically fetch the transaction receipt and add it to the event @availability Available since 1.0.0 @attribute Note! This method cannot be called before initialize method has been triggered */ + (void)addBusinessEventWithCurrency:(NSString *)currency amount:(NSInteger)amount itemType:(NSString *)itemType itemId:(NSString *)itemId cartType:(NSString *)cartType autoFetchReceipt:(BOOL)autoFetchReceipt; /*! @method @abstract Add new resource event @param flowType Add or substract resource.
(See. GAResourceFlowType) @param currency One of the available currencies set in configureAvailableResourceCurrencies @param amount Amount sourced or sinked @param itemType One of the available item types set in configureAvailableResourceItemTypes @param itemId Item id (string max length=32) @availability Available since 2.0.0 @attribute Note! This method cannot be called before initialize method has been triggered */ + (void)addResourceEventWithFlowType:(GAResourceFlowType)flowType currency:(NSString *)currency amount:(NSNumber *)amount itemType:(NSString *)itemType itemId:(NSString *)itemId; /*! @method @abstract Add new progression event @param progressionStatus Status of added progression.
(See. GAProgressionStatus) @param progression01 1st progression (e.g. world01) @param progression02 2nd progression (e.g. level01) @param progression03 3rd progression (e.g. phase01) @availability Available since 1.0.0 @attribute Note! This method cannot be called before initialize method has been triggered */ + (void)addProgressionEventWithProgressionStatus:(GAProgressionStatus)progressionStatus progression01:(NSString *)progression01 progression02:(NSString *)progression02 progression03:(NSString *)progression03; /*! @method @abstract Add new progression event with score @param progressionStatus Status of added progression.
(See. GAProgressionStatus) @param progression01 1st progression (e.g. world01) @param progression02 2nd progression (e.g. level01) @param progression03 3rd progression (e.g. phase01) @availability Available since 2.0.0 @attribute Note! This method cannot be called before initialize method has been triggered */ + (void)addProgressionEventWithProgressionStatus:(GAProgressionStatus)progressionStatus progression01:(NSString *)progression01 progression02:(NSString *)progression02 progression03:(NSString *)progression03 score:(NSInteger)score; /*! @method @abstract Add new design event without a value @param eventId String can consist of 1 to 5 segments.
Segments are seperated by ':' and segments can have a max length of 32.
(e.g. segment1:anotherSegment:gold) @availability Available since 2.0.0 @attribute Note! This method cannot be called before initialize method has been triggered */ + (void)addDesignEventWithEventId:(NSString *)eventId; /*! @method @abstract Add new design event with a value @param eventId String can consist of 1 to 5 segments.
segments are seperated by ':' and segments can have a max length of 32.
(e.g. segment1:anotherSegment:gold) @param value Number value of event @availability Available since 2.0.0 @attribute Note! This method cannot be called before initialize method has been triggered */ + (void)addDesignEventWithEventId:(NSString *)eventId value:(NSNumber *)value; /*! @method @abstract Add new error event @param severity Severity of error (See. GAErrorSeverity) @param message Error message (Optional, can be nil) @availability Available since 2.0.0 @attribute Note! This method cannot be called before initialize method has been triggered */ + (void)addErrorEventWithSeverity:(GAErrorSeverity)severity message:(NSString *)message; /*! @method @abstract Get command center value as string @param key The key declared in the webtool @availability Available since (TBD) @attribute Note! This method cannot be called before initialize method has been triggered */ + (NSString *)getCommandCenterValueAsString:(NSString*) key; /*! @method @abstract Get command center value as string @param key The key declared in the webtool @param defaultValue Fallback default value for when the method does not find a value under the specified key @availability Available since (TBD) @attribute Note! This method cannot be called before initialize method has been triggered */ + (NSString *) getCommandCenterValueAsString:(NSString *) key defaultValue:(NSString *)defaultValue; /*! @method @abstract Get command center configurations @availability Available since (TBD) @attribute For internal use. */ + (NSString *) getCommandCenterConfigurations; /*! @method @abstract Use this to set the delegate for the Command Center to retreive information about the status of loading configurations @availability Available since (TBD) */ + (void) setCommandCenterDelegate:(id)newDelegate; /*! @method @abstract Call for checking if command center values are loaded and ready @availability Available since (TBD) @attribute Note! This method should not be called before initialize method has been triggered */ + (BOOL) isCommandCenterReady; /*! @method @abstract Enable info logging to console @param flag Enable or disable info log mode @availability Available since 2.0.0 */ + (void)setEnabledInfoLog:(BOOL)flag; /*! @method @abstract Enable verbose info logging of analytics. Will output event JSON data to console. @param flag Enable or disable verbose info log mode @availability Available since 2.0.0 */ + (void)setEnabledVerboseLog:(BOOL)flag; /*! @method @abstract Enable manual session handling. This will disable the automatic session stop/start when the app goes to background/foreground and it is then needed to call endSession & startSession manually. Remember to call endSession when the app is going to background. The first session will always be started automatically when initialize is called. @param flag Enable or disable manual session handling. @availability Available since 2.2.2 */ + (void)setEnabledManualSessionHandling:(BOOL)flag; /*! @method @abstract Start a new session. - if sdk is initialized - if manual session handling is enabled If a current session is currently active then it will end this session and start a new. @availability Available since 2.2.2 */ + (void)startSession; /*! @method @abstract End an active session. - if sdk is initialized - manual session handling is enabled - a session is active @availability Available since 2.2.2 */ + (void)endSession; /*! @method @abstract Set 1st custom dimension @param dimension01 One of the available dimension values set in configureAvailableCustomDimensions01
Will persist cross session. Set to nil to reset. @availability Available since 2.0.0 @attribute Note! Must be called after setAvailableCustomDimensions01WithCustomDimensions */ + (void)setCustomDimension01:(NSString *)dimension01; /*! @method @abstract Set 2nd custom dimension @param dimension02 One of the available dimension values set in configureAvailableCustomDimensions02
Will persist cross session. Set to nil to reset. @availability Available since 2.0.0 @attribute Note! Must be called after setAvailableCustomDimensions02 */ + (void)setCustomDimension02:(NSString *)dimension02; /*! @method @abstract Set 3rd custom dimension @param dimension03 One of the available dimension values set in configureAvailableCustomDimensions03
Will persist cross session. Set to nil to reset. @availability Available since 2.0.0 @attribute Note! Must be called after setAvailableCustomDimensions03W */ + (void)setCustomDimension03:(NSString *)dimension03; /*! @method @abstract Set user facebook id @param facebookId Facebook id of user (Persists cross session) @availability Available since 2.0.0 */ + (void)setFacebookId:(NSString *)facebookId; /*! @method @abstract Set user gender @param gender Gender of user (Persists cross session)
Must be one of (male / female) @availability Available since 2.0.0 */ + (void)setGender:(NSString *)gender; /*! @method @abstract Set user birth year @param birthYear Birth year of user (Persists cross session) @availability Available since 2.0.0 */ + (void)setBirthYear:(NSInteger)birthYear; @end