Skip to content

Latest commit

 

History

History
67 lines (36 loc) · 3.11 KB

README.md

File metadata and controls

67 lines (36 loc) · 3.11 KB
Raw

Twilio Conversations for iOS

This repository contains releases for the Twilio Conversations for iOS SDK. These releases can be consumed using Swift Package Manager, CocoaPods or manual integration into your project.

Mac Catalyst Pilot

If you are interested in Mac Catalyst support please contact support.

Swift Package Manager

You can add Conversations Client for iOS by adding the https://github.com/twilio/conversations-ios repository as a Swift Package.

In your Build Settings, you will also need to modify Other Linker Flags to include -ObjC.

There is a known issue with consuming binary frameworks distributed via Swift Package Manager. The current workaround to this issue is to add a Run Script Phase to the Build Phases of your Xcode project. This Run Script Phase should come after the Embed Frameworks build phase. This new Run Script Phase should contain the following code:

find "${CODESIGNING_FOLDER_PATH}" -name '*.framework' -print0 | while read -d $'\0' framework
do
    codesign --force --deep --sign "${EXPANDED_CODE_SIGN_IDENTITY}" --preserve-metadata=identifier,entitlements --timestamp=none "${framework}"
done

CocoaPods Integration

We support integration using CocoaPods as well. You can add Twilio Conversations Client to your project using the following example Podfile:

source 'https://github.com/CocoaPods/Specs'

platform :ios, '13.0'

target 'TARGET_NAME' do
    pod 'TwilioConversationsClient', '~> 3.1'
end

Then run pod install to install the dependencies for your project.

Manual Integration

TwilioConversationsClient.xcframework is distributed as a dynamic iOS framework that you can drag and drop into your existing projects.

Once you've downloaded and unpacked the XCFramework, navigate to your Xcode project's General settings page. Drag and drop TwilioConversationsClient.xcframework onto the Frameworks, Libraries, and Embedded Content section. Ensure that "Copy items if needed" is checked and press Finish. Ensure that "Embed & Sign" is selected.

In your Build Settings, you will also need to modify Other Linker Flags to include -ObjC.

Carthage Integration

Carthage is not currently a supported distribution mechanism for Twilio Conversations Client. Carthage does not currently work with .xcframeworks as documented here. Once Carthage supports binary .xcframeworks, Carthage distribution will be re-added.

Issues and Support

Please file any issues you find here on Github.

Please ensure that you are not sharing any Personally Identifiable Information(PII) or sensitive account information (API keys, credentials, etc.) when reporting an issue.

For general inquiries related to the Conversations SDK you can file a support ticket.

License

Twilio Conversations for iOS is distributed under TWILIO-TOS.