Inherits from VMRequestManager : NSObject
Declared in VMActivityManager.h
VMActivityManager.m

Overview

VMActivityManager is a subclass of VMRequestManager provided to interact with VMob Activities.

Tasks

Other Methods

  •   stackActivity

    Current activity stack in the VMActivityManager class.

    property
  •   lastSendStack

    Timestamp for the last successful sent stack in the VMActivityManager class.

    property
  • + sharedInstance

    Returns the shared activity manager object for the system.

Follow Methods

ButtonClick Methods

LocationCheckin Methods

AppPageImpression Methods

Offer Methods

Application Methods

  • – appStartup

    The AppStartup type is provided to log an instance of a Client Application ‘starting’, e.g. coming out of hibernation or cold start.

  • – appStartupAnonym

    This anonymous version of the AppStartup type should only be used in situations where the user has not yet registered or logged in.

  • – appInstall

    This type should only ever be posted once by the application – and at the earliest possible time, e.g. during installation oir first run (before user login)

Social Methods

Advertisement Methods

Properties

lastSendStack

Timestamp for the last successful sent stack in the VMActivityManager class.

@property (nonatomic, readonly) NSDate *lastSendStack

Declared In

VMActivityManager.h

stackActivity

Current activity stack in the VMActivityManager class.

@property (nonatomic, readonly) NSMutableArray *stackActivity

Declared In

VMActivityManager.h

Class Methods

sharedInstance

Returns the shared activity manager object for the system.

+ (instancetype)sharedInstance

Return Value

The systemwide activity manager.

Declared In

VMActivityManager.h

Instance Methods

advertisementClickWithPlacementCode:channelCode:advertisementId:

The Advertisement Click type is provided to log an instance of a Consumer clicking on an advertisement within the application.

- (void)advertisementClickWithPlacementCode:(NSString *)placementCode channelCode:(NSString *)channelCode advertisementId:(NSString *)advertisementId

Parameters

placementCode

should contain the placementCode for the Ad

channelCode

should contain the channelCode for the Ad

advertisementId

should be the id of the advertisement

Declared In

VMActivityManager.h

advertisementImpressionWithPlacementCode:channelCode:advertisementId:

The Advertisement Impression type is provided to log an instance of an being displayed to the consumer on the app.

- (void)advertisementImpressionWithPlacementCode:(NSString *)placementCode channelCode:(NSString *)channelCode advertisementId:(NSString *)advertisementId

Parameters

placementCode

should contain the placementCode for the Ad

channelCode

should contain the channelCode for the Ad

advertisementId

should be the id of the advertisement

Declared In

VMActivityManager.h

appInstall

This type should only ever be posted once by the application – and at the earliest possible time, e.g. during installation oir first run (before user login)

- (void)appInstall

Declared In

VMActivityManager.h

appPageImpressionAnonymWithPageId:merchantId:venueId:itemId:itemCode:

This anonymous version for the AppPageImpression service should only be used in situations where the user has not yet logged in or registered.

- (void)appPageImpressionAnonymWithPageId:(NSString *)pageId merchantId:(NSString *)merchantId venueId:(NSString *)venueId itemId:(NSString *)itemId itemCode:(NSString *)itemCode

Parameters

pageId

should contain unique identifier for the page which was viewed

merchantId

should be supplied if relevant to the current page

venueId

should be supplied if relevant to the current page

itemId

should be supplied if relevant to the current page

itemCode

identifies the type for the itemId, e.g. if itemId is an offer id then itemCode must be ‘O’. itemCode is mandatory when itemId contains a value

Declared In

VMActivityManager.h

appPageImpressionWithPageId:merchantId:venueId:itemId:itemCode:

The AppPageImpression type is provided to log an instance of a Consumer viewing a page within the Client Application.

- (void)appPageImpressionWithPageId:(NSString *)pageId merchantId:(NSString *)merchantId venueId:(NSString *)venueId itemId:(NSString *)itemId itemCode:(NSString *)itemCode

Parameters

pageId

should contain unique identifier to the page which was viewed

merchantId

should be supplied if relevant to the current page

venueId

should be supplied if relevant to the current page

itemId

should be supplied if relevant to the current page

itemCode

identifies the type for the itemId, e.g. if itemId is an offer id then itemCode must be ‘O’. itemCode is mandatory when itemId contains a value

Declared In

VMActivityManager.h

appStartup

The AppStartup type is provided to log an instance of a Client Application ‘starting’, e.g. coming out of hibernation or cold start.

- (void)appStartup

Declared In

VMActivityManager.h

appStartupAnonym

This anonymous version of the AppStartup type should only be used in situations where the user has not yet registered or logged in.

- (void)appStartupAnonym

Declared In

VMActivityManager.h

buttonClickAnonymousWithButtonId:merchantId:venueId:itemId:itemCode:

This anonymous version for the Button Click service should only be used in situations where the user has not yet logged in or registered.

- (void)buttonClickAnonymousWithButtonId:(NSString *)buttonId merchantId:(NSString *)merchantId venueId:(NSString *)venueId itemId:(NSString *)itemId itemCode:(NSString *)itemCode

Parameters

buttonId

should contain unique identifier for the button which was clicked

merchantId

should be supplied if relevant to the click

venueId

should be supplied if relevant to the click

itemId

should be supplied if relevant to the click

itemCode

identifies the type for the itemId, e.g. if itemId is an offer id then itemCode must be ‘O’. itemCode is mandatory when itemId contains a value

Declared In

VMActivityManager.h

buttonClickWithButtonId:merchantId:venueId:itemId:itemCode:

The Button Click type is provided to log an instance of a Consumer clicking a button within the Client Application.

- (void)buttonClickWithButtonId:(NSString *)buttonId merchantId:(NSString *)merchantId venueId:(NSString *)venueId itemId:(NSString *)itemId itemCode:(NSString *)itemCode

Parameters

buttonId

should contain unique identifier for the button which was clicked

merchantId

should be supplied if relevant to the click

venueId

should be supplied if relevant to the click

itemId

should be supplied if relevant to the click

itemCode

identifies the type for the itemId, e.g. if itemId is an offer id then itemCode must be ‘O’. itemCode is mandatory when itemId contains a value

Declared In

VMActivityManager.h

locationCheckinWithTypeGPS:location:

The Location Checkin type is provided to log the current location of the consumer/device

- (void)locationCheckinWithTypeGPS:(VMTypeGPS)typeGPS location:(CLLocation *)location

Parameters

typeGPS

this is where/how the GPS information was gathered from on the device

location

this is CLLocation

Declared In

VMActivityManager.h

loginWithLoginType:

The Login type is provided to log an instance of a Consumer Logging into the Client Application

- (void)loginWithLoginType:(VMActivitySocialType)socialType

Parameters

socialType

should contain the type of login that has occurred

Declared In

VMActivityManager.h

offerClickThroughWithPlacementType:offerId:

The OfferClickThrough type is provided to log an instance of a Consumer clicking on an offer to view the full detail within the Client Application.

- (void)offerClickThroughWithPlacementType:(NSString *)placementType offerId:(NSString *)offerId

Parameters

placementType

should contain the placement type it originated from

offerId

should contain the offerId

Declared In

VMActivityManager.h

offerImpressionWithPlacementType:offerId:

The OfferImpression type is provided to log an instance of an offer coming into the viewable area of the Client Application.

- (void)offerImpressionWithPlacementType:(NSString *)placementType offerId:(NSString *)offerId

Parameters

placementType

should contain the placement type it originated from

offerId

should contain the offerId

Declared In

VMActivityManager.h

offerInstoreRedemptionWithPlacementType:redeemedOffer:offerId:venueId:

The OfferInstoreRedemption typeis provided to log an instance of an ‘in-store redemption’ occuring.

- (void)offerInstoreRedemptionWithPlacementType:(NSString *)placementType redeemedOffer:(NSString *)redeemedOffer offerId:(NSString *)offerId venueId:(NSString *)venueId

Parameters

placementType

should contain the placement type it originated from

redeemedOffer

the call to create a redeemed offer

offerId

should contain the offerId

venueId

should be supplied if relevant to the current page

Declared In

VMActivityManager.h

offerRedemptionWithPlacementType:paymentTypeCode:paymentId:paymentAmount:redeemedOffer:offerId:venueId:

The OfferRedemption type is provided to log an instance of a Consumer clicking to Redeem and Offer within the Client Application.

- (void)offerRedemptionWithPlacementType:(NSString *)placementType paymentTypeCode:(NSString *)paymentTypeCode paymentId:(NSString *)paymentId paymentAmount:(NSString *)paymentAmount redeemedOffer:(NSString *)redeemedOffer offerId:(NSString *)offerId venueId:(NSString *)venueId

Parameters

placementType

should contain the placement type it originated from

paymentTypeCode

this is Payment Type Code

paymentId

this is Payment Id if relevant

paymentAmount

this is Payment Amount if relevant

redeemedOffer

the call to create a redeemed offer

offerId

should contain the offerId

venueId

should be supplied if relevant to the current page

Declared In

VMActivityManager.h

offerShareWithSocialType:offerId:

The Offer Share type is provided to log an instance of a Consumer sharing an offer via a 3rd party application.

- (void)offerShareWithSocialType:(VMShareSocialType)socialType offerId:(NSString *)offerId

Parameters

socialType

should contain the type of login that has occurred

offerId

is an offer

Declared In

VMActivityManager.h

registrationWithRegistrationType:

The Registration type is provided to log an instance of a Consumer Registration occurring

- (void)registrationWithRegistrationType:(VMActivitySocialType)socialType

Parameters

socialType

should contain the type of registration that has occurred

Declared In

VMActivityManager.h

sendHistoryActivityWithUserToken:completionBlock:failBlock:

Method is provided to log an instance of a Client Application ‘starting’, e.g. coming out of hibernation or cold start.

- (VMHTTPRequestOperation *)sendHistoryActivityWithUserToken:(NSString *)userToken completionBlock:(SuccessBlock)completionBlock failBlock:(ErrorBlock)errorBlock

Parameters

userToken

Access token.

completionBlock

The block is executed on the completion of a successful request. This block has no return value and takes one argument: the object constructed from the response data of the request.

errorBlock

The block is executed on the completion of an unsuccessful request. This block has no return value and takes one argument: the error that occurred during the request.

Return Value

A new request operation.

Declared In

VMActivityManager.h

setUpdateDate:

Sets block called when sending the activity stack (returns NSDate).

- (void)setUpdateDate:(ObjectBlock)block

Parameters

block

block called when sending the activity stack. If nil is passed here, parameter will be nil.

Declared In

VMActivityManager.h

setUpdateStackActivity:

Sets block that is called when the activity stack is updated (returns NSArray).

- (void)setUpdateStackActivity:(ObjectBlock)block

Parameters

block

block called when the activity stack is updated (returns NSArray). If nil is passed here, parameter will be nil.

Declared In

VMActivityManager.h