Visitor Access

UIKit automatically adapts its interface and behaviour when a visitor or bot session is active. This guide covers the UIKit-specific layer on top of SDK visitor mode.

Prerequisites: Visitor mode must be enabled for your network and the SDK must be logged in as a visitor before UIKit renders. See SDK Visitor Mode for login setup.

Tab Visibility

UIKit adjusts which tabs are visible based on user type. Visitors see a read-only subset of the navigation:

Tab	Visitor	Signed-In
Communities / Explore	✅ Visible (default)	✅ Visible
Events	✅ Visible	✅ Visible
Clips	Configurable (`can_view_tab`)	✅ Visible
Newsfeed / Following	❌ Hidden	✅ Visible

The Clips tab is not available on React Native.

// config.json — control Clips tab visibility for visitors
{
  "feature_flags": {
    "post": {
      "clip": {
        "can_view_tab": "all"           // show to visitors
        // "can_view_tab": "signed_in_user_only"  // hide from visitors (default)
      }
    }
  }
}

Restricted Action Handling

When a visitor attempts a write action (react, comment, reply, follow), UIKit shows a sign-in prompt by default. Override handleVisitorUserAction in AmityGlobalBehavior to navigate to your own sign-in screen instead. On iOS the equivalent is named handleGuestUserAction.

iOS
Android
Web
React Native

import AmityUIKit4

AmityUIKit4Manager.behaviour.globalBehavior = MyGlobalBehavior()

class MyGlobalBehavior: AmityGlobalBehavior {
    override func handleGuestUserAction(context: Context?) {
        // Default: show sign-in toast
        // Override: navigate to your sign-in screen
        MyAuthFlow.presentSignIn()
    }
}

import com.amity.socialcloud.uikit.AmityUIKit4Manager
import com.amity.socialcloud.uikit.common.behavior.AmityGlobalBehavior

AmityUIKit4Manager.behavior.globalBehavior = object : AmityGlobalBehavior() {
    override fun handleVisitorUserAction() {
        // Default: show sign-in toast
        // Override: navigate to your sign-in screen
        startActivity(Intent(context, SignInActivity::class.java))
    }
}

import { AmityUiKitProvider } from '@amityco/ui-kit';

<AmityUiKitProvider
  pageBehavior={{
    AmityGlobalBehavior: {
      handleVisitorUserAction: () => {
        // Default: show sign-in toast
        // Override: navigate to your sign-in screen
        router.push('/sign-in');
      },
    }
  }}
>

import { AmityUiKitProvider } from '@amityco/react-native-social-uikit';

<AmityUiKitProvider
  behaviour={{
    AmityGlobalBehaviour: {
      handleVisitorUserAction: () => {
        // Default: show sign-in toast
        // Override: navigate to your sign-in screen
        navigation.navigate('SignIn');
      },
    },
  }}
>

Daily Usage Limit Page

When a visitor exceeds their daily usage limit (its size is an ops-level setting), the backend returns error 400323. UIKit automatically subscribes to the SDK’s visitorUsageLimitReached event and shows a full-screen VisitorUsageLimitPage that blocks further navigation until the user signs in.

Default Page

Back gestures and the system back button are disabled while the page is shown:

Web: Navigation stack unmounted at root
Android: Activity back stack cleared, back press swallowed
iOS: Presented modally, swipe-back disabled
React Native: Navigator replaced at root, hardware back press swallowed

Platform Availability

Platform	UIKit Version	Notes
Android	4.18.0+	`AmityGlobalBehavior` overrides available
iOS	4.22.0+	`AmityGlobalBehavior` overrides available
Web	4.17.0+	`AmityGlobalBehavior` overrides available
React Native	4.1.0+	`AmityGlobalBehaviour` overrides available

Customizing the Error Page

Use two new AmityGlobalBehavior handlers to replace the default experience:

Handler	Default behaviour	Override use case
`handleVisitorUsageLimitReached`	Show `VisitorUsageLimitPage` full-screen	Show your own branded error UI
`handleVisitorUsageLimitSignIn`	Show toast: “Create an account or sign in to continue.”	Navigate to your own sign-in screen

iOS
Android
Web
React Native

import AmityUIKit4

class MyGlobalBehavior: AmityGlobalBehavior {

    // Replace the full-page error with your own UI
    override func handleVisitorUsageLimitReached() {
        MyAuthFlow.presentVisitorLimitError()
    }

    // Replace the "Sign in" CTA action
    override func handleVisitorUsageLimitSignIn() {
        MyAuthFlow.presentSignIn()
    }
}

AmityUIKit4Manager.behaviour.globalBehavior = MyGlobalBehavior()

import com.amity.socialcloud.uikit.AmityUIKit4Manager
import com.amity.socialcloud.uikit.common.behavior.AmityGlobalBehavior

AmityUIKit4Manager.behavior.globalBehavior = object : AmityGlobalBehavior() {

    // Replace the full-page error with your own UI
    override fun handleVisitorUsageLimitReached() {
        startActivity(Intent(context, VisitorLimitActivity::class.java))
    }

    // Replace the "Sign in" CTA action
    override fun handleVisitorUsageLimitSignIn() {
        startActivity(Intent(context, SignInActivity::class.java))
    }
}

import { AmityUiKitProvider } from '@amityco/ui-kit';

<AmityUiKitProvider
  pageBehavior={{
    AmityGlobalBehavior: {
      // Replace the full-page error with your own UI
      // If provided, the default <VisitorUsageLimitPage /> root-swap is skipped
      handleVisitorUsageLimitReached: () => {
        setShowCustomLimitPage(true);
      },

      // Replace the "Sign in" CTA action
      handleVisitorUsageLimitSignIn: () => {
        router.push('/sign-in');
      },
    }
  }}
>

import { AmityUiKitProvider } from '@amityco/react-native-social-uikit';

<AmityUiKitProvider
  behaviour={{
    AmityGlobalBehaviour: {
      // Replace the full-page error with your own UI
      handleVisitorUsageLimitReached: () => {
        navigation.navigate('VisitorLimit');
      },

      // Replace the "Sign in" CTA action
      handleVisitorUsageLimitSignIn: () => {
        navigation.navigate('SignIn');
      },
    },
  }}
>

The usage limit state is in-memory only. It resets automatically when the app restarts or when registerDevice() is called with a signed-in userId. Never persist the state to local storage — this ensures users see the normal UI again after signing in or after the daily quota resets.

SDK Visitor Mode

Visitor login, device fingerprinting, secure mode, and SDK error codes

Error Handling

Full server error reference including 400323, 403999, 403998

Powered by

Getting Started

Customization

Components

Release Notes

Support

Tab Visibility

Restricted Action Handling

Daily Usage Limit Page

Default Page

Platform Availability

Customizing the Error Page

SDK Visitor Mode

Error Handling

​Tab Visibility

​Restricted Action Handling

​Daily Usage Limit Page

Default Page

​Platform Availability

​Customizing the Error Page

​Related

SDK Visitor Mode

Error Handling

Tab Visibility

Restricted Action Handling

Daily Usage Limit Page

Platform Availability

Customizing the Error Page

Related