iOS

Get your iOS app connected to social.plus in just a few steps. This guide covers everything from installation to your first authenticated session.

Requirements

Xcode 26.0+
iOS 14.0+
Swift 5.0+

Installation

Swift Package Manager (Recommended)
Manual Installation

Add the social.plus SDK to your project using Swift Package Manager:

In Xcode, select File → Add Package Dependencies

Enter the repository URL:

https://github.com/AmityCo/Amity-Social-Cloud-SDK-iOS-SwiftPM

Select Up to Next Major Version and click Add Package
Choose AmitySDK and click Add Package

Use “Up to Next Major Version” to ensure compatibility with future updates.

Download the latest iOS SDK
Drag AmitySDK.xcframework to your project
Select Copy items if needed and click Finish
Set the Embed option to Embed & Sign

For M1 Macs using the simulator, enable Rosetta mode for the application.

Parameters

Operation	Parameter	Required	Description
Initialize SDK	API key	Yes	Application API key from the social.plus Console.
Initialize SDK	Region	Yes	Region passed to `AmityClient`, such as `.US`, `.EU`, or `.SG`.
Objective-C bridge login	`userId`	Yes	Stable user identifier from your identity system.
Objective-C bridge login	`displayName`	No	Display name passed through the Swift bridge.
Objective-C bridge login	`authToken`	Production	Backend-generated auth token passed through the Swift bridge.
Objective-C bridge login	Completion callback	Yes	Callback that reports success or failure back to Objective-C.

Initialize the SDK

Create the client with your API key and region so the SDK is ready for authentication.

import AmitySDK

let client = try! AmityClient(apiKey: "YOUR_API_KEY", region: .SG)

This creates the SDK client but does not yet authenticate a user. See Authentication for the next step.

Objective-C Integration

Starting with v6.0.0, AmitySDK for iOS is written in Pure Swift. You can still use it in Objective-C projects by creating a Mixed-Language Project.

We recommend integrating AmitySDK directly into your Objective-C project and using Swift language to call the SDK interfaces for better compatibility and performance.

Mixed Language Project Setup

Create Swift files with necessary interfaces/methods that interact with AmitySDK. These interfaces should be exposed with @objc or @objcMembers attributes. When you add a new Swift file to your Objective-C project, Xcode automatically generates a bridging header file that exposes your Swift code to Objective-C.

📖 Learn More: Importing Swift into Objective-C - Apple Developer

Implementation Example

Swift Bridge File
Objective-C Usage

Create a Swift file that wraps AmitySDK functionality:

// SDKLoginManager.swift
// Example of a Swift file which contains a class to interact with AmitySDK

import AmitySDK

class NoopSessionHandler: SessionHandler {
    func sessionWillRenewAccessToken(renewal: any AccessTokenRenewal) {}
}

@objc class SDKLoginManager: NSObject {
    
    let client: AmityClient?
    
    @objc init(apiKey: String) {
        self.client = try? AmityClient(apiKey: apiKey)
    }
    
    @objc func login(userId: String, displayName: String, authToken: String, completion: @escaping (Bool, Error?) -> Void) {
        Task {
            do {
                try await self.client?.login(
                    userId: userId,
                    displayName: displayName.isEmpty ? nil : displayName,
                    authToken: authToken.isEmpty ? nil : authToken,
                    sessionHandler: NoopSessionHandler()
                )
                completion(true, nil)
            } catch {
                completion(false, error)
            }
        }
    }
    
    @objc func logout() {
        Task { try? await self.client?.secureLogout() }
    }
    
    @objc func isLoggedIn() -> Bool {
        guard let state = self.client?.sessionState else { return false }
        if case .established = state { return true }
        return false
    }
    
    @objc func getCurrentUserId() -> String? {
        return self.client?.currentUserId ?? nil
    }
}

Use the Swift bridge in your Objective-C code:

// ViewController.m
#import "ViewController.h"
#import "YourProjectName-Swift.h" // <- This import exposes your Swift file

@interface ViewController ()
@property (nonatomic, strong) SDKLoginManager *loginManager;
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    
    // Initialize the SDK manager
    self.loginManager = [[SDKLoginManager alloc] initWithApiKey:@"your-api-key"];
}

- (void)performLogin {
    [self.loginManager loginWithUserId:@"user-123" 
                           displayName:@"John Doe" 
                             authToken:@"your-auth-token" 
                            completion:^(BOOL isSuccess, NSError * _Nullable error) {
        
        dispatch_async(dispatch_get_main_queue(), ^{
            if (isSuccess) {
                NSLog(@"Login successful");
                // Navigate to main app
                [self showMainApp];
            } else {
                NSLog(@"Login failed: %@", error.localizedDescription);
                // Show error message
                [self showErrorAlert:error.localizedDescription];
            }
        });
    }];
}

- (void)performLogout {
    [self.loginManager logout];
    NSLog(@"User logged out");
}

- (void)checkLoginStatus {
    if ([self.loginManager isLoggedIn]) {
        NSString *userId = [self.loginManager getCurrentUserId];
        NSLog(@"User is logged in: %@", userId);
    } else {
        NSLog(@"User is not logged in");
    }
}

// Helper methods
- (void)showMainApp {
    // Your navigation logic here
}

- (void)showErrorAlert:(NSString *)message {
    UIAlertController *alert = [UIAlertController alertControllerWithTitle:@"Login Error"
                                                                   message:message
                                                            preferredStyle:UIAlertControllerStyleAlert];
    
    UIAlertAction *okAction = [UIAlertAction actionWithTitle:@"OK"
                                                       style:UIAlertActionStyleDefault
                                                     handler:nil];
    [alert addAction:okAction];
    
    [self presentViewController:alert animated:YES completion:nil];
}

@end

Key Considerations

Project Configuration

Bridging Header: Xcode automatically creates a bridging header when you add Swift files to an Objective-C project.Import Statement: Use #import "YourProjectName-Swift.h" to access Swift classes in Objective-C.Target Membership: Ensure your Swift files are added to the correct target.

Performance Tips

Minimize Bridge Calls: Create comprehensive wrapper methods rather than making frequent cross-language calls.Error Handling: Properly handle Swift optionals and errors in your Objective-C code.Threading: Always dispatch UI updates to the main queue when handling completion callbacks.

Common Issues

Module Not Found: Ensure your project’s module name doesn’t contain special characters or spaces.Swift Version: Make sure your Objective-C project supports the Swift version used by AmitySDK.Linker Errors: Verify that both Objective-C and Swift files are properly linked to your target.

Next Steps

Authentication Guide

Learn about session management and secure authentication flows

Chat Features

Start building chat and messaging features

Social Features

Add posts, feeds, and social interactions

Video Streaming

Implement live video and streaming features

Troubleshooting

Installation Issues

Framework not found: Ensure you’ve added all required frameworks and set them to “Embed & Sign”Swift version conflicts: Ensure your project uses Swift 5.0 or later

Runtime Issues

SDK not initialized: Make sure you call AmityClient.setup(...) in application delegateAuthentication failures: Verify your API key and region settingsPermission denied: Check that required permissions are added to Info.plist

Platform-Specific Issues

M1 Mac Simulator Issues: Enable Rosetta for your application in Xcode

Powered by

Getting Started

Fundamentals

Social

Chat

Video

Release Notes

Migration Guides

Support

Requirements

Installation

Parameters

Initialize the SDK

Objective-C Integration

Mixed Language Project Setup

Implementation Example

Key Considerations

Next Steps

Authentication Guide

Chat Features

Social Features

Video Streaming

Troubleshooting

​Requirements

​Installation

​Parameters

​Initialize the SDK

​Objective-C Integration

​Mixed Language Project Setup

​Implementation Example

​Key Considerations

​Next Steps

Authentication Guide

Chat Features

Social Features

Video Streaming

​Troubleshooting

Requirements

Installation

Parameters

Initialize the SDK

Objective-C Integration

Mixed Language Project Setup

Implementation Example

Key Considerations

Next Steps

Troubleshooting