サンプルアプリ
最終更新日 2015-7-17

TODOアプリ

TODOアプリ

お知らせ

「TODOアプリ」は最新 Appiaries SDK v.2.0 リリースにともない、全面的に修正いたしました。
現在 github から入手いただけるソースコードの “master” ブランチが v.2.0 に対応していますが、
古い v.1.4.0 に対応するソースコードについても “v1_4_0″ ブランチから入手いただけます。
ただし Appiaries SDK v.1.4.0 は本年2015年9月にサポート終了を予定しますことを
ご留意いただきますようお願いいたします。

アプリ概要

ユーザはメールアドレスで新規会員登録し、登録時に登録したログイン名とパスワードでログインします。
またはTwitter/Facebookアカウントを利用してログインすることもできます。
ユーザはタスクを登録/編集/削除することができます。
アプリのメインビューには登録されているタスクが週表示されます。
各タスクをタップすることで詳細を管理することができます。

使用するアピアリーズの機能

プロジェクトファイル

Github よりプロジェクトファイルをダウンロード可能です。

Android Studio を利用する場合の注意点:

本アプリのソースは、Eclipse ADT プロジェクトとして公開されているため、Android Studio をお使いになる場合は同IDEの [Import project (Eclipse ADT, Gradle, etc.)] メニューからプロジェクトを変換する必要があります。プロジェクトの変換処理自体は自動実行されるため特に問題となるポイントはありませんが、変換後のビルド実行時に、「Duplicate files copied in APK <ファイル名>」といったエラーによりビルドに失敗する場合があります。このエラーが発生した場合は、ビルドスクリプト(todo/build.gradle)に packageOptions { exclude '<ファイル名>' } を追記する必要があります。
多くの場合、ダウンロードページ からダウンロードできる androidstudio-BlankApp-*.zip 内の app/build.gradle と同様のオプション指定をすることでエラーを解消することができますので、お困りの場合はご参考ください。

画面

トップ
新規会員
ログイン
SNS ログイン
SNS ログイン 2
登録
一覧
完了タスク
編集
日時編集
Delete

サーバサイドで利用されるコレクション

Entity System Name Type Description Note
会員 (User) コレクションは作成せず、会員管理機能を利用する アプリを利用する会員の情報を格納する。クライアントアプリ側から登録される。
タスク Tasks JSON Collection 全員のタスクを管理する。

会員 (User)

コレクションを作成しません。会員管理機能を利用します。

これは JSON オブジェクトコレクションでもファイルコレクションでもありません。
新規ユーザはアピアリーズの「会員機能」を利用して登録されます。
各会員データは、任意で JSON データを持つことも可能であり、
SNSログインの場合はここにSNSの個人属性情報を保存します。

会員のログインID認証 設定する
会員のメールアドレス認証 設定する
メールアドレスの登録 許可する
匿名認証 許可しない

会員は、クライアントアプリ側がアピアリーズの会員管理APIにリクエストすることにより、登録されます。
SNSログインの場合は、SNSから受け取った属性情報をここに登録します。

SNSログインを有効にするには、SNSのAPIキーを設定する必要があります。
Facebook連携を有効にする場合は API key を設定してください。
Twitter連携を有効にする場合は Consumer key および Consumer secret を設定してください。

“Tasks” コレクション

(JSON Collection)

全員のタスクが保存されます。

例:

Object ID: 890de318b94ecd71a5

上記の例で “a3701e6613c731c1f4″ は相応のイメージオブジェクトを参照しています。

Object ID: 0345122c672e356813

その他のサーバサイド設定

アプリID

アピアリーズにアプリ作成時、アプリIDには “todo” を指定して下さい。
これは次の [アプリ設定] でも説明されますが、サンプルアプリのコードで
アプリIDの定数として “todo” を設定しているためです。
ご希望のアプリIDがある場合はそれを指定して問題ありません。
もし変更する場合は、[アプリ設定] で説明されている設定ファイルにて
そのアプリIDに変更することを忘れないようにして下さい。

アプリ側設定

最新 SDK v.2.0 対応バージョン

Android (Android SDK v.2.0)

定数は以下の複数ファイルに定義されています:

res/values/strings.xml

一つひとつの定義をみていきます。

appiaries__datastore_id は「データストアID」です。
「アプリトークン」と同じように、アピアリーズのAPIにリクエストを送信するときは
必ず「データストアID」を指定する必要があります。
ダウンロードしたサンプルのコードには “appiaries_sample” が設定されています。
ご自身の契約されたデータストアIDを指定してください。
例えば sandbox 環境で開発する場合は “_sandbox” を設定します。

appiaries__application_id は「アプリID」です。
これはあなたのアプリを識別するためのものです。

appiaries__application_tokenは、アピアリーズと通信するときの認証に使われる「アプリトークン」です。
アピアリーズのAPIにリクエストを送信するときに、かならず必要なものです。
アピアリーズのデモ用のappiaries__application_tokenがデフォルトで指定されています。
(参考: “アプリトークンはどこにある?”)

facebook__app_idは、Facebook Developerで登録したアプリの API Key を指定します。

twitter__consumer_keyは、Twitter Developerで登録したアプリの Consumer Key を指定します。
twitter__consumer_secretは、Twitter Developerで登録したアプリの Consumer Secretを指定します。

iOS (iOS SDK v.2.0)

定数は以下の複数のファイルに定義されています:

Todo/Library/Configurations.h

一つひとつの定義をみていきます。

kApplicationIDは、アピアリーズと通信するときの認証に使われる「アプリトークン」です。
アピアリーズのAPIにリクエストを送信するときに、かならず必要なものです。
アピアリーズのデモ用のkApplicationIDがデフォルトで指定されています。
(参考: “アプリトークンはどこにある?”)

kDatastoreID は「データストアID」です。
「アプリトークン」と同じように、アピアリーズのAPIにリクエストを送信するときは
必ず「データストアID」を指定する必要があります。
ダウンロードしたサンプルのコードには “appiaries_sample” が設定されています。
ご自身の契約されたデータストアIDを指定してください。
例えば sandbox 環境で開発する場合は “_sandbox” を設定します。

kApplicationID は「アプリID」です。
これはあなたのアプリを識別するためのものです。

kTwitterConsumerKey は、Twitter Developerで登録したアプリの Consumer Key を指定します。

kTwitterConsumerSecret は、Twitter Developerで登録したアプリの Consumer Secretを指定します。

kFacebookAppIDKey は、Facebook Developerで登録したアプリの API Key を指定します。

kFacebookPermissions は、TodoアプリがFacebookに対して要求する権限リスト指定します。

kFacebookUrlSchemeSuffix は、Facebook Developerで登録したアプリの URL Scheme Suffix を指定します。

Todo/Todo-Info.plist

一つひとつの定義をみていきます。

CHBundleURLSchemesは、Facebook Developerで登録したアプリの API Key を指定します。
プレフィクスにfbを指定する必要がある点に注意してください。

FacebookAppIDは、Facebook Developerで登録したアプリの API Key を指定します。

FacebookDisplayNameは、Facebook Developerで登録したアプリの Display Name を指定します。

以前の SDK v.1.4.0 対応バージョン

Android (Android SDK v.1.4.0)

定数は以下の複数ファイルに定義されています:

com/appiaries/gallery/common/Constants.java

一つひとつの定義をみていきます。

APIS_APP_TOKENは、アピアリーズと通信するときの認証に使われる「アプリトークン」です。
アピアリーズのAPIにリクエストを送信するときに、かならず必要なものです。
アピアリーズのデモ用のAPIS_APP_TOKENがデフォルトで指定されています。
(参考: “アプリトークンはどこにある?”)

APIS_DATASTORE_ID は「データストアID」です。
「アプリトークン」と同じように、アピアリーズのAPIにリクエストを送信するときは
必ず「データストアID」を指定する必要があります。
ダウンロードしたサンプルのコードには “appiaries_sample” が設定されています。
ご自身の契約されたデータストアIDを指定してください。
例えば sandbox 環境で開発する場合は “_sandbox” を設定します。

APIS_APP_ID は「アプリID」です。
これはあなたのアプリを識別するためのものです。

res/values/strings.xml

一つひとつの定義をみていきます。

facebook_app_idは、Facebook Developerで登録したアプリの API Key を指定します。

twitter_consumer_keyは、Twitter Developerで登録したアプリの Consumer Key を指定します。
twitter_consumer_secretは、Twitter Developerで登録したアプリの Consumer Secretを指定します。

iOS (iOS SDK v.1.4.0)

定数は以下の複数のファイルに定義されています:

Todo/Library/TODOConfigurations.h

一つひとつの定義をみていきます。

TODOAPISAppTokenは、アピアリーズと通信するときの認証に使われる「アプリトークン」です。
アピアリーズのAPIにリクエストを送信するときに、かならず必要なものです。
アピアリーズのデモ用のTODOAPISAppTokenがデフォルトで指定されています。
(参考: “アプリトークンはどこにある?”)

TODOAPISDatastoreId は「データストアID」です。
「アプリトークン」と同じように、アピアリーズのAPIにリクエストを送信するときは
必ず「データストアID」を指定する必要があります。
ダウンロードしたサンプルのコードには “appiaries_sample” が設定されています。
ご自身の契約されたデータストアIDを指定してください。
例えば sandbox 環境で開発する場合は “_sandbox” を設定します。

TODOAPISAppId は「アプリID」です。
これはあなたのアプリを識別するためのものです。

Todo/Todo-Info.plist

一つひとつの定義をみていきます。

CHBundleURLSchemesは、Facebook Developerで登録したアプリの API Key を指定します。
プレフィクスにfbを指定する必要がある点に注意してください。

FacebookAppIDは、Facebook Developerで登録したアプリの API Key を指定します。

FacebookDisplayNameは、Facebook Developerで登録したアプリの Display Name を指定します。