Tag Screen Name

UXCam captures the Screen (view controller/activity) name automatically. However, there are some cases where you will need to manually tag your screens to ensure you have them separately in your recordings and heatmaps.

Use our API to tag screens if you:

  • Use OpenGL or have a game where the screens are dynamically shown.
  • Have one or more fragments inside an Android activity, and you need to tag fragment name instead of an activity.
  • Use SwiftUI, Flutter, React Native or Cordova, where the application usually runs within a single activity or controller.
  • Want to define which views or activities should be considered screens or want to define different names.

📘

Note: Cross-platform frameworks often have inconsistent view controller/activity naming; it is recommended to manually tag your screens if you're using such frameworks.

🚧

Important

Keep in mind if there is an update in the names of the screens, this will generate a new screenshot in the Heatmap section.

Tag Screen Name

UXCam.tagScreenName(_ screenName: String)
UXCam.tagScreenName(String screenName);
RNUxcam.tagScreenName: (screenName: string) => void
void tagScreenName(String screenName)
uxcamTagScreenName(_ screenName: String) -> some View

//eg. 
var body: some View
{
    Text("Hello world")
        .uxcamTagScreenName("HelloScreen")
}
void UXCam.TagScreenName(string screenName)
UXCam.tagScreenName: (screenName: string) => void
NSUXCam.tagScreenName: (screenName: string) => void

📘

The API parameters are:
screenName: A String with name of the screen as required.

Control Automatic Tagging

To Enable or Disable the automatic screen tagging you should use:

void UXCam.SetAutomaticScreenNameTagging(bool enable)
UXCam.setAutomaticScreenNameTagging: (enable: boolean) => void
NSUXCam.setAutomaticScreenNameTagging: (enable: boolean) => void

📘

The API parameters are:
enable: Set to TRUE to enable automatic screen name tagging (the default) or FALSE to disable it.

📘

For screens that scroll:

  • Tag screen name as usual - you can find an instruction above
    • When a user scrolls to 800 points - change the screen name using our tag API. The scroll area is calculated by default UIKit methods - it should be one of the “scroll view delegate methods”
    • The same follows for the third section 800*2 = 1600. Once a user scrolls to 1600, change to the 3rd screen name.
    • When users scroll up, the same calculation can be applied.

The biggest challenge that can appear is if users have both section 1 and some part of section 2 visible (it can usually happen on big iPad screens for apps not optimized for iPads). However, if it’s not the case for your app, you can go ahead and use this workaround for the long screens.