MFStorylineDetail Class Reference

Inherits from NSObject
Declared in MFStorylineDetail.h
MFStorylineDetail.m

Overview

The MFStorylineDetail class represent a storyline campaign for triggered beacon(s) within a single event.

  objectId

Specifies the unique id of MFStorylineDetail object.

@property (strong, nonatomic, readonly, nullable) NSString *objectId

Discussion

This field will be assigned by fetching current object that exists or by saving new user to Mesosfer cloud.

Declared In

MFStorylineDetail.h

  createdAt

Specifies the created timestamp of MFStorylineDetail object.

@property (strong, nonatomic, readonly, nullable) NSDate *createdAt

Discussion

This field will be assigned by fetching current object that exists or by saving new user to Mesosfer cloud.

Declared In

MFStorylineDetail.h

  updatedAt

Specifies the last updated timestamp of MFStorylineDetail object.

@property (strong, nonatomic, readonly, nullable) NSDate *updatedAt

Discussion

This field will be assigned by fetching current object that exists or by saving new user to Mesosfer cloud.

Declared In

MFStorylineDetail.h

  storyline

Specifies the MFStoryline object that group the storyline detail.

@property (strong, nonatomic, nullable) MFStoryline *storyline

Declared In

MFStorylineDetail.h

  beacons

Specifies the array of MFBeacon that use this storyline.

@property (strong, nonatomic, nullable) NSArray<MFBeacon*> *beacons

Declared In

MFStorylineDetail.h

  campaign

Specifies the MFStorylineCampaign object of storyline.

@property (assign, nonatomic) MFStorylineCampaign campaign

Declared In

MFStorylineDetail.h

  event

Specifies the MFBeaconEvent object of storyline.

@property (assign, nonatomic) MFBeaconEvent event

Declared In

MFStorylineDetail.h

  showOn

Specifies the MFShowDay object of storyline.

@property (strong, nonatomic, nullable) MFShowDay *showOn

Declared In

MFStorylineDetail.h

  alertTitle

MFShowDay the alert title of storyline.

@property (strong, nonatomic, nullable) NSString *alertTitle

Declared In

MFStorylineDetail.h

  alertMessage

Specifies the alert message of storyline.

@property (strong, nonatomic, nullable) NSString *alertMessage

Declared In

MFStorylineDetail.h

  urlPage

Specifies the url web page to open.

@property (strong, nonatomic, nullable) NSString *urlPage

Declared In

MFStorylineDetail.h

  urlVideo

Specifies the url video to play.

@property (strong, nonatomic, nullable) NSString *urlVideo

Declared In

MFStorylineDetail.h

  urlImageAndroid

Specifies the url image to display for Android.

@property (strong, nonatomic, nullable) NSString *urlImageAndroid

Declared In

MFStorylineDetail.h

  urlImageIOS

Specifies the url image to display for iOS.

@property (strong, nonatomic, nullable) NSString *urlImageIOS

Declared In

MFStorylineDetail.h

+ storylineDetailWithStorylineId:NS_SWIFT_NAME:

Creates a new MFStorylineDetail with an objectId of MFStoryline.

+ (nonnull instancetype)storylineDetailWithStorylineId:(nonnull NSString *)storylineId NS_SWIFT_NAME

Parameters

storylineId

An objectId of MFStoryline.

Return Value

the object detail storyline that is instantiated with the given parameter.

Declared In

MFStorylineDetail.h

+ storylineDetailWithStoryline:NS_SWIFT_NAME:

Creates a new MFStorylineDetail with an object of MFStoryline.

+ (nonnull instancetype)storylineDetailWithStoryline:(nonnull MFStoryline *)storyline NS_SWIFT_NAME

Parameters

storyline

An object of MFStoryline.

Return Value

the object detail storyline that is instantiated with the given parameter.

Declared In

MFStorylineDetail.h

+ storylineDetailWithObjectId:NS_SWIFT_NAME:

Creates a reference to an existing MFStorylineDetail for use in creating associations between MFStorylineDetails.

+ (nonnull instancetype)storylineDetailWithObjectId:(nonnull NSString *)objectId NS_SWIFT_NAME

Parameters

objectId

The object id for the referenced MFStorylineDetail object.

Return Value

A MFStorylineDetail instance without data.

Discussion

Warning: You need to call MFStorylineDetail.fetchAsyncWithBlock: to fetch object from Mesosfer cloud.

Declared In

MFStorylineDetail.h

+ query

Creates a new MFQuery instance for querying MFStorylineDetail object.

+ (nonnull MFQuery *)query

Return Value

A new MFQuery instance.

Declared In

MFStorylineDetail.h

– dictionary

Gets all key and value pair of MFStorylineDetail object in a dictionary.

- (nullable NSDictionary *)dictionary

Return Value

The dictionary of all key and value pair object.

Declared In

MFStorylineDetail.h

– fetchAsyncWithBlock:

Fetch the current MFStorylineDetail data from Mesosfer cloud asynchronously and executes the given callback block.

- (void)fetchAsyncWithBlock:(nullable MFObjectResultBlock)block

Parameters

block

The block to execute. It shoud have the following argument signature: ^(MFStorylineDetail *detail, NSError *error).

Declared In

MFStorylineDetail.h

– saveAsyncWithBlock:

Saves the MFStorylineDetail asynchronously and executes the given callback block.

- (void)saveAsyncWithBlock:(nullable MFBooleanResultBlock)block

Parameters

block

The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

Declared In

MFStorylineDetail.h

– deleteAsyncWithBlock:

Delete the MFStorylineDetail object in Mesosfer cloud asynchronously and executes the given callback block.

- (void)deleteAsyncWithBlock:(nullable MFBooleanResultBlock)block

Parameters

block

The block to execute. It should have the following argument signature: ^(BOOL succeeded, NSError *error).

Declared In

MFStorylineDetail.h