diff --git a/README-Localized/README-es-es.md b/README-Localized/README-es-es.md new file mode 100644 index 0000000..416fa95 --- /dev/null +++ b/README-Localized/README-es-es.md @@ -0,0 +1,164 @@ + +# SDK de Microsoft Graph para ObjC + + +¡Introducción al SDK de Microsoft Graph para ObjectiveC al integrarlo en sus aplicaciones para iOS y MacOS! + +## Instalación + + +### Usar CocoaPods + +Puede usar [CocoaPods](https://cocoapods.org/) para mantenerse actualizado con la versión más reciente. Incluya la siguiente línea en su podfile: + ``` + pod 'MSGraphClientSDK' + ``` + + +### Usar Carthage + + + +También puede optar por usar [Carthage](https://github.com/Carthage/Carthage) para administrar paquetes. + + + +1. Instale Carthage en su Mac con una descarga desde el sitio web o si usa el Homebrew `brew install carthage`. + +2. Debe crear un `Cartfile` que enumere la biblioteca MSGraphClientSDK para este proyecto en Github. + + + +``` + +github "microsoftgraph/msgraph-sdk-objc" "tags/" + +``` + + + +3. Ejecute `carthage update`. Esto recuperará las dependencias en una carpeta `Carthage/Checkouts` y después, compilará la biblioteca MSGraphClientSDK. + +4. En la pestaña de configuración "General" de destino de la aplicación, en la sección "Marcos y bibliotecas vinculadas", arrastre y coloque el `MSGraphClientSDK.framework` desde la carpeta `Carthage/Build` en el disco. + +5. En la pestaña de configuración "Fases de compilación" de destino de la aplicación, haga clic en el icono "+" y elija "Nueva fase de ejecución de script". Cree un Script de ejecución en el que especifique el shell (ej.: `/bin/sh`), agregue el siguiente contenido en el área de script debajo del shell: + + + +```sh + +/usr/local/bin/carthage copy-frameworks + +``` + + + +y agregue las rutas de acceso a los marcos que desea usar en "Archivos de entrada", por ejemplo: + + + +``` + +$(SRCROOT)/Carthage/Build/iOS/MSGraphClientSDK.framework + +``` + +Este script funciona alrededor de un [Error de envío de la App Store](http://www.openradar.me/radar?id=6409498411401216) desencadenado por archivos binarios universales y garantiza que los archivos relacionados con bitcode y los dSYMs necesarios se copien al archivar. + + + +Con la información de depuración copiada en el directorio de productos compilados, Xcode podrá resolver símbolos en el seguimiento de pila cuando se detenga en un punto de interrupción. Esto también le permite desplazarse por el código de terceros en el depurador. + + + +Al archivar la aplicación para enviarla a la App Store o TestFlight, Xcode también copiará estos archivos en el subdirectorio dSYMs del paquete `.xcarchive` de la aplicación. + + + +## Requisitos previos + +Se debe autenticar cada llamada de red a Microsoft Graph. Por ese motivo, la creación de una instancia de MSHTTPClient toma una instancia del protocolo de MSAuthenticationProvider como parámetro. + +Puede crear la instancia de MSAuthenticationProvider de dos maneras: + +### Usando [MSGraphMSALAuthProvider](https://github.com/microsoftgraph/msgraph-sdk-objc-auth) + +Este repositorio administra los escenarios de autenticación mediante [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-objc) + +### Escribiendo su propia implementación de MSAuthenticationProvider + +También puede elegir administrar la autenticación por cualquier otro medio que se adapte a sus necesidades. Debe seguir los siguientes pasos para que este SDK pueda interactuar con el mecanismo de autenticación. + +1. Luego de integrar el SDK, tendrá que proporcionar la implementación para MSAuthenticationProvider creando un archivo nuevo. + +2. En este archivo, escriba una implementación para el siguiente método de MSAuthenticationProvider + +``` + +- (void) getAccessTokenWithCompletion:(void (^)(NSString *accessToken, NSError *error))completion; + +``` + +Esta implementación debe poder comunicarse con el mecanismo de autenticación para obtener el token de acceso o cualquier error que se haya producido durante el proceso y devolverlo en el bloque de finalización. + +## Cómo se usa SDK + + + +Suponiendo que ha realizado los pasos anteriores, ahora tendrá: + + + +1. Un archivo .xcworkspace integrado con el pod de MSGraphClientSDK o un MSGraphClientSDK.framework integrado con el proyecto. + + + +2. Instancia de una clase que implementa el protocolo MSAuthenticationProvider. + + + +Luego de los pasos anteriores, debe seguir los siguientes pasos: + + + +1. Cree una instancia de MSHTTPClient desde MSClientFactory de la siguiente forma: + +``` + +MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider]; + +``` + +2. Configure un objeto de solicitud nativa que puede ser similar al que sigue: + +``` + +NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me"]]]; + +``` + +3. Cree un objeto MSURLSessionTask (para nuestro ejemplo un DataTask) con la ayuda de MSHTTPClient de la forma siguiente y llame a execute en él: + +``` + +MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest + +completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { + +// Hacer algo + +}]; + +[meDataTask execute]; + +``` + + + +Y eso es todo. Ahora ha llamado correctamente a un servidor Graph solicitando información sobre el usuario. + +## Recursos de uso + +* [Procesamiento por lotes](/Docs/Content/Batching.md) +* [Iterador de páginas](/Docs/Tasks/PageIterator.md) +* [Tarea de carga de archivos de gran tamaño](/Docs/Tasks/LargeFileUpload.md) diff --git a/README-Localized/README-fr-fr.md b/README-Localized/README-fr-fr.md new file mode 100644 index 0000000..25a0a95 --- /dev/null +++ b/README-Localized/README-fr-fr.md @@ -0,0 +1,164 @@ + +# Kit de développement logiciel Microsoft Graph pour ObjC + + +Commencez à utiliser le kit de développement logiciel (SDK) Microsoft Graph pour ObjectiveC en l’intégrant dans vos applications iOS et MacOS ! + +## Installation + + +### Utilisation de CocoaPods + +Vous pouvez utiliser [CocoaPods](https://cocoapods.org/) pour rester informé sur la dernière version. Incluez la ligne suivante dans votre podfile : + ``` + pod 'MSGraphClientSDK' + ``` + + +### Utilisation de Carthage + + + +Vous pouvez également choisir de recourir à [Carthage](https://github.com/Carthage/Carthage) pour la gestion des packages. + + + +1. Installez Carthage sur votre Mac à l’aide d’un téléchargement à partir de leur site web, ou si vous utilisez Homebrew `brew install Carthage`. + +2. Vous devez créer un `cartfile` qui répertorie la bibliothèque MSGraphClientSDK pour ce projet sur GitHub. + + + +``` + +github "microsoftgraph/msgraph-sdk-objc" "tags/" + +``` + + + +3. Exécutez la `mise à jour carthage`. Elle récupère les dépendances dans un dossier `Carthage/Checkouts`, puis génère la bibliothèque MSGraphClientSDK. + +4. Sous l’onglet de Paramètres « Général » de votre cible d'application, dans la section « Bibliothèques et infrastructures liées », faites glisser et déposez le `MSGraphClientSDK.framework` à partir du dossier `Carthage/Build` sur le disque. + +5. Dans l’onglet de Paramètres « Phases de Build » de la cible d'application, cliquez sur l’icône « + », puis sélectionnez « Nouvelle phase d'exécution du script ». Créez un Script d'exécution dans lequel vous spécifiez votre interpréteur de commandes (par exemple, `/bin/sh`), ajoutez le contenu suivant à la zone de script sous l’interpréteur : + + + +```sh + +/usr/local/bin/carthage copy-frameworks + +``` + + + +et ajoutez les chemins d’accès aux infrastructures que vous voulez utiliser sous « Fichiers d’entrée », par ex. : + + + +``` + +$(SRCROOT)/Carthage/Build/iOS/MSGraphClientSDK.framework + +``` + +Ce script se consacre au [bogue de soumission App Store,](http://www.openradar.me/radar?id=6409498411401216) déclenché par des fichiers binaires universels et vous permet de vous assurer que les fichiers liés au bitcode et les dSYMs nécessaires sont copiés lors de l’archivage. + + + +Une fois les informations de débogage copiées dans l’annuaire des produits built, Xcode pourra générer des symboles d'arborescence des appels de procédure chaque fois que vous vous arrêtez à un point d’arrêt. Cela vous permet également de parcourir le code tiers dans le débogueur. + + + +Lors de l’archivage de votre application à des fins de soumission vers l’App Store ou le TestFlight, Xcode copiera également ces fichiers dans le sous-répertoire dSYMs du groupe `.xcarchive` de l'application. + + + +## Conditions préalables + +Chaque appel réseau à Microsoft Graph doit être authentifié. À cet effet, la création d’une instance de MSHTTPClient prend l’instance d’un protocole MSAuthenticationProvider comme paramètre. + +Vous pouvez créer l’instance MSAuthenticationProvider à l’aide des deux méthodes suivantes : + +### Utilisation de [MSGraphMSALAuthProvider](https://github.com/microsoftgraph/msgraph-sdk-objc-auth) + +Ce repo gère les scénarios d’authentification via [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-objc) + +### En écrivant votre propre implémentation de MSAuthenticationProvider + +Vous pouvez également choisir de gérer l’authentification à l’aide de n’importe quel moyen répondant à vos besoins. Vous devez suivre les étapes ci-dessous pour que ce SDK puisse interagir avec votre mécanisme d’authentification. + +1. Une fois le kit de développement logiciel (SDK) intégré, vous devez fournir l’implémentation pour MSAuthenticationProvider en créant un nouveau fichier. + +2. Dans ce fichier, écrivez une implémentation pour la méthode MSAuthenticationProvider + +``` + +- (void) getAccessTokenWithCompletion:(void (^)(NSString *accessToken, NSError *error))completion; + +``` + +Cette implémentation doit être en mesure de parler à votre mécanisme d’authentification afin d’obtenir le jeton d’accès ou toute erreur qui s’est produite pendant le processus et de le renvoyer dans le bloc d’achèvement. + +## Utiliser le kit de développement logiciel + + + +En supposant que vous avez suivi les étapes ci-dessus, vous disposez désormais des éléments suivants : + + + +1. Fichier. xcworkspace intégré avec pod MSGraphClientSDK ou MSGraphClientSDK.framework intégré à votre projet. + + + +2. Instance d’une classe implémentant le protocole MSAuthenticationProvider. + + + +Une fois les étapes précédentes effectuées, vous devez suivre les étapes ci-dessous : + + + +1. Créez une instance de MSHTTPClient à partir de MSClientFactory en procédant de la manière suivante : + +``` + +MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider]; + +``` + +2. Configurez un objet de demande native qui peut ressembler à ceci : + +``` + +NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me"]]]; + +``` + +3. Créez une MSURLSessionTask (dans notre exemple, un DataTask) avec l’aide d’MSHTTPClient comme ci-dessous et appelez exécuter sur celle-ci : + +``` + +MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest + +completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { + +//Do something + +}]; + +[meDataTask execute]; + +``` + + + +Et voilà. Vous avez désormais créé un appel à Graph Server qui demande des informations sur l’utilisateur. + +## Ressources d’utilisation + +* [Traitement par lots](/Docs/Content/Batching.md) +* [Itérateur de page](/Docs/Tasks/PageIterator.md) +* [Tâche de chargement d’un fichier volumineux](/Docs/Tasks/LargeFileUpload.md) diff --git a/README-Localized/README-ja-jp.md b/README-Localized/README-ja-jp.md new file mode 100644 index 0000000..e2e85ed --- /dev/null +++ b/README-Localized/README-ja-jp.md @@ -0,0 +1,164 @@ + +# ObjC 用 Microsoft Graph SDK + + +ObjectiveC 向けの Microsoft Graph SDK を iOS および MacOS アプリケーションに統合して使用を開始しましょう ! + +## インストール + + +### CocoaPods を使う + +[CocoaPods](https://cocoapods.org/) を使用すれば、最新バージョンを使用して最新の状態に保つことができます。ポッドファイルに次の行を含めます: + ``` + pod 'MSGraphClientSDK' + ``` + + +### Carthage を使う + + + +パッケージ管理に [Carthage](https://github.com/Carthage/Carthage) を使用することもできます。 + + + +1. Mac に Carthage をインストールするには、Web サイトからダウンロードするか、Homebrew [ `brew install carthage` を使用します。 + +2. Github でこのプロジェクトの MSGraphClientSDK ライブラリを一覧表示する `Cartfile` を作成する必要があります。 + + + +``` + +github "microsoftgraph/msgraph-sdk-objc" "tags/" + +``` + + + +3. `carthage update` を実行します。このコマンドは依存性を取り出して `Carthage/Checkouts` フォルダーに入れ、MSGraphClientSDK ライブラリをビルドします。 + +4. アプリケーション ターゲットの [全般] 設定タブの [リンクされたフレームワークとライブラリ] セクションで、`MSGraphClientSDK.framework` をディスク上の `Carthage/Build` フォルダーからドラッグアンドドロップします。 + +5. アプリケーション ターゲットの [ビルド フェーズ] 設定タブで、[+] アイコンをクリックして [新規スクリプト実行フェーズ] を選択します。シェル (例: `/bin/sh`) を指定して実行スクリプトを作成し、シェルの下のスクリプト領域に次のコンテンツを追加します。 + + + +```sh + +/usr/local/bin/carthage copy-frameworks + +``` + + + +使用するフレームワークへのパスを “入力ファイル” の下に追加します。例: + + + +``` + +$(SRCROOT)/Carthage/Build/iOS/MSGraphClientSDK.framework + +``` + +このスクリプトは、ユニバーサル バイナリによってトリガーされる [App Store 提出バグ](http://www.openradar.me/radar?id=6409498411401216)を回避し、必要なビットコード関連ファイルおよび dSYM がアーカイブ時に確実にコピーされるようにします。 + + + +デバッグ情報が構築された製品ディレクトリにコピーされると、Xcode はブレークポイントで停止するたびにスタック トレースを記号化できます。これにより、デバッガーでサードパーティのコードをステップ実行することもできます。 + + + +App Store または TestFlight に提出するためにアプリケーションをアーカイブする場合、Xcode はこれらのファイルをアプリケーションの `.xcarchive` バンドルの dSYMs サブディレクトリにもコピーします。 + + + +## 前提条件 + +Microsoft Graph への各ネットワーク呼び出しは認証される必要があります。そのため、MSHTTPClient のインスタンスの作成は、MSAuthenticationProvider プロトコルのインスタンスをパラメーターとして受け取ります。 + +MSAuthenticationProvider インスタンスは、2 つの方法で作成できます。 + +### [MSGraphMSALAuthProvider](https://github.com/microsoftgraph/msgraph-sdk-objc-auth) を使用する + +このリポジトリは、[MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-objc) を介して認証シナリオを処理します + +### MSAlauthenticationProvider の独自の実装を記述する + +自身のニーズに合った手段で認証を処理することもできます。この SDK が認証メカニズムを操作できるように、以下の手順に従う必要があります。 + +1. SDK を統合した後、新しいファイルを作成して MSAlauthenticationProvider の実装を提供する必要があります。 + +2. このファイルに、MSAlauthenticationProvider の以下のメソッドの実装を記述します + +``` + +- (void) getAccessTokenWithCompletion:(void (^)(NSString *accessToken, NSError *error))completion; + +``` + +この実装は、アクセス トークンまたはプロセス中に発生したエラーを取得して完了ブロックで返すために、認証メカニズムと通信できる必要があります。 + +## SDK の使用方法 + + + +上記の手順を完了したと仮定すると、以下が揃っているはずです。 + + + +1. MSGraphClientSDK ポッドと統合された .xcworkspace ファイルまたはプロジェクトに統合された MSGraphClientSDK.framework。 + + + +2. MSAuthenticationProvider プロトコルを実装するクラスのインスタンス。 + + + +上記の手順の後に、次の手順を実行する必要があります。 + + + +1. 以下の方法で、MSClientFactory から MSHTTPClient のインスタンスを作成します。 + +``` + +MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider]; + +``` + +2. 以下のようなネイティブ要求オブジェクトを設定します。 + +``` + +NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me"]]]; + +``` + +3. MSHTTPClient の助けを借りて MSURLSessionTask (この例の場合は DataTask) オブジェクトを以下の方法で作成し、その上で execute を呼び出します。 + +``` + +MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest + +completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { + +//何かを実行します + +}]; + +[meDataTask execute]; + +``` + + + +これで完了です。これで、ユーザーに関する情報を要求するグラフ サーバーへの呼び出しが正常に行われました。 + +## 使用方法リソース + +* [バッチ処理](/Docs/Content/Batching.md) +* [ページの反復子](/Docs/Tasks/PageIterator.md) +* [大容量ファイルのアップロード タスク](/Docs/Tasks/LargeFileUpload.md) diff --git a/README-Localized/README-pt-br.md b/README-Localized/README-pt-br.md new file mode 100644 index 0000000..65919ed --- /dev/null +++ b/README-Localized/README-pt-br.md @@ -0,0 +1,164 @@ + +# SDK do Microsoft Graph para ObjC + + +Comece a usar o SDK do Microsoft Graph para ObjectiveC integrando-o aos seus aplicativos iOS e MacOS! + +## Instalação + + +### Usando o CocoaPods + +Você pode usar o [CocoaPods](https://cocoapods.org/) para se manter atualizado com a versão mais recente. Inclua a seguinte linha no seu podfile: + ``` + pod 'MSGraphClientSDK' + ``` + + +### Usando o Carthage + + + +Você também pode optar por usar o [Carthage](https://github.com/Carthage/Carthage) no gerenciamento de pacotes. + + + +1. Instale o Carthage no Mac baixando do site ou, se estiver usando o Homebrew, use `brew install carthage`. + +2. Você deve criar um `Cartfile` que lista a biblioteca MSGraphClientSDK desse projeto no Github. + + + +``` + +github "microsoftgraph/msgraph-sdk-objc" "tags/" + +``` + + + +3. Execute `carthage update`. Este comando busca dependências na pasta `Carthage/Checkouts` e cria a biblioteca MSGraphClientSDK. + +4. Na guia das configurações "Gerais" do destino do aplicativo, na seção "Estruturas e Bibliotecas Vinculadas", arraste e solte o `MSGraphClientSDK.framework` da pasta `Carthage/Build` no disco. + +5. Na guia de configurações "Fases do Build" do destino do aplicativo, clique no ícone "+" e escolha "Nova Fase de Script de Execução". Crie um Script de Execução no qual você especifica o shell (por exemplo, `/bin/sh`); adicione o seguinte conteúdo à área de script abaixo do shell: + + + +```sh + +/usr/local/bin/carthage copy-frameworks + +``` + + + +e adicione os caminhos para as estruturas que você deseja usar em "arquivos de entrada", como, por exemplo: + + + +``` + +$(SRCROOT)/Carthage/Build/iOS/MSGraphClientSDK.framework + +``` + +Este script funciona em torno de um [Bug de envio da App Store](http://www.openradar.me/radar?id=6409498411401216) acionado por binários universais e garante que os arquivos necessários relacionados a BitCode e dSYMs sejam copiados durante o arquivamento. + + + +Com as informações de depuração copiadas no diretório de produtos criados, o Xcode poderá simbolizar o rastreamento da pilha sempre que você parar em um ponto de interrupção. Isso também permitirá que você percorra o código de terceiros no depurador. + + + +Ao arquivar o aplicativo para envio para a App Store ou TestFlight, o Xcode também copia esses arquivos no subdiretório dSYMs do pacote `.xcarchive` do aplicativo. + + + +## Pré-requisitos + +Cada chamada de rede do Microsoft Graph deve ser autenticada. Para isso, a criação de uma instância de MSHTTPClient usa como parâmetro a instância do protocolo MSAuthenticationProvider. + +Você pode criar a instância MSAuthenticationProvider de duas maneiras: + +### Usando [MSGraphMSALAuthProvider](https://github.com/microsoftgraph/msgraph-sdk-objc-auth) + +Esse repositório lida com os cenários de autenticação por meio do [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-objc) + +### Escrevendo sua própria implementação do MSAuthenticationProvider + +Você também pode optar por lidar com a autenticação por qualquer meio que atenda às suas necessidades. É necessário seguir as etapas abaixo para que este SDK possa interagir com o mecanismo de autenticação. + +1. Após integrar o SDK, você precisará fornecer a implementação ao MSAuthenticationProvider criando um novo arquivo. + +2. Neste arquivo, escreva uma implementação para o método abaixo do MSAuthenticationProvider + +``` + +- (void) getAccessTokenWithCompletion:(void (^)(NSString *accessToken, NSError *error))completion; + +``` + +Essa implementação deve ser capaz de se comunicar com o mecanismo de autenticação para obter o token de acesso ou qualquer erro ocorrido durante o processo e devolvê-lo no bloco de conclusão. + +## Como usar o SDK + + + +Supondo que você passou pelas etapas acima, agora você terá: + + + +1. Um arquivo .xcworkspace integrado ao MSGraphClientSDK Pod ou o MSGraphClientSDK.framework integrado no seu projeto. + + + +2. Instância de uma classe implementando o protocolo MSAuthenticationProvider. + + + +Depois de realizar as etapas acima, você precisa fazer o seguinte: + + + +1. Crie uma instância de MSHTTPClient do MSClientFactory da seguinte maneira: + +``` + +MSHTTPClient *httpClient = [MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider]; + +``` + +2. Configure um objeto de solicitação nativo, que pode ser parecido com o seguinte: + +``` + +NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:[MSGraphBaseURL stringByAppendingString:@"/me"]]]; + +``` + +3. Crie um objeto MSURLSessionTask (no caso do nosso exemplo, uma DataTask) com a ajuda do MSHTTPClient da seguinte maneira e chame a execução dele: + +``` + +MSURLSessionDataTask *meDataTask = [httpClient dataTaskWithRequest:urlRequest + +completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { + +//Execute algo + +}]; + +[meDataTask execute]; + +``` + + + +Pronto. Você já fez uma chamada com êxito para o servidor de gráfico solicitando informações sobre o usuário. + +## Recursos de uso + +* [Envio em lote](/Docs/Content/Batching.md) +* [Iterador de página](/Docs/Tasks/PageIterator.md) +* [Tarefa de carregar arquivos grandes](/Docs/Tasks/LargeFileUpload.md) diff --git a/README-Localized/README-ru-ru.md b/README-Localized/README-ru-ru.md new file mode 100644 index 0000000..63eaaa1 --- /dev/null +++ b/README-Localized/README-ru-ru.md @@ -0,0 +1,164 @@ + +# Пакет SDK Microsoft Graph для ObjC + + +Чтобы начать работу с пакетом SDK Microsoft Graph для ObjectiveC, интегрируйте его в приложения iOS и MacOS! + +## Установка + + +### Использование CocoaPods + +Вы можете использовать [CocoaPods](https://cocoapods.org/), чтобы обеспечить актуальность установленной версии. Включите в свой профиль следующую строку: + ``` + pod 'MSGraphClientSDK' + ``` + + +### Использование Carthage + + + +Вы также можете использовать [Carthage](https://github.com/Carthage/Carthage) для управления пакетами. + + + +1. Чтобы установить Carthage на компьютере Mac, скачайте программу с официального веб-сайта, а если используется Homebrew, выполните команду `brew install carthage`. + +2. На сайте Github необходимо создать для этого проекта файл `Cartfile`, в котором указана библиотека MSGraphClientSDK. + + + +``` + +github "microsoftgraph/msgraph-sdk-objc" "tags/<тег\_новейшего\_выпуска>" + +``` + + + +3. Выполните команду `carthage update`. Эта команда извлечет зависимости в папку `Carthage/Checkouts`, а затем выполнит сборку библиотеки MSGraphClientSDK. + +4. На вкладке настроек "Общие" для целевого приложения найдите раздел "Связанные платформы и библиотеки" и перетащите файл `MSGraphClientSDK.framework` из папки `Carthage/Build` на диске. + +5. На вкладке настроек "Этапы сборки" для целевого приложения щелкните значок "+" и выберите "Новый этап сценария выполнения". Создайте сценарий запуска, в котором указана оболочка (пример: `/bin/sh`), и добавьте следующий текст в область сценария под оболочкой: + + + +```sh + +/usr/local/bin/carthage copy-frameworks + +``` + + + +Затем добавьте пути к платформам, которые требуется использовать, в раздел "Входные файлы", например: + + + +``` + +$(SRCROOT)/Carthage/Build/iOS/MSGraphClientSDK.framework + +``` + +Этот сценарий помогает избежать [ошибки отправки в App Store](http://www.openradar.me/radar?id=6409498411401216), которую вызывают универсальные двоичные файлы, и обеспечивает копирование необходимых файлов, связанных с Bitcode, и dSYM при архивации. + + + +После копирования отладочной информации в каталог собранных продуктов Xcode сможет выражать символами трассировку стека при достижении точек останова. Это также даст вам возможность пошагового выполнения стороннего кода в отладчике. + + + +При архивации приложения для отправки в App Store или TestFlight среда Xcode также скопирует эти файлы в подкаталог dSYMs пакета `.xcarchive` для вашего приложения. + + + +## Предварительные требования + +Каждый сетевой вызов к Microsoft Graph должен пройти проверку подлинности. Для этого при создании экземпляра MSHTTPClient в качестве параметра используется экземпляр протокола MSAuthenticationProvider. + +Вы можете создать экземпляр MSAuthenticationProvider двумя способами: + +### Использование [MSGraphMSALAuthProvider](https://github.com/microsoftgraph/msgraph-sdk-objc-auth) + +Этот репозиторий обрабатывает сценарии проверки подлинности с помощью [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-objc) + +### Создание собственной реализации MSAuthenticationProvider + +Вы также можете обрабатывать проверку подлинности любыми способами, подходящими вашим потребностям. Чтобы пакет SDK мог взаимодействовать с механизмом проверки подлинности, требуется выполнить действия, указанные ниже. + +1. После интеграции пакета SDK потребуется обеспечить реализацию для MSAuthenticationProvider, создав новый файл. + +2. В этом файле создайте реализацию для указанного ниже метода MSAuthenticationProvider + +``` + +- (void) getAccessTokenWithCompletion:(void (^)(NSString *accessToken, NSError *error))completion; + +``` + +Эта реализация должна поддерживать механизм проверки подлинности, чтобы получать маркер доступа или любые ошибки, возникающие в ходе процесса, и возвращать их в блок завершения. + +## Способ использования пакета SDK + + + +С учетом выполнения предыдущих действий у вас имеются следующие компоненты: + + + +1. Файл .xcworkspace, интегрированный с объектом pod MSGraphClientSDK или MSGraphClientSDK.framework, встроенным в ваш проект. + + + +2. Экземпляр класса, реализующего протокол MSAuthenticationProvider. + + + +После вышеуказанных действий требуется выполнить следующее: + + + +1. Создайте экземпляр MSHTTPClient из MSClientFactory указанным ниже образом: + +``` + +MSHTTPClient *httpClient = \[MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider]; + +``` + +2. Настройте собственный объект запроса, который может выглядеть примерно так: + +``` + +NSMutableURLRequest *urlRequest = \[NSMutableURLRequest requestWithURL:\[NSURL URLWithString:\[MSGraphBaseURL stringByAppendingString:@"/me"]]]; + +``` + +3. Создайте объект MSURLSessionTask (в нашем примере — DataTask) с помощью MSHTTPClient указанным ниже способом и вызовите для него команду исполнения: + +``` + +MSURLSessionDataTask *meDataTask = \[httpClient dataTaskWithRequest:urlRequest + +completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { + +//Какое-то действие + +}]; + +\[meDataTask execute]; + +``` + + + +Вот и все. Вы успешно выполнили вызов к серверу Graph с запросом сведений о пользователе. + +## Ресурсы по применению + +* [Пакетная обработка](/Docs/Content/Batching.md) +* [Итератор страниц](/Docs/Tasks/PageIterator.md) +* [Задача отправки больших файлов](/Docs/Tasks/LargeFileUpload.md) diff --git a/README-Localized/README-zh-cn.md b/README-Localized/README-zh-cn.md new file mode 100644 index 0000000..f56d761 --- /dev/null +++ b/README-Localized/README-zh-cn.md @@ -0,0 +1,164 @@ + +# 适用于 ObjC 的 Microsoft Graph SDK + + +通过集成至 iOS 和 MacOS 应用,开始使用 Microsoft Graph SDK for ObjectiveC。 + +## 安装 + + +### 使用 CocoaPods + +可使用 [CocoaPods](https://cocoapods.org/) 保持拥有最新版本的软件。在配置文件中包含下列行: + ``` + pod 'MSGraphClientSDK' + ``` + + +### 使用 Carthage + + + +还可以选择使用 [Carthage](https://github.com/Carthage/Carthage) 管理程序包。 + + + +1. 使用网站中的下载内容或使用 Homebrew `brew install carthage` 安装 Carthage 至 Mac。 + +2. 必须创建在 Github 上列出此项目 MSGraphClientSDK 库的 `Cartfile`。 + + + +``` + +github "microsoftgraph/msgraph-sdk-objc" "tags/" + +``` + + + +3. 运行 `carthage 更新`。此操作将依赖项提取到 `Carthage/Checkouts` 文件夹,然后生成 MSGraphClientSDK 库。 + +4. 在应用程序目标的“常规”设置选项卡的“关联框架和库”部分中,从 `Carthage/Build` 文件夹中拖放 `MSGraphClientSDK.framework` 至磁盘上。 + +5. 在应用程序目标的“构建阶段”设置选项卡上,单击“+”图标并选择“新建运行脚本阶段”。创建指定 Shell 的“运行脚本”(例如:`/bin/sh`),添加下列内容至 Shell 下方脚本区: + + + +```sh + +/usr/local/bin/carthage copy-frameworks + +``` + + + +并添加路径至希望在 “Input Files” 下使用的框架,如: + + + +``` + +$(SRCROOT)/Carthage/Build/iOS/MSGraphClientSDK.framework + +``` + +此脚本解决通用二进制文件触发的 [App Store 提交 bug](http://www.openradar.me/radar?id=6409498411401216),并保证存档时复制所需的位代码相关文件和 dSYMs。 + + + +调试信息复制至构建产品目录中时,无论何时在断点停止,都能同步堆栈跟踪。这将能够让你在调试程序中逐步完成第三方代码。 + + + +存档应用程序以提交至 App Store 或 TestFlight 时,Xcode 还将复制这些文件至 应用程序的 `.xcarchive` 捆绑包的 dSYMs 子目录中。 + + + +## 先决条件 + +每次对 Microsoft Graph 进行网络调用,需要进行身份验证。因此,创建 MSHTTPClient 实例需要使用 MSAuthenticationProvider 协议实例作为参数。 + +可通过两种方式创建 MSAuthenticationProvider 实例: + +### 使用[MSGraphMSALAuthProvider](https://github.com/microsoftgraph/msgraph-sdk-objc-auth) + +此存储库通过 [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-objc) 处理身份验证应用场景。 + +### 编写 MSAuthenticationProvider 实现时 + +还可选择通过适合自己需要的方式处理身份认证。需要执行下列步骤,使此 SDK 可与身份验证机制交互。 + +1. 集成 SDK 后,必须通过创建新文件来提供 MSAuthenticationProvider 实现。 + +2. 在此文件中,针对下列 MSAuthenticationProvider 方法编写实现。 + +``` + +- (void) getAccessTokenWithCompletion:(void (^)(NSString *accessToken, NSError *error))completion; + +``` + +此实现应能够与身份验证机制对话,以获取访问令牌或任何在过程期间出现的错误并返回至“completion block”中。 + +## 如何使用 SDK + + + +如果完成上述步骤,现在将拥有: + + + +1. 与 MSGraphClientSDK pod 集成的 .xcworkspace 文件或集成至项目中的 MSGraphClientSDK.framework。 + + + +2. 实现 MSAuthenticationProvider 协议的类实例。 + + + +完成上述步骤后,需要执行以下步骤: + + + +1. 按以下方式从 MSClientFactory 创建 MSHTTPClient 实例: + +``` + +MSHTTPClient *httpClient = \[MSClientFactory createHTTPClientWithAuthenticationProvider:authenticationProvider]; + +``` + +2. 配置本地请求对象,外观可能如下: + +``` + +NSMutableURLRequest *urlRequest = \[NSMutableURLRequest requestWithURL:\[NSURL URLWithString:\[MSGraphBaseURL stringByAppendingString:@"/me"]]]; + +``` + +3. 借助 MSHTTPClient 采用下列方式创建 MSURLSessionTask (在 DataTask 示例中)对象,并执行调用: + +``` + +MSURLSessionDataTask *meDataTask = \[httpClient dataTaskWithRequest:urlRequest + +completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { + +//做点什么 + +}]; + +\[meDataTask execute]; + +``` + + + +演示到此结束。现在你已成功调用 Graph 服务器,询问有关用户的信息。 + +## 使用资源 + +* [批处理](/Docs/Content/Batching.md) +* [页面迭代器](/Docs/Tasks/PageIterator.md) +* [大型文件上传任务](/Docs/Tasks/LargeFileUpload.md)