Skip to main content

Requirements and releases

What each Octopus SDK needs to build, which features each platform supports, and where each SDK publishes its release notes. The values below are those of the current releases: 1.15.2 for Android and React Native, and 1.15.0 for iOS, Flutter and Unity. React Native 1.15.2 embeds the Android SDK 1.15.2 and the iOS SDK 1.15.0.

Requirements​

PlatformMinimum OSToolchainUI
AndroidAndroid 6.0 (API 23), compileSdk 35Kotlin 2.1, Java 11Jetpack Compose with Material 3
iOSiOS 13.0Xcode 16 (Swift tools 6.0)SwiftUI, hostable in UIKit with a UIHostingController
FlutterAndroid API 23, compileSdk 35; iOS 14.0Flutter 3.44, Dart 3.12, Kotlin 2.1, Android Gradle Plugin 8.6The Android and iOS SDK screens
React NativeAndroid 7.0 (API 24); iOS 15.1React Native 0.81, Kotlin 2, Xcode 16.1The Android and iOS SDK screens
UnityAndroid API 23; iOS 13.0Unity 2019.4The Android and iOS SDK screens

Platform notes:

  • Flutter: the Android host activity must extend FlutterFragmentActivity, not FlutterActivity.
  • React Native: both the old and the new architecture are supported, the new one through the interop layer. On iOS, the Podfile needs use_frameworks! :linkage => :static; with Expo, set useFrameworks: "static" through expo-build-properties. The Android module compiles against the compileSdkVersion of your app, and against API 36 when your app does not set one.
  • Unity: the External Dependency Manager for Unity resolves the Android SDK. The iOS SDK is added as a Swift package when Unity exports the Xcode project, so no CocoaPods setup is needed. An iOS export from Unity 6000.3 does not launch on iOS 27, a Unity limitation: export from Unity 6000.5 or later.

Package managers​

PlatformPackage managerPackages
AndroidMaven Central (mavenCentral())com.octopuscommunity:octopus-sdk, com.octopuscommunity:octopus-sdk-ui
iOSSwift Package Manager (recommended) or CocoaPodsSPM products Octopus and OctopusUI; pods OctopusCommunity and OctopusCommunityUI
Flutterpub.devoctopus_sdk_flutter
React Nativenpm@octopus-community/react-native
UnityUnity Package Manager (Git URL) or a .unitypackagecom.octopuscommunity.octopus_sdk_for_unity

The install commands are in the Quickstart.

Privacy manifest​

The iOS SDK ships an Apple privacy manifest, PrivacyInfo.xcprivacy, as a resource of the Octopus target. Xcode includes it in your app's privacy report, and Flutter, React Native and Unity apps get it through the iOS SDK. You have nothing to add.


Feature availability​

A version is the first release of that SDK with the feature; Yes means that every supported release has it, and — that the platform does not have it. Each guide repeats the minimum versions next to the feature.

FeatureAndroidiOSFlutterReact NativeUnityGuide
SSOYesYesYesYesYesConnect your users
Read and refresh entitlements1.12.01.12.01.12.01.13.01.13.0Entitlements
Detect a guest session1.12.61.12.61.12.21.13.01.14.0Guest sessions
Ban message before a banned guest's actions1.14.21.14.01.15.01.15.01.14.2Guest connection failures
GroupsYesYesYesYesYesGroups
Follow or unfollow one groupYes—Yes1.13.01.13.0Groups
Bridges to your app's contentYesYes1.12.01.13.01.13.0Bridges
Not-seen notifications badgeYesYesYesYesYesNotification center
Push notificationsYesYesYesYesYesPush notifications
SDK eventsYesYesYesYes1.12.2Events reference
profileReported eventYes—Yes¹Yes¹1.12.2¹Events reference
Community access and A/B testingYesYesYesYesYesA/B testing
ThemingYesYesYesYesYesTheming
Navigation-bar item size—Yes1.13.1¹1.13.0¹Yes¹Theming
Screen-based themingYes————Theming
Icons and imagesYesYes1.14.01.14.01.14.0Icons and images
Language overrideYesYesYesYesYesLocalization
Reset and stop the SDKYes—1.12.01.13.01.13.0Configuration
Check whether the SDK is initializedYes—1.12.01.13.0—Configuration
Open Octopus screens from your deep linksYes————Configuration
Unified Profile1.13.01.13.01.13.01.13.01.13.0Unified Profile
Choose the initial profile or Activity tab1.14.0————Unified Profile
Read a member's comments and replies1.14.0————Unified Profile
Content options1.12.11.12.31.12.21.13.01.12.2Community settings
Profile field lock1.12.11.12.31.12.21.13.01.12.2Community settings
Comments tab visibility1.14.01.14.01.14.01.14.01.14.0Community settings
Image-and-poll posts and optional text for image posts1.15.01.15.01.15.01.15.01.15.0Content options
Nickname choice before contributing1.15.01.15.01.15.01.15.01.15.0Nickname choice
Community consent wordings1.15.01.15.01.15.01.15.01.15.0Consent wordings
Clear-text icon1.15.01.15.01.15.01.15.01.15.0Icons
Screen state illustrations1.14.01.14.01.14.01.14.01.15.0Illustrations
App-managed audio session—Yes—1.15.0¹1.15.0¹Configuration
Editor Mock Mode————1.12.1Unity Editor Mock Mode

¹ Android apps only for profileReported, iOS apps only for the navigation-bar item size and app-managed audio session.


Release notes​

Since 1.15.0, all five SDKs support SSO only. Octopus-owned Magic Link/email sign-in, account settings, SDK account deletion and the log out entry are removed. Your app owns authentication and account management; see Connect your users.

Every SDK publishes its changes, and the migration steps of a breaking release, in its public repository:

Next steps​

  • Quickstart: install the SDK and show the community.
  • Sample apps: run a complete integration on your platform.