カテゴリー別アーカイブ: iOS SDK

iOSアプリ開発を開始する前の準備作業

アピアリーズが提供するiOSアプリ開発向けSDKを利用した開発を始めるにあたり、
いくつかの事前準備作業が必要となります。

コントロールパネル側の準備作業

アピアリーズ・アカウントの準備

アピアリーズのアカウントを作成してください。

アプリの登録

予め、アピアリーズのコントロールパネルから、「アプリ」を作成してください。

アプリ開発環境側での準備作業

プロジェクトの作成

作成されるアプリの iOS プロジェクトを準備ください。

Appiaries SDK のダウンロード

以下ダウンロードページから Appiaries SDK (iOS) をダウンロードします。

» Appiaries SDK (iOS) のダウンロード

プロジェクトへ Appiaries SDK (iOS) を組み込む

ダウンロードしたSDKのZIPアーカイブを、開発PC上の任意ディレクトリに展開します。
以下に、Mac の ターミナル.app から Downloads フォルダにダウンロードしたアーカイブの展開例を示します。

AppiariesSDK を組み込むアプリのXcodeプロジェクトを開き、AppiariesSDK.framework をドラッグ&ドロップします。

figure 1

オプション選択画面が表示されるので、必要に応じて Copy items if needed オプションにチェックを入れ、[Finish] で追加を確定します。

figure 2

次に、依存ライブラリとして MobileCoreServices.frameworkQuartzCore.framework を追加します。

figure 3

次に、ビルド設定 (Build Settings) の Other Linker Flags-ObjC を追加します。

figure 4

ここまでの設定で AppiariesSDK の組み込みは完了しています。

最後に確認として、AppDelegate.m 内に AppiariesSDK を有効化するコードを記述してみてください。(下図参照)
コードの追記を行った後にビルド/実行し、コンソールに “activated ? YES” と出力されれば正常に組み込みできています。
うまく動作しない場合は ダウンロード ページからブランク・プロジェクトをダウンロードし、設定に差異がないか確認してみてください。

figure 5

以上で、アプリへのSDKの組み込みは完了です。
次節より、アプリ内でのSDKの利用方法について詳しく解説します。

関連情報

はじめに

Appiaries iOS SDK 2.0 開発者ガイド

このドキュメントについて

想定する読者について

本ドキュメントは、アピアリーズをバックエンドサーバとして使用する、iOSアプリ開発者向けの内容となっています。

SDKの利用にあたっての前提条件

以下に、Appiaries iOS SDK(以降、iOS SDK、または単に SDK と表記)を利用するにあたっての前提条件を示します。

  • アピアリーズのアカウントを作成済みであること
  • iOSアプリ開発について基本的な知識/理解を有すること
  • JSONフォーマットについて基本的な知識/理解を有すること
  • RESTアーキテクチャスタイルについて基本的な知識/理解を有すること

SDK がサポートする iOS バージョン一覧

iOS バージョン
iOS 7.0
iOS 7.1
iOS 8.0
iOS 8.1
iOS 8.2
iOS 8.3

SDKの利用にあたっての注意事項

依存ライブラリ/フレームワーク

SDK の利用には、以下に挙げるライブラリが必要となります。

フレームワーク名
MobileCoreServices.framework
QuartzCore.framework

Facebookとの連携を行う場合は、別途、以下に挙げるライブラリが必要となります。

ライブラリ名 バージョン 配布先リンク
FacebookSDK.framework 3.23.2 » 外部サイト Facebook SDK ダウンロードページへ移動します

関連情報

SDK 移行ガイド

v2.0.0 の新機能と変更点

新機能/変更点 説明
インタフェースの刷新 よりシンプルで直感的なインタフェースを採用しました。
オブジェクトマッピング v1.4.0までは、アピアリーズのAPIレスポンス(JSON形式)を自前クラスに格納しようとした場合、マッピング用のコードを自力で記述する必要がありましたが、v2.0.0以降はこの作業が不要となります。
v2.0.0以降では、組み込みクラス(ABDBObject, ABFile, ABUser, ABDevice, ABPushMessage, ABSequence)のオブジェクトとして、APIレスポンスが自動的に格納されるようになりました。
クラス継承のサポート 組み込みクラスを継承したモデルクラスを定義することで、アピアリーズの各種コレクションとアプリ内のモデルクラスを透過的に操作できるようになります。
データ型のサポート 組み込みクラスを継承したモデルクラスを定義することで、フィールド(@property)のデータ型定義に合わせてデータが格納されるようになります。
フィールドにはプリミティブ型以外に、NSString、NSDate、NSArray、NSDictionary、CGPoint、CGRectといった、各種組み込みクラス(および構造体)を指定することができます。
また、独自実装したクラスであっても、フィルタ用コードを記述することで、同様にフィールドとして指定することができます。
クエリ機能の強化 新たに追加されたクエリクラス(ABQuery)を利用することで、より直感的にクエリ条件を組み立てられるようになりました。
また、アピアリーズAPIに対して一部未対応であった検索条件式についても v2.0.0 よりサポートされるようになり、アピアリーズAPIが提供する機能をフルに利用できるようになりました。
その他の変更点 サポートOSバージョンの変更
    iOS 7.0 以降のバージョンがサポート対象となります。(iOS 6 のサポートは終了しました)
ベンダーPREFIXの変更
    クラス名の先頭に付与されているベンダーPREFIXが APIS から AB (Appiaries BaaS) に変更されました。
フレームワーク名の変更
    AppiariesFacebookKit.frameworkAppiariesFBKit.framework に変更されました。

対応表

機能
 
影響数
 
操作
 
v1.4.0
                          
v2.0.0
                          
v2.0.0
(Subclassing)
全般 有効化 code code
サブクラス登録 code
DB One 作成 code code code
更新 code code code
削除 code code code
取得 code code code
リフレッシュ code code
復帰 code code
Many 作成 (Objects) code code
更新 (Objects) code code
更新 (Query)
削除 (Objects) code code
削除 (Query) code code code
検索 (Query) code code code
ファイル One 作成 code code code
更新 code code code
削除 code code code
取得 code code code
取得 (バイナリ) code code code
リフレッシュ code code
復帰 code code
Many 作成 (Objects) code code
更新 (Objects) code code
更新 (Query)
削除 (Objects) code code
削除 (Query) code code
検索 (Query) code code code
シーケンス One インクリメント / デクリメント code code
取得 code code
ユーザ One サインアップ code code code
作成 code code
更新 code code code
削除 code code code
取得 code code code
リフレッシュ code code
復帰 code code
ログイン (ログインID+パスワード) code code code
ログイン (メールアドレス+パスワード) code code code
ログイン (匿名) code code
ログイン (Twitter) code code
ログイン (Facebook) code code
自動ログイン code code code
ログアウト code code code
本人確認メール送信要求 code code
パスワード再設定メール送信要求 code
Many 作成 (Objects)
更新 (Objects)
更新 (Query)
削除 (Objects)
削除 (Query)
検索 (Query)
デバイス One 登録 code code code
登録解除 code code code
作成
更新
削除
取得
リフレッシュ
復帰
Many 作成 (Objects)
更新 (Objects)
更新 (Query)
削除 (Objects)
削除 (Query)
検索 (Query)
プッシュ通知 One 受信・開封通知 code code code
リッチ・プッシュ code code
作成
更新
削除
取得
リフレッシュ
復帰
Many 作成 (Objects)
更新 (Objects)
更新 (Query)
削除 (Objects)
削除 (Query)
検索 (Query)
APPENDIX 独自実装のリッチ・プッシュ画面を利用する code code
ABQuery 例 code

全般

有効化

v1.4.0

v2.0.0

対応表へ戻る

サブクラスの登録

v2.0.0 (Subclassing)

対応表へ戻る

DB

DBデータを作成する

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを更新する

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを削除する

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを取得する

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータをリフレッシュする

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを変更前の状態に復帰する

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを作成する (Objects)

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを更新する (Objects)

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを更新する (Query)

対応表へ戻る

DBデータを削除する (Objects)

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを削除する (Query)

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

DBデータを検索する (Query)

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイル

ファイルを作成する

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルを更新する

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルを削除する

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルを取得する

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルのバイナリデータ(ファイル実体)をダウンロードする

v1.4.0

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルをリフレッシュする

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルを変更前の状態に復帰する

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルを作成する (Objects)

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルを更新する (Objects)

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルを更新する (Query)

対応表へ戻る

ファイルを削除する (Objects)

v2.0.0

v2.0.0 (Subclassing)

対応表へ戻る

ファイルを削除する (Query)

v2.0.0

v2.0.0 (Subclassing)