Skip to content

Visual Inbox

Fetching Inbox Details

Upshot.ai provides all activity information to the application, which is to be stored and later used in dynamic help sections within the app. This powerful feature allows you to organize and display activities in specific app sections based on your needs.

Examples:

  • To display an activity (say tutorials) only in help section
  • To show mini-games exclusively in a funzone area
  • To organize surveys and polls in a feedback section
  • To create context-specific activity displays throughout your app

How to Fetch Inbox Details

objective-c
// Fetch inbox information for activities
[[BrandKinesis sharedInstance] fetchInboxInfoWithCompletionBlock:^(NSArray * _Nonnull inbox) {
}];
swift
// Fetch inbox information for activities
BrandKinesis.sharedInstance(). fetchInboxInfo { (inbox) in
}

Sample Inbox Response Structure

The inbox details response contains categorized activities:

json
[
  {
    "name": "Badge",
    "activities": [
      {
        "type": 9,
        "taken": "takenornot",
        "activityId": "58f9ec9e2b2f15c5608b456958fa080a2b2f15f8188b456c",
        "actName": "New Badge",
        "tags": ["Tag"]
      }
    ]
  },
  {
    "name": "Tutorials",
    "activities": [
      {
        "type": 7,
        "taken": "not_taken",
        "activityId": "59a1bc8e3d4f16d7719c567a59a2ef1b3d4f17e8729c567d",
        "actName": "App Tutorial",
        "tags": ["Help", "Onboarding"]
      }
    ]
  }
]

Activity Types Reference

TypeActivity NameDescription
0SurveyUser feedback surveys
1RatingApp rating requests
5Opinion PollUser opinion collection
7TutorialsStep-by-step guides
8In-App MessageDirect messages to users
9BadgesAchievement badges
10Screen TipsContextual help tips
11TriviaInteractive trivia games
12Custom ActionCustom app actions
13Mini GamesEngaging mini-games

Displaying Activities by ID

Once you have activity IDs from the inbox, you can display specific activities:

objective-c
// Show a specific activity using its ID from inbox
- (void)showActivityFromInbox:(NSString *)activityId {
    [[Brandkinesis sharedInstance] showActivityWithActivityId:activityId];
}
swift
// Show a specific activity using its ID from inbox
func showActivityFromInbox(activityId: String) {
    BrandKinesis.sharedInstance(). showActivity(withActivityId: activityId)
}

Use Cases for Inbox Details

  1. Dynamic Help Sections: Store tutorial and guide activities for later use in help menus
  2. Funzone Areas: Display mini-games and trivia activities exclusively in entertainment sections
  3. Feedback Centers: Organize surveys, polls, and rating activities in dedicated feedback areas
  4. Activity Management: Track which activities are available vs. completed across different app sections
  5. Content Organization: Group activities by category, type, or intended display location

Powered by Upshot.ai