お試しアピアリーズ

appiary_1_0_1_js

お試しアピアリーズ appiary_1_0_1_jsは、 日本製BaaSである アピアリーズ(appiaries)用の JavaScript ライブラリです。 Appiaries API の"v1"バージョンを前提とします。 このライブラリを利用するためのリファレンス用に、以下 Appiary クラスのプロパティ、メソッドについて簡単に説明します。

Appiary

"appiary_1_0_1_js"では、名前空間(namespace)に”Appiary"を用います。”Appiary”は、クラスであり、”Appiary”オブジェクトのコンストラクタでもあります。

コンストラクタ Appiary

new 演算子により、”Appiary”インスタンス・オブジェクトを生成します。

var appiary = new Appiary(datastore,app_id,app_token,client_id,scope);

Appiary の引数

datastore
appiaries との契約で取得したデータストア(datastore)のID。体験版は、'_sandbox'。
app_id
アプリID。
app_token
アプリを登録した時に発行されるアクセストークン(access_token)。”app”で始まる半角英数字の文字列。
client_id
アプリの登録で OAuth登録も行ったときに発行されるクライアントID。OAuth登録を行わない場合、ユーザー認証を利用しない場合は不要。半角英数字の文字列。
scope
ログインユーザーの登録情報の取得範囲。OAuth登録を行わない場合、ユーザー認証を利用しない場合、ユーザー情報を取得しない場合は不要。(例)”nickname”

Appiary インスタンス

new 演算子により生成された”Appiary”インスタンス・オブジェクト appiary は次のプロパティ及びメソッドを有します。

プロパティ

datastore_url
データストア APIアクセス用URLの基礎部分。"https://api-datastore.appiaries.com/v1/"
oauth_url
OAuth APIアクセス用URL。スコープの指定がある場合はそのパラメータを付加。"https://api-oauth.appiaries.com/v1/auth?response_type=token&client_id=[client_id](&scope=[scope])"
app
アプリを特定するパスの一部"[datastore]/[app_id]"
profile_url
プロファイル APIアクセス用URL。"https://api-profiles.appiaries.com/v1/[datastore]/[app_id]"
app_token
引数 app_token で指定したアプリのアクセストークン(access_token)。
store_token
ユーザー認証時に設定される store_token。ユーザー認証がない場合は空文字列。アクセス制限のあるコレクションにアクセスする時に、access_token として設定するもの。Appiaries の認証ページからのリダイレクトに付加される文字列から取得する。
user_token
ユーザー認証時に設定される access_token。ユーザー認証がない場合は空文字列。プロファイルAPIにアクセスする時に、access_token として設定するもの。Appiaries の認証ページからのリダイレクトに付加される文字列から取得する。

メソッド

collection(collection_id,type)
アプリ内のコレクション(JSONデータ・ファイル)操作用のオブジェクト(collection オブジェクト)を返す。コレクションの種類がファイルの場合には、引数 type に”bin”を指定する。引数 type の指定がない場合には、JSONデータを示す"dat"が指定したものとみなされる。
getUser(settings)
ユーザー情報を取得する。利用にあたっては、ユーザー認証が前提となる。通常、settings には、{onload:callback}のようにユーザー情報取得時に実行するコールバック関数を指定する。

collection オブジェクト

Appiary のインスタンス appiary のメソッド collection(collection_id,type) により生成されるオブジェクト。生成時にインスタンス appiary のプロパティと同じプロパティが設定される。

collection.x(settings) メソッド

コレクションのデータ操作を行うためのメソッド。クラスメソッド Appiary.x()を内部利用し、サーバーとXMLHttpRequest を用いて通信します。

collection.x(settings)記述の概観

collection.x(settings)メソッドを利用する場合、およそ次のような流れになります。

var appiary = new Appiary(datastore,app_id,app_token,client_id,scope); var collection = appiary.collection(collection_id,type); var settings = { path : '-', method : 'GET' collection.callback : function(e){ var res = JSON.parse(e.target.responseText); var objs = res._objs; for(var i=0;i<objs.length;i++){ //取得したオブジェクトの処理 } } } collection.x(settings);

引数 settings のパラメータ

collection.x(settings)メソッドに引数 settings は、JavaScript のオブジェクト形式です。 与えるパラメータは、appiaries API の URL に付加するものと XMLhttpRequest の設定に使用するものの2種類に大別されます。

path
appiaries API の URL に付加する文字列。たとえば、JSONオブジェクトやファイルデータの検索には”/-(;検索条件;)”を指定する必要があります。 詳しくは、「JSONオブジェクトを検索する」、「バイナリオブジェクトを検索する(メタ情報部)」を参照。
async
同期通信する場合には、false を指定。指定がない場合、true の場合には、非同期通信となります。
data
送信するデータを JavaScript のオブジェクト形式で指定します。 method が"GET"の場合は、URLエンコードのうえクエリ文字列として URL に付加され、"POST"の場合には、JSONエンコードされたデータとして送信されます。
method
"POST"など送信メソッドを指定します。指定がない場合には”GET”とみなします。
requestHeader
appiaries のメソッドでは、Content-Type や X-Appiaries-Token をリクエストヘッダに設定する必要があるものがあります。その場合には、このパラメータで指定します。
onload
XMLHttpRequest のロードが完了した際に呼び出されるコールバック関数を指定します。 onload のほか、onerror など、XMLHttpRequest のイベントハンドラを指定することもできます。 詳しくは、XMLHttpRequest の解説を参考にして下さい。

Appiary.x(url,settings)

XMLHttpRequest 用のクラス・メソッド。collection オブジェクトのx(setings)メソッドや、Appiary インスタンスの getUser(settings) メソッドの内部で使用。 単独で使用してもよい。

Appiary.create()

DOM 操作用のメソッド。 コールバック関数内で取得したデータをページに表示する際に利用すると便利。

Appiary.create(tagName,attrs,parent,next)

tagName で指定したHTML要素を生成し、オブジェクト attrs で指定した属性を付加して返す。 parent で指定がある場合には、parent要素の子要素となる。next の指定がある場合には、next要素の前に挿入される。

tagName が、”text"の場合には、attrs を文字列で指定すると、テキストノードが生成される。

document.createElement または、document.createTextNode、setAttirbute、insertBefore、が組み合わさったもの。

Sample

"appiary_1_0_1_js"の使用例は、上記のページのソースで確認して下さい。