Instala el SDK para iOS, macOS, tvOS y watchOS

Overview

Atlas Device SDK for Swift enables you to build iOS, macOS, tvOS, and watchOS applications using either the Swift or Objective-C programming languages. This page details how to install the SDK in your project and get started.

Requisitos previos

Before getting started, ensure your development environment meets the following prerequisites:

• Su proyecto utiliza una versión de Xcode y una versión mínima del sistema operativo que figuran en la Sección desoporte del sistema operativo de esta página.

• La reflexión está habilitada en tu proyecto. El SDK de Swift utiliza la reflexión para determinar las propiedades de tu modelo. Tu proyecto no debe configurar SWIFT_REFLECTION_METADATA_LEVEL = none, o el SDK no puede ver las propiedades de su modelo. Reflection está habilitado de forma predeterminada si su proyecto no define específicamente un nivel para esta configuración.

Instalación

You can use SwiftPM, CocoaPods, or Carthage to add the Swift SDK to your project.

SwiftPM

CocoaPods

Carthage

Dynamic Framework

1

Add Package Dependency

En Xcode, seleccione File > Add Packages....

2

Specify the Repository

Copy and paste the following into the search/input box.

https://github.com/realm/realm-swift.git

3

Especificar opciones

En las opciones del realm-swift paquete, recomendamos configurar Dependency Rule Up to Next Major Versionen e ingresar la versión actual del SDK de Realm Swift. Luego, haga clic Add Package en.

4

Select the Package Products

Changed in version 10.49.3: Instead of adding both, only add one package.

Select either RealmSwift or Realm, then click Add Package.

• Si usas APIs de Swift o Swift y Objective-C, añade RealmSwift.

• Si usa solo las API de Objective-C, agrega Realm.

5

(Opcional) compilar RealmSwift como un framework dinámico

Para usar el Manifiesto de Privacidad proporcionado por el SDK, cree RealmSwift como un marco dinámico. Si crea RealmSwift como un marco estático, debe proporcionar su propio Manifiesto de Privacidad.

Para construir RealmSwift como un marco dinámico:

1. En tu proyecto Targets, seleccione su objetivo de compilación.

2. Vaya a la pestaña General.

3. Expand the Frameworks and Libraries element.

4. Para el marco RealmSwift, cambie la opción Embed de "No incrustar" a "Incrustar y firmar".

Now, Xcode builds RealmSwift dynamically, and can provide the SDK-supplied Privacy Manifest.

If you are installing with CocoaPods, you need CocoaPods 1.10.1 or later.

1

Update the CocoaPods repositories

On the command line, run pod repo update to ensure CocoaPods can access the latest available Realm versions.

2

Inicializa CocoaPods para tu proyecto

If you do not already have a Podfile for your project, run pod init in the root directory of your project to create a Podfile for your project. A Podfile allows you to specify project dependencies to CocoaPods.

3

Agrega el SDK como dependencia en tu Podfile

Objective C

Swift

Add the line pod 'Realm', '~>10' to your main and test targets.

Add the line use_frameworks! as well if it is not already there.

When done, your Podfile should look something like this:

# Uncomment the next line to define a global platform for your project
# platform :ios, '11.0'
target 'MyDeviceSDKProject' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
# Pods for MyDeviceSDKProject
pod 'Realm', '~>10'
target 'MyRealmProjectTests' do
   inherit! :search_paths
   # Pods for testing
   pod 'Realm', '~>10'
end
end

Agrega la línea use_frameworks! si aún no está allí.

Add the line pod 'RealmSwift', '~>10' to your main and test targets.

When done, your Podfile should look something like this:

platform :ios, '12.0'
target 'MyDeviceSDKProject' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!
  # Pods for MyDeviceSDKProject
  pod 'RealmSwift', '~>10'
end

4

Instalar las dependencias

From the command line, run pod install to fetch the dependencies.

5

Utilice el archivo generado por CocoaPods .xcworkspace

CocoaPods genera un archivo .xcworkspace para ti. Este archivo tiene todas las dependencias configuradas. A partir de ahora, abre este archivo -- no el archivo .xcodeproj -- para trabajar en tu proyecto.

If you are installing with Carthage, you need Carthage 0.33 or later.

1

Agregue el SDK como una dependencia en su Cartfile

Add the SDK as a dependency by appending the line github "realm/realm-swift" to your Cartfile.

Puedes crear un Cartfile o añadirlo a uno existente ejecutando el siguiente comando en el directorio de tu proyecto:

echo 'github "realm/realm-swift"' >> Cartfile

2

Instalar las dependencias

From the command line, run carthage update --use-xcframeworks to fetch the dependencies.

3

Agrega los marcos a tu proyecto

Carthage places the built dependencies in the Carthage/Build directory.

Abre el archivo xcodeproj de tu proyecto en Xcode. Ve al panel Panel de navegación de proyectos y haz clic en el nombre de tu aplicación para abrir el editor de configuración del proyecto. Selecciona la pestaña General.

In Finder, open the Carthage/Build/ directory. Drag the RealmSwift.xcframework and Realm.xcframework files found in that directory to the Frameworks, Libraries, and Embedded Content section of your project's General settings.

haga clic para ampliar

1

Download and Extract the Framework

Download the latest release of the Swift SDK and extract the zip.

2

Copy Framework(s) Into Your Project

Arrastra Realm.xcframework y RealmSwift.xcframework (si se utiliza) al Navegador de Archivos de tu proyecto Xcode. Selecciona la casilla de Copy items if needed y pulse Finish.

Tip

If using the Objective-C API within a Swift project, we recommend you include both Realm Swift and Realm Objective-C in your project. Within your Swift files, you can access the Swift API and all required wrappers. Using the RealmSwift API in mixed Swift/Objective-C projects is possible because the vast majority of RealmSwift types are directly aliased from their Objective-C counterparts.

Import the SDK

Agrega la siguiente línea en la parte superior de los archivos fuente para utilizar el SDK:

#include <Realm/Realm.h>

import RealmSwift

Tamaño del archivo de descarga de la aplicación

The SDK should only add around 5 to 8 MB to your app's download size. The releases we distribute are significantly larger because they include support for the iOS, watchOS and tvOS simulators, some debug symbols, and bitcode, all of which are stripped by the App Store automatically when apps are downloaded.

Solución de problemas

If you have build issues after using one of these methods to install the SDK, see our troubleshooting guidelines for information about resolving those issues.

Soporte del sistema operativo

Swift Concurrency Support

El SDK de Swift es compatible con las funciones de concurrencia del lenguaje Swift. Para conocer las prácticas recomendadas sobre el uso de las funciones de concurrencia del SDK de Swift, consulte la documentación a continuación.

Apple Privacy Manifest

Apple requiere que las aplicaciones que utilizan RealmSwift proporcionen un manifiesto de privacidad que contenga detalles sobre las prácticas de colección y uso de datos del SDK. El archivo de manifiesto incluido debe incluirse al enviar nuevas aplicaciones o actualizaciones de aplicaciones a la App Store. Para obtener más detalles sobre los requisitos de Apple, consulta Próximos requisitos para SDKs de terceros en el sitio web de Apple Developer.

Starting in Swift SDK version 10.46.0, the SDK ships with privacy manifests for Realm and RealmSwift. Each package contains its own privacy manifest with Apple's required API disclosures and the reasons for using those APIs.

Puedes ver los manifiestos de privacidad en cada paquete o en el repositorio de GitHub realm-swift:

• Realm: https://github.com/realm/realm-swift/blob/master/Realm/PrivacyInfo.xcprivacy

• RealmSwift: https://github.com/realm/realm-swift/blob/master/RealmSwift/PrivacyInfo.xcprivacy

To include these manifests in a build target that uses RealmSwift, you must build RealmSwift as a dynamic framework. For details, refer to the Swift Package Manager Installation instructions step (Optional) Build RealmSwift as a Dynamic Framework.

The Swift SDK does not include analytics code in builds for the App Store. The SDK does not log into Atlas on its own behalf.

Si escribes una aplicación que use cualquier función de App Services, como inicializar un cliente de App para:

• Call an Atlas Function

• Authenticate and manage users

• Consulta de MongoDB Atlas

• Open a synced database

Es posible que deba agregar declaraciones adicionales al manifiesto de privacidad de su aplicación detallando sus prácticas de colección y uso de datos al utilizar estas API.

For more information, refer to Apple's Privacy manifest files documentation.