* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* }
*
*/
export interface Callbacks {
success?(data: any): void;
error?(error: Error): void;
}
/**
* @description エラーログを出力する
* @private
*/
export declare const nbError: (message: string) => void;
/**
* @description ログを出力する
* @private
*/
export declare const nbLogger: (message: string) => void;
/**
* @description 引数エラー処理。
* callback があれば callback.error を呼び、なければ reject された Promise を返す。
* @param {Callbacks} callbacks コールバック
* @param {String} name API名
* @private
*/
export declare const _doBadRequestCallback: (callbacks: Callbacks, name: string) => Promise未指定の場合は、保持する全てのHTTP/2セッションをcloseする。 */ static closeHttp2Session(authority?: string): void; /** * HttpRequestExecutor のファクトリメソッド * @param {HttpRequest} req * @return {HttpRequestExecutor} */ static create(req: HttpRequest): HttpRequestExecutor; static setXhrFactory(factory: (req: HttpRequest) => HttpRequestExecutor): void; static setNodeFactory(factory: (req: HttpRequest) => HttpRequestExecutor): void; } export declare class HttpRequest implements ApiRequest { private _service; private _method; private _url; private _headers; private _contentType; private _responseType; private _queryParams; private _data; private _sessionToken; private _timeout; private _rawMessage; private _useHttp2; _resolve: any; _reject: any; private _receiveResponseHeaders; private _responseHeaders; private static _defaultTimeout; static _httpAgent: any; static _httpsAgent: any; static _httpsAgentOptions: _tls.SecureContextOptions; static _proxy: ProxyServer; static getProxy(): ProxyServer; static setProxy(proxy: ProxyServer): void; static setHttpAgent(agent: any): void; static setHttpsAgent(agent: any, options?: any): void; readonly service: any; /** * @description レスポンスヘッダ(Node.js のみ) * @name HttpRequest#responseHeaders * @type {Object} */ responseHeaders: object; /** * @memberOf HttpRequest * @description デフォルト通信タイムアウト値を設定する * @param {number} timeout タイムアウト値(ミリ秒) */ static setDefaultTimeout(timeout: number): void; /** * @memberOf HttpRequest * @description デフォルト通信タイムアウト値を取得する * @return {number} タイムアウト値(ミリ秒) */ static getDefaultTimeout(): number; /** * @description raw response message を返す場合に true をセットする (Node.js専用)。 *
true を指定すると、execute 成功時の応答は http.IncomingMessage となる。 *
HTTP/2を使用する場合、http2.ClientHttp2Streamとなる。 * @name HttpRequest#rawMessage * @type {boolean} */ rawMessage: boolean; /** * @memberOf HttpRequest * @description HTTP/2 を使用する場合にtrueをセットする。(Node.js専用)。 * @name HttpRequest#useHttp2 * @type {boolean} */ useHttp2: boolean; /** * @class HttpRequest * @classdesc HTTPリクエストクラス * @description コンストラクタ。 *
* ユーザがログイン中の場合、自動的に SessionToken が設定される。 * @param {NebulaService} service NebulaService * @param {string} path パス * @param {Object} option オプション。noprefix プロパティに true を設定すると、パスプレフィクス("/1/{tenantId}")を付与しない。 */ constructor(service: NebulaService, path: string, option?: JsonObject); /** * @memberOf HttpRequest * @description レスポンスヘッダ受信設定を行う。 *
* true に設定すると、execute 成功時の応答は * {body: ..., headers: {...}, status: statusCode} * 形式となる。 *
* ブラウザ(XHR)の場合は、headers は文字列(全ヘッダ連結したもの)、
* Node.js の場合は headers はヘッダ名をキーとした Object となる。
* @param {boolean} receive true の場合はレスポンスヘッダを受信する
* @return {HttpRequest} this
*/
setReceiveResponseHeaders(receive: boolean): HttpRequest;
/**
* @memberOf HttpRequest
* @description HTTP リクエストを実行する。
* X-Application-Id, X-Application-Key, X-Session-Token ヘッダは自動的に付与される。
* @return {Promise} Promise
*/
execute(): Promise
* 文字列を指定した場合は文字列がそのまま設定される。
* Objectを指定した場合は JSON 文字列に変換される。
* Blob および Buffer を指定した場合は、バイナリデータが設定される。
* @param {Object} data データ
* @return {HttpRequest} this
*/
setData(data: any): HttpRequest;
/**
* @memberOf HttpRequest
* @description SessionToken を設定する。
*
* 通常は本クラスのインスタンス生成時点で自動的に SessionToken は設定されている(ユーザログイン済みの場合)
* @param {string} sessionToken セッショントークン文字列
* @return {HttpRequest} this
*/
setSessionToken(sessionToken: string): HttpRequest;
/**
* @memberOf HttpRequest
* @description ResponseType を設定する。
* 指定できるタイプは以下のいずれかで、返却されるレスポンスの型が変化する。
* デフォルトは "text"。
* 注: 1つのヘッダに対して設定できる値は1つのみである。
* @param {string} header ヘッダ名
* @param {string} value 値
* @return {HttpRequest} this
*/
addRequestHeader(header: string, value: string): HttpRequest;
}
export declare const initHttpXhr: () => void;
/**
* XHR 実行クラス
* @private
*/
export declare class HttpXhr extends HttpRequestExecutor {
private _xhr;
private _receiveResponseHeaders;
constructor(req: HttpRequest);
setReturnRawMessage(rawMessage: boolean): void;
execute(method: string, url: string, headers: Headers, body: any, timeout: number, responseType: string, receiveResponseHeaders: boolean, useHttp2: boolean): void;
static closeHttp2Session(authority: string): void;
/**
* XHRを生成する
* @returns {XMLHttpRequest}
* @private
*/
_createXhr(): XMLHttpRequest;
/**
* XHR状態変更ハンドラ
* @returns {any}
* @private
*/
_onReadyStateChange(): any;
/**
* XHRタイムアウトハンドラ
* @private
*/
_onXhrTimeout(e: any): void;
}
import { ClientHttp2Session } from "http2";
export declare const initHttpNode: () => void;
/**
* Node.js 実行クラス
* @private
*/
export declare class HttpNode extends HttpRequestExecutor {
private static _http2Sessions;
private _responseType;
private _receiveResponseHeaders;
private _rawMessage;
constructor(req: HttpRequest);
setReturnRawMessage(returnRawMessage: boolean): void;
execute(method: string, urlString: string, headers: Headers, body: any, timeout: number, responseType: string, receiveResponseHeaders: boolean, useHttp2: boolean): void;
/**
* HTTP/2リクエストを送信する
* @param {module:url.Url} url URL
* @param {HttpRequestOptions} options ヘッダ等のオプション情報
* @param body リクエストボディ
* @private
*/
private _sendHttp2Request;
/**
* HTTP/1.1リクエストを送信する
* @param {module:url.Url} url URL
* @param {HttpRequestOptions} options ヘッダ等のオプション情報
* @param body リクエストボディ
* @private
*/
private _sendHttpRequest;
/**
* スキームが'https'であるか判定する
* @param {module:url.Url} url 判定対象のURL
* @returns {boolean} 'https'ならばtrue
* @private
*/
private static _isHttps;
/**
* HTTPレスポンス受信用のハンドラを設定する (Node.js用)
* @param {number} status ステータスコード
* @param res Stream(http.IncomingMessageなど)
* @private
*/
private _setResponseHandlers;
/**
* HTTP/2レスポンス受信用のハンドラを設定する (Node.js用)
* @param stream (http2.ClientHttp2Stream)
* @private
*/
private _setHttp2ResponseHandlers;
private _parseNodeResponse;
/**
* HTTP/2のsessionをcloseする(Node.js用)
* @param session http2.ClientHttp2Sessionだが、互換性維持のためanyを使用
* @param {function(): void} callback close完了後のコールバック
* @private
*/
private static _closeSession;
/**
* HTTP/2のstreamをcloseする(Node.js用)
* node versionによりcloseに使用するAPIが異なるため
* @param stream http2.ClientHttp2Streamだが、互換性維持のためanyを使用
* @private
*/
private static _closeStream;
/**
* HTTP/2セッションを全て返却する
* @returns {{index: string, module:http2.ClientHttp2Session}}
*/
static getHttp2Sessions(): {
[index: string]: ClientHttp2Session;
};
/**
* 指定したHTTP/2セッションを取得する
* @param {string} authority
* @returns {module:http2.ClientHttp2Session} session
*/
static getHttp2Session(authority: string): ClientHttp2Session;
/**
* HTTP/2セッションをキャッシュする
* @param {string} authority
* @param {module:http2.ClientHttp2Session} session
*/
static setHttp2Session(authority: string, session: ClientHttp2Session): void;
/**
* 指定したHTTP/2セッションをcloseする。
* @param {string} authority 未指定の場合は、保持するセッションを全てクローズする
*/
static closeHttp2Session(authority?: string): void;
}
/**
* @class SDEブリッジリクエストクラス
* @private
*/
export declare class _SdeRequest implements ApiRequest {
static _callbacks: {
[index: string]: Callbacks;
};
static _requestId: number;
_className: string;
_methodName: string;
_data: any;
constructor(className: string, methodName: string);
setData(data: any): any;
execute(): Promise
* ・ユーザを指定する場合
*
* ・ユーザを指定する場合
* option には必要に応じて以下の値を指定してもよい。(省略可能)
*
* 複数のインスタンスを指定できる
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static and(...clauses: Clause[]): Clause;
/**
* @memberOf Clause
* @description
* 複数の条件を OR条件で結合する
* @example
* var clause1 = Nebula.Clause.equals("name", "AAA");
* var clause2 = Nebula.Clause.lessThan("score", 50);
* var clause3 = Nebula.Clause.greaterThan("score", 30);
* var clause = Nebula.Clause.or(clause1, clause2, clause3);
* @param {Clause} clauses OR条件をとるNebula.Clauseインスタンス
* 複数のインスタンスを指定できる
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static or(...clauses: Clause[]): Clause;
/**
* @memberOf Clause
* @description Nebula.Clause インスタンスの配列からJSON値の配列を生成する
* @private
*/
static _convertClauseArray(clauseArray: Clause[]): AnyJson[];
}
export declare class ObjectQuery {
_clause: Clause;
_limit: number;
_skip: number;
_sort: string[];
_deleteMark: boolean;
_countQuery: boolean;
_projection: JsonObject;
/**
* @class ObjectQuery
* @classdesc オブジェクトクエリ
* @description オブジェクトクエリを生成する
* @example
* var query = new Nebula.ObjectQuery();
*/
constructor();
/**
* @function
* @memberOf ObjectQuery
* @description 設定されているClauseインスタンスを取得する
* @return {Clause} clause
*/
getClause(): Clause;
/**
* @function
* @memberOf ObjectQuery
* @description 設定されている検索上限数を取得する
* @return {number} 検索上限数
*/
getLimit(): number;
/**
* @function
* @memberOf ObjectQuery
* @description 設定されているスキップカウントを取得する
* @return {number} スキップカウント
*/
getSkipCount(): number;
/**
* @function
* @memberOf ObjectQuery
* @description 設定されているソート順序を取得する。
* ソート順序は以下のようなキー文字列の配列。降順の場合はキーの先頭が "-" となる。
*
* Deprecated である。{@link ObjectQuery#getSort} を使用すること。
*
* ソート順序は以下のように {キー名: 昇順フラグ} の配列。
* null を指定した場合は、すでに設定済みの検索条件をクリアする。
* 検索条件がすでに設定されていた場合、検索条件は上書きされる。
* デフォルトでは、null が設定されている。
* @return {ObjectQuery} this
*/
setClause(clause: Clause): ObjectQuery;
/**
* @memberOf ObjectQuery
* @description
* 検索上限数を設定する
* @example
* var clause = Nebula.Clause.lessThan("score", 50);
* var query = new Nebula.ObjectQuery()
* .setClause(clause)
* .setLimit(10);
* @param {number} limit 検索上限数。
*
* スキップカウントは検索結果の先頭からのスキップ数を表す。
* @example
* // この例では検索結果の5件目から10件を取得する。
* var clause = Nebula.Clause.lessThan("score", 50);
* var query = new Nebula.ObjectQuery()
* .setClause(clause)
* .setLimit(10)
* .setSkipCount(5);
* @param {number} skip スキップカウント
*
* skip は、0以上の値が設定可能である。
* 範囲外の値が設定された場合は、例外をスローする。
* デフォルトでは、0 が設定されている。
* @return {ObjectQuery} this
*/
setSkipCount(skip: number): ObjectQuery;
/**
* @function
* @memberOf ObjectQuery
* @description ソート順序を設定する。
* @example
* var query = new Nebula.ObjectQuery()
* .setSort(["key1", "-key2"]);
* @param {string[]} sort ソートキーの配列。
* 先に指定したものが高優先となる。
* それぞれデフォルトは昇順。降順の場合は先頭に "-" を付与する。
* @return {ObjectQuery} this
* @since 6.5.0
*/
setSort(sort: string[]): ObjectQuery;
/**
* @function
* @memberOf ObjectQuery
* @description ソート順序を設定する。
*
* 本メソッドはDeprecated である。{@link ObjectQuery#setSort} を使用すること。
*
* 複数のキーを設定する場合は、本メソッドを複数呼び出す。
* 先に設定したキーのほうが優先順位が高い。
*
* ソート順序をクリアするには {@link ObjectQuery#clearSortOrder} を使用する。
* @example
* // 以下の例では、score降順 -> name昇順で検索する
* var query = new Nebula.ObjectQuery()
* .setSortOrder("score", false)
* .setSortOrder("name", true);
* @param {string} key ソート対象のキー
* @param {boolean} isAsc 昇順でソートするかどうかを示す。昇順はtrue, 降順はfalse。
* @return {ObjectQuery} this
* @deprecated since 6.5.0
*/
setSortOrder(key: string, isAsc: boolean): ObjectQuery;
/**
* @function
* @memberOf ObjectQuery
* @description 設定したソート順序をクリアする。
* Deprecated である。{@link ObjectQuery#setSort} を使用すること。
* @example
* var clause = Nebula.Clause.lessThan("score", 50);
* var query = new Nebula.ObjectQuery()
* .setClause(clause)
* .setLimit(10)
* .setSkipCount(5)
* .setSortOrder("name", true);
* ....
* query.clearSortOrder("name");
* @param {string} key クリアするソート対象のキー。省略時は全キーをクリアする。
* @return {ObjectQuery} this
* @deprecated since 6.5.0
*/
clearSortOrder(key?: string): ObjectQuery;
/**
* @function
* @memberOf ObjectQuery
* @description
* クエリ件数取得フラグを設定する.
* null を指定した場合は、すでに設定済みの値をクリアする。
* 設定済み状態で、本メソッドを呼び出した場合は上書きされる。
* デフォルトでは、null が設定されている。
* @return {ObjectQuery} this
*/
setProjection(projectionJson: JsonObject): ObjectQuery;
}
export interface LoginInfo {
username?: string;
email?: string;
token?: string;
password?: string;
}
export interface UserJson {
_id?: string;
username?: string;
email?: string;
password?: string;
options?: JsonObject;
groups?: string[];
createdAt?: string;
updatedAt?: string;
lastLoginAt?: string;
etag?: string;
sessionToken?: string;
expire?: number;
clientCertUser?: boolean;
federated?: boolean;
token?: string;
primaryLinkedUserId?: string;
[index: string]: any;
}
export interface UserQuery {
_id?: string;
username?: string;
email?: string;
skip?: number;
limit?: number;
countQuery?: boolean;
}
/**
* User 基底クラス
* @private
*/
export declare class User implements UserJson {
_service: NebulaService;
private __id;
private _username;
private _email;
private _password;
private _options;
private _groups;
private _createdAt;
private _updatedAt;
private _lastLoginAt;
private _etag;
private _sessionToken;
private _expire;
private _clientCertUser;
private _federated;
private _primaryLinkedUserId;
[index: string]: any;
/**
* @class User
* @classdesc ユーザ管理 クラス
* @description ユーザオブジェクトを生成する。
*
* 生成しただけの状態では、まだサーバには登録されていない。ユーザ登録は {@link User#register} で実施する。
* @example
* var user = new Nebula.User();
* @return {Object} 新規ユーザオブジェクトのインスタンス
*/
constructor(service?: NebulaService);
/**
* ユーザID
* @type String
* @name User#_id
*/
_id: string;
/**
* ユーザ名
* @type String
* @name User#username
*/
username: string;
/**
* E-mail アドレス
* @type String
* @name User#email
*/
email: string;
/**
* パスワード
* @type String
* @name User#password
*/
password: string;
/**
* オプション (JSON)
* @type Object
* @name User#options
*/
options: JsonObject;
/**
* 所属グループ一覧 (read only)
* @type String[]
* @name User#groups
*/
groups: string[];
/**
* 作成日時
* @type String
* @name User#createdAt
*/
createdAt: string;
/**
* 更新日時
* @type String
* @name User#updatedAt
*/
updatedAt: string;
/**
* 最終ログイン日時
* @type String
* @name User#lastLoginAt
*/
lastLoginAt: string;
/**
* ETag
* @type String
* @name User#etag
*/
etag: string;
/**
* セッショントークン
* @type String
* @name User#sessionToken
*/
sessionToken: string;
/**
* セッショントークン有効期限(unix time [秒])
* @type String
* @name User#expire
*/
expire: number;
/**
* クライアント証明書認証ユーザの場合は true
* ・ユーザオブジェクトのプロパティを設定する。
* ・ユーザオブジェクトのプロパティを取得する。
* ユーザ登録に必要なユーザプロパティは、以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
*
* ・カレント（ログイン中）のユーザを取得する。
* 返り値に設定されるプロパティは以下のとおり。
*
* ・カレント（ログイン中）のユーザを強制設定する。
* userInfo の書式は以下の通りとする。
* 指定したプロパティだけが上書き設定される。
*
* ・カレント（ログイン中）のユーザを取得する。サーバへの問い合わせが発生する。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
*
* JSON 形式で指定する。省略した場合は全件検索となる。
* 検索用プロパティは以下の通り。
* 処理完了時に渡される値は以下の通り。
*
* user にnull は指定できない。
* 更新に必要なインスタンスのプロパティは、以下の通り。
*
* カレントユーザ以外を更新する場合は、SDK 初期化時のアプリケーションキーにアプリケーションのマスターキーを指定すること。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
*
* カレントユーザ以外を削除する場合は、SDK 初期化時のアプリケーションキーにアプリケーションのマスターキーを指定すること。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* @since v4.0.1
*/
static remove(user: User, callbacks?: Callbacks): Promise
* 本APIは Deprecated である。{@link User.remove}を使用すること。
* @deprecated since v4.0.1
*/
/**
* @method
* @memberOf User
* @description ユーザパスワードリセット
*
* ・ユーザパスワードのリセットを行う。
* ・ユーザに設定された OpenID Connect リンク情報を取得する。
* カレントユーザ以外のリンク情報を取得する場合は、SDK 初期化時のアプリケーションキーにアプリケーションのマスターキーを指定すること。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
*
* ・ユーザに設定された OpenID Connect リンク情報を削除する。
* カレントユーザ以外のリンク情報を削除する場合は、SDK 初期化時のアプリケーションキーにアプリケーションのマスターキーを指定すること。
* @param {string} linkedUserId 削除するリンクユーザID。
* ・オブジェクトを生成しただけでは、まだサーバにグループ登録されていない。グループ登録は、{@link Group#save} で実施する。
* ・グループオブジェクトのプロパティを設定する。
* ・グループオブジェクトのプロパティを取得する。
* ・登録するグループにユーザまたはグループを追加する。
* @param {Object} entry Nebula.User またはNebula.Group のインスタンス。
*
* entry は、グループに追加する Nebula.User または Nebula.Group のインスタンスを指定する。
* 各インスタンスには以下のプロパティが設定されていること。
*
* ・グループからユーザまたはグループを削除する。
* @param {Object} entry Nebula.User またはNebula.Group のインスタンス
*
* entry は、グループから削除する Nebula.User または Nebula.Group のインスタンスを指定する。
* 各インスタンスには以下のプロパティが設定されていること。
*
* ・グループを登録する。 処理完了時に渡される値は以下の通り。
*
* ・グループにユーザ・子グループを追加する。
* @param {string[]} userIds 追加するユーザIDの配列
* @param {string[]} groups 追加するグループ名の配列
* @param {Callbacks} callbacks 応答コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
*
* ・グループからにユーザ・子グループを削除する
* @param {string[]} userIds 削除するユーザIDの配列
* @param {string[]} groups 削除するグループ名の配列
* @param {Callbacks} callbacks 応答コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
*
* バケットモードには、以下のいずれかを指定する。
*
* バケットモードには、以下のいずれかを指定する。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
*
* 本メソッドを呼び出しただけでは、サーバに格納されているオブジェクトバケットは更新されない。
* サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* var acl = new Nebula.Acl();
* ....
* acl.addEntry(....);
* ....
* bucket.setAcl(acl);
* @param {Acl} acl Nebula.ACL のインスタンス
* @return {ObjectBucket} this
*/
setAcl(acl: Acl): ObjectBucket;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットのACLを取得する。
*
* オブジェクトバケットのACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある。
* @example
* var bucket = ....;
* ....
* var acl = bucket.getAcl();
* @return
* {Acl} オブジェクトバケットのACL
*/
getAcl(): Acl;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットのACLレスモード有効/無効を設定する。
* 本メソッドを呼び出さない場合、ACLレスモードはデフォルト無効。
* 本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* 本メソッドを呼び出しただけでは、サーバに格納されているオブジェクトバケットは更新されない。
* サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* var acl = new Nebula.Acl();
* ....
* acl.addEntry(....);
* ....
* bucket.setContentAcl(acl);
* @param {Acl} acl Nebula.ACL のインスタンス
* @return {ObjectBucket} this
*/
setContentAcl(acl: Acl): ObjectBucket;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットのコンテンツACLを取得する。
* オブジェクトバケットのコンテンツACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある。
* @example
* var bucket = ....;
* ....
* var acl = bucket.getAcl();
* @return {Acl} オブジェクトバケットのコンテンツACL
*/
getContentAcl(): Acl;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットに「説明文」を設定する。
*
* 本メソッドを呼び出しただけでは、サーバに格納されているオブジェクトバケットは更新されない。
* サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* ....
* bucket.setDescription("このバケットの説明文");
* @param {string} description オブジェクトバケットの「説明文」
*/
setDescription(description: string): void;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットの「説明文」を取得する。
*
* オブジェクトバケットの「説明文」を取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある。
* @example
* var bucket = ....;
* ....
* var description = bucket.getDescription();
* @return
* {string} オブジェクトバケットに設定されている「説明文」
*/
getDescription(): string;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケット名を取得する
* @example
* var bucket = ....;
* ....
* var bucketName = bucket.getBucketName();
* @return
* {string} オブジェクトバケット名
*/
getBucketName(): string;
/**
* @memberOf ObjectBucket
* @description バケット名をセットする
* @private
*/
_setBucketName(name: string): void;
/**
* @memberOf ObjectBucket
* @description
* バケットモードを取得する
* @example
* var bucket = ....;
* ....
* var bucketMode = bucket.getBucketMode();
* @return
* {number} バケットモード
*/
getBucketMode(): number;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットからオブジェクトを読み込む
* @example
* var bucket = ....;
* ....
* bucket.load("objectId")
* .then(function(object) {...})
* .catch(function(err) {...})
* @param {string} objectId オブジェクトID
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
*
* ETag値は、オブジェクトを新規保存した場合にサーバで追加され、
* オブジェクトを更新する度にサーバで変更される固有値である。
*
* ETag値は、オブジェクトの "etag"プロパティに格納される。
* etagを指定すると、サーバに保存されているオブジェクトのETag値と照合される。
*
* 一致しなかった場合は、データ衝突として「409 Conflict」エラーとなり、オブジェクトは削除されない。
* etagを指定しなかった場合、または、nullを指定した場合は、ETag値は照合されずオブジェクトは無条件で削除される。
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
*
* 本APIは Deprecated である。{@link ObjectBucket#remove} を使用すること。
* @deprecated since v4.0.1
*/
delete(objectId: string, callbacks?: Callbacks, etag?: string): Promise
* オブジェクトに "_id" フィールドが含まれる場合は更新、含まれない場合は挿入処理となる。
*
* オブジェクトにETag値が含まれる場合、サーバに保存されているオブジェクトのETag値と照合される。
* 一致しなかった場合は、データ衝突として「409 Conflict」エラーとなり、オブジェクトは更新されない。
*
* ETag値は、オブジェクトを新規保存した場合にサーバで追加され、
* オブジェクトを更新する度にサーバで変更される固有値である。
* ETag値は、オブジェクトの "etag"プロパティに格納される。
* オブジェクトの新規保存の場合は、etagがないため必ず保存される。
*
* すでに存在するオブジェクトを保存する場合、オブジェクトに指定したフィールドのみが更新される。
* 指定しないフィールドは更新されない(フィールドは削除されずそのまま残る)
* @example
* var bucket = ....;
* ....
* var myObj = {....};
* ....
* bucket.save(myObj)
* .then(function(object) {...})
* .catch(function(err) {...});
* @param {Object} object 保存するオブジェクト
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
*
* ETag値は、オブジェクトを新規保存した場合にサーバで追加され、
* オブジェクトを更新する度にサーバで変更される固有値である。
* ETag値は、オブジェクトの "etag"プロパティに格納される。
* @example
* var bucket = ....;
* ....
* var myObj = {....};
* ....
* bucket.insert(myObj)
* .then(function(object) {...})
* .catch(function(err) {...});
* @param {Object} object 保存するオブジェクト
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
*
* 複数のアイテムに対して $sort を実行する場合は、以下のように単一アイテムの $sort を複数連結すること。
* $sort に複数のアイテムを記載した場合は、ソート順序が保証されない。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* policy は、以下のいずれかの衝突解決ポリシを指定する。
* listener には、各同期イベント発生時のコールバックを指定する。
*
* 処理の進捗はsetSyncEventListener()で指定されたコールバックにて通知する。
* 各バケットごとにsetSyncScope()を使用して同期範囲を設定すること。
* 同期範囲が設定されていないバケットは、同期されない。
* @example
* Nebula.ObjectBucket.sync()
* .then(function() {...})
* .catch(function(err) {...});
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
* 同期イベントはPromise完了時ではなく、setSyncEventListener()で指定されたコールバックにて通知する点に注意。
*/
static sync(callbacks?: Callbacks): Promise
* 特定のオブジェクトバケットに対し同期を行う。処理の進捗はsetSyncEventListener()で指定されたコールバックにて通知する。
*
* setSyncScope()を使用して同期範囲を設定すること。同期範囲を設定しない場合、エラーとなり同期されない。
* 本APIは、バケットモードがレプリカモードのバケットに対して呼び出すこと。
* @example
* var bucket = new Nebula.ObjectBucket(....);
* ....
* bucket.syncBucket()
* .then(function() {...})
* .catch(function(err) {...});
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
* 同期イベントはPromise完了時ではなく、setSyncEventListener()で指定されたコールバックにて通知する点に注意。
*/
syncBucket(callbacks?: Callbacks): Promise 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
*
* 応答フォーマットは REST API リファレンスを参照のこと。
* 'results'プロパティに結果が格納される。
* これに加え、'failedCount'プロパティに処理失敗したリクエストの数が格納される。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* ファイルバケットのACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある
* @example
* var bucket = ....;
* ....
* var acl = bucket.getAcl();
* @return
* {Acl} ファイルバケットのACL
*/
getAcl(): Acl;
/**
* @memberOf FileBucket
* @description
* ファイルバケットのACLレスモード有効/無効を設定する。
* 本メソッドを呼び出さない場合、ACLレスモードはデフォルト無効。
* 本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* 本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* ファイルバケットのコンテンツACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある
* @example
* var bucket = ....;
* ....
* var acl = bucket.getAcl();
* @return
* {Acl} ファイルバケットのコンテンツACL
*/
getContentAcl(): Acl;
/**
* @memberOf FileBucket
* @description
* ファイルバケットに「説明文」を設定する.
* 本メソッドを呼び出しただけでは、サーバに格納されているファイルバケットは更新されない。
* ファイルバケットのコンテンツACLを取得するには、loadBucket()を使用してサーバのバケット情報をロードしておく必要がある
* @example
* var bucket = ....;
* ....
* var description = bucket.getDescription();
* @return
* {String} ファイルバケットの「説明文」
*/
getDescription(): string;
/**
* @memberOf FileBucket
* @description
* ファイルバケット名を取得する
* @example
* var bucket = ....;
* ....
* var bucketName = bucket.getBucketName();
* @return
* {String} ファイルバケット名
*/
getBucketName(): string;
/**
* @memberOf FileBucket
* @description ファイルバケット名を設定する
* @private
*/
_setBucketName(name: string): FileBucket;
private _save;
/**
* @memberOf FileBucket
* @description
* ファイルバケットへファイルを新規保存する.
* HTML5 File APIに対応しているブラウザ、もしくは Node.js のみで実行可能。
* @example
* var bucket = ....;
* ....
* var file = ....;
* ....
* var meta = new Nebula.FileMetadata();
* meta.setContentType("image/jpeg");
* bucket.saveAs("MyFileName.jpg", file, meta)
* .then(function(metadata) {...})
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットへ保存するファイル名
* @param {Object} data 文字列、File/Blobオブジェクト、または Buffer オブジェクト。
* サーバに保存するファイルのデータを以下のいずれかで指定する。
* 指定できるメタデータは以下の通りである。(他のメタデータは参照されない)
* 処理完了時に渡される値は以下の通り。
* HTML5 File APIに対応しているブラウザ、または Node.js のみで実行可能。
* @example
* var bucket = ....;
* ....
* var file = ....;
* ....
* bucket.save("MyFileName.jpg", file)
* .then(function(metadata) {...})
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットへ保存するファイル名
* @param {Object} data 文字列、File/Blobオブジェクト、または Buffer オブジェクト
* サーバに保存するファイルのデータを以下のいずれかで指定する。
* 処理完了時に渡される値は以下の通り。
* HTML5 File APIに対応しているブラウザ、または Node.js のみで実行可能。
* @example
* var bucket = ....;
* ....
* bucket.load("MyFile.jpg")
* .then(function(blob) {...})
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットから読み込むファイルの名前
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
* Node.js のみで実行可能。
* @param {String} fileName ファイルバケットから読み込むファイルの名前
* @param {Object} options ファイル取得のパラメータ(オプション)。
* JSONで指定する。各フィールドの説明は以下の通り。
* ファイルをRaw messageとして読み込む場合にtrueを設定する。(オプション)
* trueの場合、extraResponseは無効となる。原則として応答の取得にはPromiseを使用すること。
*
* HTTP/1.1において、処理が成功した場合、Promise には http.IncomingMessage が返される。
* http.IncomingMessage に対するイベントハンドラを自身で設定、適切にハンドリングすること。
* データ読み込み時は http.IncomingMessage よりレスポンスのステータスを取得、判定を行うこと。
*
* リクエスト送信が失敗した場合、Promise には error が返される。
*
* HTTP/2において、処理が成功した場合、Promise には http2.ClientHttp2Stream が返される。
* ClientHttp2Stream に対するイベントハンドラを自身で設定、適切にハンドリングすること。
* HTTP/2のステータスコードを取得するには、'response'イベントの':status'を参照する。
* 具体的な指定方法はexamplesを参照。
*
* レスポンスにステータスコード、ヘッダを追加する。(オプション) 通常レスポンスにはBuffer オブジェクトを返却するが、
* extraResponseをtrueに設定した場合、以下のプロパティが設定されたJSONを返却する。 If-Matchヘッダを付与する場合に指定(オプション)
* 値はファイルのETagを使用する。
* サーバのファイルが更新されている場合、エラーを返却する。
*
* If-Rangeヘッダを付与する場合に指定 (オプション)
* 値はファイルのETagを使用する。
* rangeStart/rangeEndを指定しない場合は無効である。
* ETag不一致の場合、rangeStart/rangeEndをは参照せず更新済みの新しいファイルを取得する。
* ifRange より ifMatchを優先して評価する。ファイルが更新されている場合でもファイル取得を行うには、ifRangeのみを指定すること。
*
* 取得するファイルの開始位置(オプション)
*
* ファイルの終了位置(オプション)
* rangeStartと組み合わせて、"0〜(ファイルサイズ-1)"の範囲で指定を行う。
* rangeEndのみ指定した場合は、末尾の取得バイト数を表す。
* rangeStart/rangeEndの値をベースにRangeヘッダを付与する。
* 不正な範囲の場合、サーバでファイルのサイズに合わせて値を変更する場合がある。
* メタデータからファイルサイズを検証し、ifMatch、ifRangeと組み合わせて使用することを推奨する。
* 具体的な指定方法はexamplesを参照。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 本APIは Deprecated である。remove() を使用すること。
* @deprecated since v4.0.1
*/
delete(fileName: string, callbacks?: Callbacks): Promise 既に公開されたファイルを再公開しても公開 URL は変更されない。
* @example
* var bucket = ....;
* ....
* bucket.publish("MyFile.jpg")
* .then(function(metadata) {...})
* .catch(function(err) {...});
* @param {String} fileName 公開するファイルの名前
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 処理完了時に渡される値は以下の通り。
* 本APIはオフライン(SDE4SD)のみで利用可能
* @example
* Nebula.FileBucket.selectUploadFile()
* .then(function(fileInfo) {...})
* .catch(function(err) {...});
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
* 本APIはオフライン(SDE4SD)のみで利用可能
* @example
* Nebula.FileBucket.selectDirectory()
* .then(function(dir) {...})
* .catch(function(err) {...});
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
* 本APIはオフライン(SDE4SD)のみで利用可能
* @example
* var bucket = ....;
* Nebula.FileBucket.selectUploadFile()
* .then(function(fileInfo) {
* var meta = new Nebula.FileMetadata();
* meta.setContentType(fileInfo.type);
* meta.setCacheDisabled(false);
*
* var callbacks = {
* success: function(metadata) {....},
* error: function(err) {....}
* };
* bucket.uploadNewFile(fileInfo.name, fileInfo.path, meta, callbacks);
* })
* .catch(function(err) {....});
* @param {String} fileName ファイルバケットへ保存するファイル名
* @param {String} filePath 保存する元ファイルの絶対パス(ファイル名含む)
* @param {FileMetadata} metadata 保存するファイルのメタデータ
* 処理完了時に渡される値は以下の通り。
* 本APIはオフライン(SDE4SD)のみで利用可能
* @example
* var bucket = ....;
* Nebula.FileBucket.selectUploadFile()
* .then(success: function(fileInfo) {
* var meta = new Nebula.FileMetadata();
* meta.setContentType(fileInfo.type);
* meta.setCacheDisabled(false);
*
* var callbacks = {
* success: function(metadata) {....},
* error: function(err) {....}
* };
* bucket.uploadUpdateFile(fileInfo.name, fileInfo.path, meta, callbacks);
* })
* .catch(function(err) {....});
* @param {String} fileName ファイルバケットへ保存するファイル名
* @param {String} filePath 保存する元ファイルの絶対パス(ファイル名含む)
* @param {FileMetadata} metadata 保存するファイルのメタデータ。
* 処理完了時に渡される値は以下の通り。
* 本APIはオフライン(SDE4SD)のみで利用可能
* @example
* var bucket = ....;
* ....
* bucket.download("MyFile.jpg", "/sdcard/MyFile.jpg")
* .then(function(fileName) {...})
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットからダウンロードするファイルの名前
* @param {String} filePath ダウンロードするファイルの保存先(ファイル名を含む絶対パス)
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
* 本APIはキャンセル要求を受け付けるだけであり、キャンセルされたことを保障するものではない。
* 本APIはオフラインのみで利用可能
* @example
* var bucket = ....;
* ....
* bucket.download("MyFile.jpg", "/sdcard/MyFile.jpg")
* .then(function(fileName) {...});
* .catch(function(err) {...});
* ....
* bucket.requestCancel(fileName)
* .then(function(fileName) {...});
* .catch(function(err) {...});
* @param {String} fileName ファイルバケットからダウンロードするファイルの名前
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* 処理完了時に渡される値は以下の通り。
*
* true に設定すると、execute 成功時の応答は
* {body: ..., headers: {...}, status: statusCode}
* 形式となる。
*
* ブラウザ(XHR)の場合は、headers は文字列(全ヘッダ連結したもの)、
* Node.js の場合は headers はヘッダ名をキーとした Object となる。
* @param receive true の場合はレスポンスヘッダを受信する
*/
setReceiveResponseHeaders(receive: boolean): CustomApi;
/**
* @memberOf CustomApi
* @description カスタムAPIの呼び出し
* @param {Object} data API呼び出しデータ
* 処理完了時に渡される値は以下の通り。
* HTTP/1.1において、処理が成功した場合、Promise には http.IncomingMessage が返される。
* http.IncomingMessage に対するイベントハンドラを自身で設定、適切にハンドリングすること。
* データ読み込み時は http.IncomingMessage よりレスポンスのステータスを取得、判定を行うこと。
* リクエスト送信が失敗した場合、Promise には error が返される。
* HTTP/2において、処理が成功した場合、Promise には http2.ClientHttp2Stream が返される。
* ClientHttp2Stream に対するイベントハンドラを自身で設定、適切にハンドリングすること。
* HTTP/2のステータスコードを取得するには、'response'イベントの':status'を参照する。
* @example
* var customApi = ....;
*
* // for HTTP/1.1
* // pipe()を使用する場合
* var writable = fs.createWriteStream(....);
* customApi.executeRaw()
* .then((message) => {
* message.pipe(writable);
* });
*
* // 'data'を実装する場合
* customApi.executeRaw()
* .then((message) => {
* message.on('data', () => {....});
* message.on('end', () => {....});
* message.on('error', () => {....});
* message.on('close', () => {....});
* });
*
* // for HTTP/2
* var statusCode;
* customApi.executeRaw()
* .then((message) => {
* message.on('response', (headers, flags) => { statusCode = headers[':status'] });
* message.on('data', () => {....});
* message.on('end', () => {....});
* message.on('error', () => {....});
* message.on('close', () => {....});
* });
* @param {Object} data API呼び出しデータ
* @return {Promise} Promise
* @since 7.5.0
*/
executeRaw(data: object): Promise 処理完了時に渡される値は以下の通り。
*
* NebulaService インスタンスを生成する。生成したインスタンス毎に異なるテナント/アプリに接続できる。
* {@link Nebula} はデフォルトの NebulaService インスタンスである。
* @example
* var service2 = new Nebula.NebulaService();
*/
export declare class NebulaService {
_config: NebulaConfig;
[index: string]: any;
User: typeof User;
Group: typeof Group;
ObjectBucket: typeof ObjectBucket;
FileBucket: typeof FileBucket;
CustomApi: typeof CustomApi;
PushSender: typeof PushSender;
Acl: typeof Acl;
HttpRequest: typeof HttpRequest;
NebulaService: typeof NebulaService;
AclPermission: typeof AclPermission;
AclGroup: typeof AclGroup;
RegexOption: typeof RegexOption;
Clause: typeof Clause;
ObjectQuery: typeof ObjectQuery;
FileMetadata: typeof FileMetadata;
_SdeRequest: typeof _SdeRequest;
_SdeNetworkEventListener: typeof _SdeNetworkEventListener;
_SdeSyncEventListener: typeof _SdeSyncEventListener;
BatchRequest: typeof BatchRequest;
AccountLink: typeof AccountLink;
_localStorage: any;
/**
* @memberOf NebulaService
* @description バケットモード - オンラインモード
* @const
*/
BUCKET_MODE_ONLINE: number;
/**
* @memberOf NebulaService
* @description バケットモード - レプリカモード
* @const
*/
BUCKET_MODE_REPLICA: number;
/**
* @memberOf NebulaService
* @description バケットモード - ローカルモード
* @const
*/
BUCKET_MODE_LOCAL: number;
/** @private */
constructor();
/**
* @description REST API のバージョン番号を返す
* @private
*/
getRestApiVersion(): number;
/**
* @memberOf NebulaService
* @description テナントIDを取得する
* @return {string} テナントID
*/
getTenantID(): string;
/**
* @memberOf NebulaService
* @description エンドポイントURLを取得する
* @return {string} エンドポイントURL
*/
getBaseUri(): string;
/**
* @memberOf NebulaService
* @description アプリケーションIDを取得する
* @return {string} アプリケーションID
*/
getAppID(): string;
/**
* @memberOf NebulaService
* @description アプリケーションキーを取得する
* @return {string} アプリケーションキー
*/
getAppKey(): string;
/**
* @memberOf NebulaService
* @description アプリケーションキーを変更する
* @param {string} key アプリケーションキー
* @return {NebulaService} this
*/
setAppKey(key: string): NebulaService;
/**
* @memberOf NebulaService
* @description サービスIDを返す
* @return {string} サービスID
*/
getServiceID(): string;
/**
* @memberOf NebulaService
* @description ログ出力レベルを返す
* @private
*/
getDebugMode(): string;
/**
* @memberOf NebulaService
* @description オフライン機能の有効または無効を返す
* @private
*/
isOffline(): boolean;
/**
* @memberOf NebulaService
* @description 自己署名証明書の有効または無効を返す
* SDE for SmartDevice、Node.js使用時(https Proxy未使用)の場合のみ有効
* @private
*/
isAllowSelfSignedCert(): boolean;
/**
* @memberOf NebulaService
* @description クライアント証明書の設定を行う (Node.js使用時のみ有効)。
*
* https Proxyを使用する場合、本設定は無効である。NebulaService#setHttpsProxy()のoptionsに証明書の設定を行うこと。
* @param {Object} certInfo 証明書情報
* pfxとpassphrase(またはkeyとcert),ca を指定する。
* pfxとcert/keyを同時に指定した場合の動作は保証しない。
* nullを指定した場合は証明書の設定を解除する。
* @example
* // p12(pfx)形式のクライアント証明書(証明書/秘密鍵)を指定、p12ファイルのパスフレーズを指定
* // 信頼するCA証明書として、2件を指定する場合
* service.setClientCertificate({
* pfx: fs.readFileSync('clientCertificate.p12'),
* passphrase: 'password',
* ca: [fs.readFileSync('caCert1.pem'), fs.readFileSync('caCert2.pem')]
* });
*
* // pem形式のクライアント証明、キーを使用。CA証明書を1件指定
* service.setClientCertificate({
* cert: fs.readFileSync('clientCert.pem'),
* key: fs.readFileSync('clientKey.pem'),
* ca: fs.readFileSync('caCert1.pem')
* });
* @return {NebulaService} this
*/
setClientCertificate(certInfo: ClientCertOptions): NebulaService;
/**
* @memberOf NebulaService
* @description client証明書の設定が有効または無効を返す(Node.js使用時のみ有効)。
*
* https Proxyを使用する場合、本設定は無効である。
* @returns {boolean} 証明書設定済みならばtrue
*/
isClientCertSet(): boolean;
/**
* @memberOf NebulaService
* @description カレントユーザのログイン情報を返す。
* 未ログイン、またはセッショントークンが有効期限切れの場合は null を返す。
* @returns {Object} ユーザ情報。_id, username, email, sessionToken, expire, options, groups フィールドが含まれる。
*/
getCurrentUser(): UserJson;
/**
* @memberOf NebulaService
* @description カレントユーザのログイン情報をセットする。
* ブラウザでは local storage に永続化され、NebulaService 間で共有される。
* Node.js では NebulaService 内(メモリ)に個別に保持される。
* @param user {User} ユーザ
* @return {NebulaService} this
*/
setCurrentUser(user: User): NebulaService;
/**
* @memberOf NebulaService
* @description セッショントークンをセットする。セッショントークンの有効期限は無期限扱い。
* ユーザがログイン済みの場合は、セッショントークンのみが変更される。
* 未ログインの場合は、ダミーユーザが保存される (セッショントークン以外のフィールドは空)。
* ブラウザでは local storage に永続化され、NebulaService 間で共有される。
* Node.js では NebulaService 内(メモリ)に個別に保持される。
* @param {string} sessionToken セッショントークン
* @return {NebulaService} this
*/
setSessionToken(sessionToken: string): NebulaService;
/**
* @memberOf NebulaService
* @description カレントユーザのログイン情報を破棄する
* @return {NebulaService} this
*/
removeCurrentUser(): NebulaService;
_userItemKey(): string;
/**
* @memberOf NebulaService
* @description HTTP/2の有効/無効を返却する (Node.js使用時のみ有効)
* ・MBaaS JavaScript SDK（以降、SDKと称す）を初期化する。 初期化パラメータをJSON 形式で指定する。JSONプロパティは以下の通り。
* テナント毎に割り当てられるユニークなID
* アプリケーション毎に割り当てられるユニークなID
* アプリケーション毎に割り当てられる秘密キー
* MBaaS REST API のエンドポイントURL
* オフライン機能の指定。
* オフライン機能を利用する場合はtrue を指定する。
* 自己署名証明書の使用を認める指定。
* オフラインモード使用時(SDE for SmartDevice使用時)、
* 及びNode.js使用時(Https Proxy未使用時)のみ有効。
* (Node.jsでHttps Proxy使用時は、NebulaService#setHttpsProxy()を参照して設定を行うこと)
* SSL接続に自己署名証明書を使用しているMBaaSサーバを
* 利用する場合はtrue を指定する。
* NebulaService毎に割り当てられるユニークなID
* マルチテナント機能を使用して複数のNebulaService(インスタンス)を生成する場合等に使用。
* 本IDはログイン情報キャッシュ時のKey情報に利用される。
* ログ出力レベル。
* "release", "debug" のいずれかを指定
* HTTP/2使用設定
* Node.js使用時(v8.4.0以降)のみ有効。
* 通信にHTTP/2を利用する場合はtrueを指定する。
*
* ・オフライン用ログインキャッシュ有効期限を設定する。
* @param {number} expire ログインキャッシュ有効期限（秒）
* ログインキャッシュ有効期限を指定する。
* デフォルトは、「259200秒（72時間）」である。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise
* ・オフライン用ログインキャッシュ有効期限を取得する。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise 処理完了時に渡される値は以下の通り。
*
* ・ネットワークの接続状態変更イベントを受け取るリスナーを設定する。
* @param {Object} listener ネットワークイベントリスナ
*
* 注: 本設定はグローバル設定である(NebulaService毎ではない)
* @param {Object} proxy プロキシ設定。host, port を指定する。
* @example
* Nebula.setHttpProxy({ host: 'proxysv.example.com', port: 8080});
*/
setHttpProxy(proxy: ProxyServer): void;
/**
* @memberOf NebulaService
* @description HTTPS プロキシを設定する (Node.js専用)。
*
* 注: 本設定はグローバル設定である(NebulaService毎ではない)
* @param {Object} proxy プロキシ設定。host, port を指定する。
* @param {Object} options https.request() に引き渡すオプション(省略可)。
*
* クライアント証明書認証に使用する証明書の設定などを行う。
* 使用方法はExampleを参照のこと。
* @example
* // https Proxyを指定する
* Nebula.setHttpsProxy({ host: 'proxysv.example.com', port: 8080});
*
* // p12(pfx)形式のクライアント証明書(証明書/秘密鍵)を指定、p12ファイルのパスフレーズを指定
* // 信頼するCA証明書として、2件を指定する場合
* Nebula.setHttpsProxy({ host: 'proxysv.example.com', port: 8080},
* {
* pfx: fs.readFileSync('clientCertificate.p12'),
* passphrase: 'password',
* ca: [fs.readFileSync('caCert1.pem'), fs.readFileSync('caCert2.pem')]
* });
*
* // pem形式のクライアント証明、キーを使用。CA証明書を1件指定
* Nebula.setHttpsProxy({ host: 'proxysv.example.com', port: 8080},
* {
* cert: fs.readFileSync('clientCert.pem'),
* key: fs.readFileSync('clientKey.pem'),
* ca: fs.readFileSync('caCert1.pem')
* });
*
* // 自己署名証明書を使用しているサーバへの接続を許可する
* Nebula.setHttpsProxy({ host: 'proxysv.example.com', port: 8080},
* {
* rejectUnauthorized: false
* });
*/
setHttpsProxy(proxy: ProxyServer, options?: JsonObject): void;
private static verifyProxy;
}
/**
* @namespace Nebula
* @description Nebula 名前空間。実体は {@link NebulaService} のデフォルトインスタンスである。
*/
export declare const Nebula: NebulaService;
*
* @param {string} responseType レスポンスタイプ
* @return {HttpRequest} this
*/
setResponseType(responseType: string): HttpRequest;
/**
* @memberOf HttpRequest
* @description リクエストヘッダを設定する。
*
以下のいずれかの値を指定する。
*
*
* @param {Object} entry ユーザまたはグループ情報
* 以下のいずれかを指定する。
*
*
*
* ・グループを指定する場合
*
*
* @return {Boolean} 正常追加した場合 true、 パラメータが不正の場合 false を返す
*/
addEntry(permission: string, entry: string | User | Group): boolean;
/**
* @method
* @memberOf Acl
* @description
* 対象権限からにユーザIDまたはグループ名を削除する
* @example
* var acl = new Nebula.Acl();
* var user = new Nebula.User();
* var group = new Group("MyGroup");
* ....
* acl.removeEntry(Nebula.Acl.READ, user);
* acl.removeEntry(Nebula.Acl.WRITE, "USER_01");
* acl.removeEntry(Nebula.Acl.CREATE, group);
* acl.removeEntry(Nebula.Acl.UPDATE, "g:GROUP_A");
* acl.removeEntry(Nebula.Acl.DELETE, Nebula.Acl.AUTHENTICATED);
* @param {String} permission エントリを削除する対象権限
*
(例) グループ名が GROUP_A の場合、 g:GROUP_A
*
以下のいずれかの値を指定する。
*
*
* @param {Object} entry ユーザまたはグループ情報。
* 以下のいずれかを指定する。
*
*
*
* ・グループを指定する場合
*
*
*/
removeEntry(permission: string, entry: string | User | Group): boolean;
/**
* @method
* @memberOf Acl
* @description 所有者のユーザIDを設定する
* @private
*/
_setOwner(owner: string): void;
/**
* @method
* @memberOf Acl
* @description
* 所有者のユーザIDを取得する
* @example
* var acl = ....;
* ....
* var userId = acl.getOwner();
* @return
* {String} ユーザIDの文字列を返す。所有者がない場合は、null を返す。
*/
getOwner(): string;
/**
* @method
* @memberOf Acl
* @description
* 対象権限のユーザIDおよびグループ名のエントリ一覧を取得する
* @example
* var acl = ....;
*
* var entries = acl.getEntries(permission);
* for (var i = 0; i < entries.length; i++) {
* entry = entries[i];
* ....;
* }
* @param {String} permission 取得するエントリ一覧の対象権限
*
(例) グループ名が GROUP_A の場合、 g:GROUP_A
*
以下のいずれかの値を指定する。
*
*
* @return {Object} ユーザIDまたはグループ名の文字列の配列を返す。
* エントリがない場合は、空配列を返す。
*
グループ名には、g: が先頭に付加されている。
*/
getEntries(permission: string): string[];
/**
* @method
* @memberOf Acl
* @description ACLのJSONオブジェクトを直接設定する
* @private
*/
_set(acl: AclJson): void;
/**
* @method
* @memberOf Acl
* @description 指定のエントリが含まれているかどうか
* @private
*/
_hasEntry(permission: string, target: string): boolean;
/**
* @method
* @memberOf Acl
* @description ACLのJSONオブジェクトを文字列に変換する
* @private
*/
_toString(keyName?: string): string;
/**
* @method
* @memberOf Acl
* @description ACLのJSONオブジェクトを返す
* @param keyName "ACL", "contentACL" のいずれかを指定すると、そのキーに ACL が格納される
* @private
*/
_toJsonObject(keyName?: string): JsonObject;
}
export declare const RegexOption: {
CASE_INSENSITIVITY: string;
};
export interface ClauseJson extends JsonObject {
[index: string]: AnyJson;
}
/**
* @class Clause
* @classdesc オブジェクト検索条件 クラス
* @description Clause インスタンスを生成する
* @example
* var clause = new Nebula.Clause();
*/
export declare class Clause {
_clause: ClauseJson;
/** @private */
constructor(clause?: ClauseJson);
/**
* @memberOf Clause
* @description 条件のパラメータをセットする
* @private
*/
_setParams(key: string, operator: string, value: AnyJson, options?: AnyJson): Clause;
/**
* @memberOf Clause
* @description JSONで表現された条件式を取得する
* @return {Object} JSON条件式
*/
json(): ClauseJson;
/**
* @method
* @name Clause.equals
* @description
* (key == value) の条件を示す Nebula.Clause インスタンスを生成する
* @example
* var clause = Nebula.Clause.equals("score", 80);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static equals(key: string, value: AnyJson): Clause;
/**
* @method
* @name Clause#equals
* @description
* (key == value) の条件を追加する
* @example
* var clause = new Nebula.Clause().equals("score", 80);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} this
*/
equals(key: string, value: AnyJson): Clause;
/**
* @memberOf Clause
* @description
* (key != value) の条件を示す Nebula.Clause インスタンスを生成する
* @example
* var clause = Nebula.Clause.notEquals("name", "apple");
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static notEquals(key: string, value: AnyJson): Clause;
/**
* @memberOf Clause
* @description
* (key != value) の条件を追加する
* @example
* var clause = new Nebula.Clause().notEquals("name", "apple");
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} this
*/
notEquals(key: string, value: AnyJson): Clause;
/**
* @memberOf Clause
* @description
* (key < value) の条件を示す Nebula.Clause インスタンスを生成する
* @example
* var clause = Nebula.Clause.lessThan("score", 30);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static lessThan(key: string, value: number): Clause;
/**
* @memberOf Clause
* @description
* (key < value) の条件を追加する
* @example
* var clause = new Nebula.Clause().lessThan("score", 30);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} this
*/
lessThan(key: string, value: number): Clause;
/**
* @memberOf Clause
* @description
* (key <= value) の条件を示す Nebula.Clause インスタンスを生成する
* @example
* var clause = Nebula.Clause.lessThanOrEqual("score", 30);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static lessThanOrEqual(key: string, value: number): Clause;
/**
* @memberOf Clause
* @description
* (key <= value) の条件を追加する
* @example
* var clause = new Nebula.Clause().lessThanOrEqual("score", 30);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} this
*/
lessThanOrEqual(key: string, value: number): Clause;
/**
* @memberOf Clause
* @description
* (key > value) の条件を示す Nebula.Clause インスタンスを生成する
* @example
* var clause = Nebula.Clause.greaterThan("number", 1000);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static greaterThan(key: string, value: number): Clause;
/**
* @memberOf Clause
* @description
* (key > value) の条件を追加する
* @example
* var clause = new Nebula.Clause().greaterThan("number", 1000);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} this
*/
greaterThan(key: string, value: number): Clause;
/**
* @memberOf Clause
* @description
* (key >= value) の条件を示す Nebula.Clause インスタンスを生成する
* @example
* var clause = Nebula.Clause.greaterThanOrEqual("number", 1000);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static greaterThanOrEqual(key: string, value: number): Clause;
/**
* @memberOf Clause
* @description
* (key >= value) の条件を追加すうｒ
* @example
* var clause = Nebula.Clause.greaterThanOrEqual("number", 1000);
* @param {String} key 比較するキー名
* @param {Object} value 比較する値
* @return {Clause} this
*/
greaterThanOrEqual(key: string, value: number): Clause;
/**
* @memberOf Clause
* @description
* key の値が values で指定された中に存在するかの条件を示す Nebula.Clause インスタンスを生成する
* @name Clause.in
* @function
* @example
* var targets = [1000, 1003, 1005];
* var clause = Nebula.Clause.in("number", targets);
* @param {String} key 比較するキー名
* @param {Object} values 比較する値の配列
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static in(key: string, values: AnyJson[]): Clause;
/**
* @memberOf Clause
* @description
* key の値が values で指定された中に存在するかの条件を追加する
* @name Clause#in
* @function
* @example
* var targets = [1000, 1003, 1005];
* var clause = new Nebula.Clause().in("number", targets);
* @param {String} key 比較するキー名
* @param {Object} values 比較する値の配列
* @return {Clause} this
*/
in(key: string, values: AnyJson[]): Clause;
/**
* @memberOf Clause
* @description
* key の値が values で指定されたすべてを含んでいるかの条件を示す Nebula.Clause インスタンスを生成する
* @example
* var targets = ["ssl", "security"];
* var clause = Nebula.Clause.all("tags", targets);
* @param {String} key 比較するキー名
* @param {Object} values 比較する値の配列
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static all(key: string, values: AnyJson[]): Clause;
/**
* @memberOf Clause
* @description
* key の値が values で指定されたすべてを含んでいるかの条件を追加する
* @example
* var targets = ["ssl", "security"];
* var clause = new Nebula.Clause().all("tags", targets);
* @param {String} key 比較するキー名
* @param {Object} values 比較する値の配列
* @return {Clause} this
*/
all(key: string, values: AnyJson[]): Clause;
/**
* @memberOf Clause
* @description
* key で示したフィールドが存在するかどうかを示す Nebula.Clause インスタンスを生成する
* @example
* var clause = Nebula.Clause.exist("tags", targets);
* @param {String} key 比較するキー名
* @param {Boolean} value 存在を確認する場合は true、 存在しないことを確認する場合は false を指定する。
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static exist(key: string, value: boolean): Clause;
/**
* @memberOf Clause
* @description
* key で示したフィールドが存在するかどうかの条件を追加する
* @example
* var clause = new Nebula.Clause().exist("tags", targets);
* @param {String} key 比較するキー名
* @param {Boolean} value 存在を確認する場合は true、 存在しないことを確認する場合は false を指定する。
* @return {Clause} this
*/
exist(key: string, value: boolean): Clause;
/**
* @memberOf Clause
* @description
* 正規表現による検索条件を示す Nebula.Clause インスタンスを生成する
* @example
* var clause = Nebula.Clause.regex("name", "abc*");
* @param {String} key 比較するキー名
* @param {String} expression Perl互換の正規表現の条件文字列
* @param {Object} option オプション
*
*
* @return {Clause} Nebula.Clause インスタンスを返す。
*/
static regex(key: string, expression: string, option?: string): Clause;
/**
* @memberOf Clause
* @description
* 正規表現による検索条件を追加する
* @example
* var clause = new Nebula.Clause().regex("name", "abc*");
* @param {String} key 比較するキー名
* @param {String} expression Perl互換の正規表現の条件文字列
* @param {Object} option オプション
* option には必要に応じて以下の値を指定してもよい。(省略可能)
*
* @return {Clause} this
*/
regex(key: string, expression: string, option?: string): Clause;
/**
* @memberOf Clause
* @description
* Nebula.Clause インスタンスの key の条件を反転させる
* @example
* var clause = Nebula.Clause.exist("tags", targets);
* clause.not("tags");
* @param {String} key 比較するキー名
* @return {Clause} Nebula.Clause インスタンス(this)を返す。
*/
not(key: string): Clause;
/**
* @memberOf Clause
* @description
* 複数の条件を AND条件で結合する
* @example
* var clause1 = Nebula.Clause.equals("name", "AAA");
* var clause2 = Nebula.Clause.lessThan("score", 50);
* var clause3 = Nebula.Clause.greaterThan("score", 30);
* var clause = Nebula.Clause.and(clause1, clause2, clause3);
* @param {Clause} clauses AND条件をとるNebula.Clauseインスタンス
*
* ["key1", "-key2"]
*
* @return {string[]}
* @since 6.5.0
*/
getSort(): string[];
/**
* @function
* @memberOf ObjectQuery
* @description 設定されているソート順序を取得する。
*
* [{"key1": true}, {"key2": false}]
*
* @return {array} ソート順序
* @deprecated since 6.5.0
*/
getSortOrder(): Array<{
[index: string]: boolean;
}>;
/**
* @function
* @memberOf ObjectQuery
* @description deleteフラグを取得する
* @private
*/
_getDeleteMark(): boolean;
/**
* @function
* @memberOf ObjectQuery
* @description 設定されているプロジェクションを取得する
* @return {Object} プロジェクション
*/
getProjection(): JsonObject;
/**
* @function
* @memberOf ObjectQuery
* @description deleteフラグをセットする
* @private
*/
_setDeleteMark(mark: boolean): void;
/**
* @function
* @memberOf ObjectQuery
* @description 内部データをクエリパラメータ Object に変換する
* @private
*/
_toParam(): any;
/**
* @function
* @memberOf ObjectQuery
* @description 内部データを JSON Object に変換する
* @private
*/
_toParamJson(): any;
/**
* @function
* @memberOf ObjectQuery
* @description QUERY情報(JSON)をNebula.ObjectQueryインスタンスに変換する
* @private
*/
static _toObjectQuery(queryJson: any): ObjectQuery;
/**
* @function
* @memberOf ObjectQuery
* @description NebulaObjectQueryインスタンスを比較する
* @private
*/
_equals(that: ObjectQuery): boolean;
/**
* @memberOf ObjectQuery
* @description
* 検索条件を設定する
* @example
* var clause = Nebula.Clause.lessThan("score", 50);
* var query = new Nebula.ObjectQuery();
* query.setClause(clause);
* @param {Clause} clause Nebula.Clauseインスタンス
*
*
* @return {ObjectQuery} this
*/
setLimit(limit: number): ObjectQuery;
/**
* @function
* @memberOf ObjectQuery
* @description スキップカウントを設定する。
*
* クエリ件数取得フラグは、Nebula.ObjectBucket.query() を実行したときに
* クエリに合致した件数を取得するかどうかを表し、trueの場合は取得することを示す。
*
* クエリ件数取得フラグのデフォルト値は、falseである。
* @example
* var bucket = ....;
* var clause = Nebula.Clause.lessThan("score", 50);
* var conditions = new Nebula.ObjectQuery();
* conditions.setClause(clause);
* conditions.setLimit(10);
* conditions._setCountQuery(true);
* ....
* conditions.query(conditions)
* .then(function(result) {
* // result.count に全件数、result.objects にオブジェクト配列が返る
* })
* .catch(function(err) {...})
* @param {Boolean} countQuery クエリ件数取得フラグ
*
true または false を指定する。
* @private
*/
_setCountQuery(countQuery: boolean): ObjectQuery;
/**
* @function
* @memberOf ObjectQuery
* @description
* クエリ件数取得フラグを取得する.
*
* クエリ件数取得フラグのデフォルト値は、falseである。
* @return
* {Boolean} クエリ件数取得フラグ(trueまたはfalse)を返す
* @private
*/
_isCountQuery(): boolean;
/**
* @function
* @memberOf ObjectQuery
* @description
* プロジェクションを指定する。
* @example
* var clause = Nebula.Clause.lessThan("score", 50);
* var projection = {"score":1};
* var query = new Nebula.ObjectQuery();
* query.setClause(clause);
* query.setProjection(projection);
* @param {Object} projectionJson
*
* (ブラウザ、またはNode.jsのみ対応)
* @type boolean
* @name User#clientCertUser
*/
clientCertUser: boolean;
/**
* 外部認証連携有りの場合は true
* (ブラウザ、またはNode.jsのみ対応)
* @type boolean
* @name User#federated
* @default false
*/
federated: boolean;
/**
* プライマリリンクユーザID
* OpenID Connect認証でユーザ自動生成時のリンクユーザID
* (ブラウザ、またはNode.jsのみ対応)
* @type String
* @name User#primaryLinkedUserId
* @default null
*/
primaryLinkedUserId: string;
protected _setUserInfo(response: string): void;
/**
* @method
* @memberOf User
* @description ユーザプロパティ設定 (Deprecated)
*
* ・設定可能なプロパティの詳細は、各メソッドの説明を参照のこと。
* ・本メソッドは deprecated である。各フィールドの setter を直接使用すること。
* @param {String} property プロパティ名。
* 指定可能なプロパティ名は以下のとおり。
*
*
* @param {String} value プロパティ値
* @return {User} this
* @deprecated
*/
set(property: string, value: any): void;
/**
* @method
* @memberOf User
* @description ユーザプロパティ取得 (Deprecated)
*
* ・取得可能なプロパティの詳細は、各メソッドの説明を参照のこと。
* ・本メソッドは deprecated である。各フィールドの getter を直接使用すること。
* @param {String} property プロパティ名。
* 指定可能なプロパティ名は以下のとおり(APIによって取得可能なプロパティは異なる)。
*
*
* @return {String} value プロパティ値
* @deprecated
*/
get(property: string): any;
/**
* @method
* @memberOf User
* @description ユーザを登録する。
*
*
* クライアント証明書認証用のユーザの登録を行う場合のユーザプロパティは以下の通りとする
* clientCertUserをtrueに設定した場合、email/passwordは無視する。
* (ブラウザ、またはNode.jsのみ対応)
*
*
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
register(callbacks?: Callbacks): Promise
*
*
* {
* "email" : "foo@example.com",
* "password" : "passwOrd"
* }
*
* {
* "token" : "TOKEN"
* }
*
*
* (※) email か username か token のいずれかを指定する。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
static login(userInfo: LoginInfo, callbacks?: Callbacks): Promise
*
*
*
* ・本情報はクライアントにキャッシュされている情報のため、サーバの最新情報とは一致しない場合がある。
* @param {Callbacks} callbacks コールバック (Deprecated)
*
* ・callbacks は、成功時と失敗時のコールバックを指定する。
* callbacks 引数は後方互換性維持のためにのみ存在するので、通常指定する必要はない。
* {
* success : function(user) {
* // 成功時の処理
* },
* error : function(error) {
* // 失敗時の処理
* }
* }
* ・処理が成功した場合、success コールバックを呼び出す。引数は、返り値と同じ。
* ・本 API は失敗することはないため、error が呼ばれることはない。
*
* @return {User} ユーザオブジェクトのインスタンス。カレントユーザが存在しない場合は null が返る。
*
*
* 以下の情報はオフライン機能無効時のみ取得可
*
*
*/
static current(callbacks?: Callbacks): User;
protected static _current(service: NebulaService, callbacks?: Callbacks): User;
/**
* @method
* @memberOf User
* @description カレントユーザ強制設定
*
* ・すでにカレントユーザが存在する(ログイン中)の場合は、指定したプロパティだけが上書きされる。
* ・本情報はクライアントにキャッシュされる。
* ・本 API はオフラインモードでは使用できない。
* ・本 API は通常のアプリケーションで使用するべきものではない。
* @param {Object} userInfo ユーザ情報(JSON)。null を指定した場合は、カレントユーザを削除する。
*
*
*/
static saveCurrent(userInfo: UserJson): void;
protected static _saveCurrent(service: NebulaService, userInfo: UserJson): void;
/**
* @method
* @memberOf User
* @description カレントユーザ取得(サーバ問合せ)
*
*
*/
static queryCurrent(callbacks?: Callbacks): Promise
*
*
*
* (※) _id かemail かusername のいずれか1つを指定する。
* いずれも指定しない場合は全件検索となる。
* 全件検索時は skip/limit で検索範囲を指定する。
* (ただし skip/limit はオフライン有効時は無効)
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
static query(conditions: UserQuery, callbacks?: Callbacks): Promise
*
*
*
*
*
*
*
*
* (※) ユーザID は、ユーザ登録が成功した場合にSDK がユーザプロパティに設定する。
*
*
*/
static update(user: User, callbacks?: Callbacks): Promise
*
*
*
* ユーザID は、ユーザ登録が成功した場合にSDK がユーザプロパティに設定する。
*
* ・ユーザパスワードのリセットは一定の時間内にリクエストできる回数に制限がある。
* @param {Object} userInfo ユーザ情報。
* JSON 形式で指定する。null は指定できない。
* 以下いずれかのプロパティを指定すること。
*
*
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*/
static resetPassword(userInfo: UserJson, callbacks?: Callbacks): Promise
* ・本 API はオフラインモードでは使用できない。
* @param {Object} user リンク情報取得するユーザオブジェクトのインスタンス。
* null は指定できない。
* リンク情報取得に必要なインスタンスのプロパティは、以下の通り。
*
*
*
*
* @since v6.5.0
*/
static getAccountLinks(user: User, callbacks?: Callbacks): Promise
* ・本 API はオフラインモードでは使用できない。
* @param {Object} user リンク情報削除するユーザオブジェクトのインスタンス。
* null は指定できない。
* リンク情報削除に必要なインスタンスのプロパティは、以下の通り。
*
*
*
* null は指定できない。
* user の primaryLinkedUserId と一致した場合は、例外をスローする。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* @since v6.5.0
*/
static deleteAccountLink(user: User, linkedUserId: string, callbacks?: Callbacks): Promise
* ・グループはアプリ毎ではなく、テナント毎に作成される。
* @example
* var group = new Nebula.Group("group1");
* @param {String} groupname グループ名。
* グループ名に使用できる文字は、１バイト英数のみ。
* @return {Group} 新規グループオブジェクトのインスタンス
*/
constructor(groupname: string, service?: NebulaService);
/**
* グループID
* @type String
* @name Group#_id
*/
_id: string;
/**
* グループ名
* @type String
* @name Group#groupname
*/
groupname: string;
/**
* ユーザIDの一覧(配列)
* @type String[]
* @name Group#users
*/
users: string[];
/**
* グループ名の一覧(配列)
* @type String[]
* @name Group#groups
*/
groups: string[];
/**
* ACL
* @type Acl
* @name Group#acl
*/
acl: Acl;
/**
* 作成日時
* @type String
* @name Group#createdAt
*/
createdAt: string;
/**
* 更新日時
* @type String
* @name Group#updatedAt
*/
updatedAt: string;
/**
* ETag
* @type String
* @name Group#etag
*/
etag: string;
protected _setGroupInfo(response: string): string;
/**
* @memberOf Group
* @description グループプロパティ設定 (Deprecated)
*
* ・設定可能なプロパティの詳細は、各メソッドの説明を参照のこと。
* ・本メソッドは Deprecated である。各フィールドの setter を使用すること。
* @param {String} property プロパティ名
* @param {String} value プロパティ値
* @return {Group} this
* @deprecated since 5.0.0
*/
set(property: string, value: string | string[] | Acl): void;
/**
* @memberOf Group
* @description グループプロパティ取得 (Deprecated)
*
* ・取得可能なプロパティの詳細は、各メソッドの説明を参照のこと。
* ・本メソッドは Deprecated である。各フィールドの getter を使用すること。
* @param {String} property プロパティ名
* @return {String} value プロパティ値
* @deprecated since 5.0.0
*/
get(property: string): any;
/**
* @memberOf Group
* @description グループエントリ追加
*
*
* @return {Boolean} value エントリ結果
*
*
*
ユーザID は、ユーザ登録が成功した場合にSDK がユーザプロパティに設定する。
* ユーザ取得、ログイン、カレントユーザ取得で取得したNebula.User のインスタンスには登録時のユーザID が設定されている。
*
*
*
*
*/
addEntry(entry: User | Group): boolean;
/**
* @memberOf Group
* @description グループエントリ削除
*
*
* (※) グループプロパティ設定（group.set） でプロパティを設定した場合、エントリ追加した内容は上書きされる。
*
*
*
* @return {Boolean} value エントリ結果
*
*
*
ユーザID は、ユーザ登録が成功した場合にSDK がユーザプロパティに設定する。
* ユーザ取得、ログイン、カレントユーザ取得で取得したNebula.User のインスタンスには登録時のユーザID が設定されている。
*
*
*
*
*/
removeEntry(entry: User | Group): boolean;
/**
* @memberOf Group
* @description グループ登録・更新
*
*
* (※) グループプロパティ設定（group.set） でプロパティを設定した場合、エントリ追加した内容は上書きされる。
*
* ・既に同一名称のグループが登録されている場合は更新となる。
* ・グループ登録(又は更新)に必要なグループプロパティは、以下の通り。
*
*
* (※) グループに登録されるユーザ(ID)とグループ名の配列は、グループ
* プロパティ設定で配列を設定する方法とグループエントリの追加／
* 削除で個別に設定する方法がある。
*
* ・ETag値は、グループを登録した場合にサーバで追加され、
* グループを更新する度にサーバで変更される固有値である。
* ETag値は、グループの "etag"プロパティに格納される。
* グループの登録の場合は、etagがないため必ず新規に生成・保存される。
* ・グループプロパティにETag値が含まれる場合、サーバに保存されているグループのETag値と照合される。
* 一致しなかった場合は、データ衝突として「409 Conflict」エラーとなり、グループは更新されない。
* @param {Callbacks} callbacks 応答コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
save(callbacks?: Callbacks): Promise
acl を設定しなかった場合は以下のNebula.Acl インスタンスが自動的に設定される。
*
*
*
*
* @since 6.5.0
*/
addMembers(userIds: string[], groups: string[], callbacks?: Callbacks): Promise
*
* @since 6.5.0
*/
removeMembers(userIds: string[], groups: string[], callbacks?: Callbacks): Promise
*
* @param {Callbacks} callbacks 応答コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* @since v4.0.1
*/
static remove(group: Group, callbacks?: Callbacks): Promise
*
*
* ・本APIは Deprecated である。{@link Group.remove} を使用すること。
* @deprecated since v4.0.1
*/
/**
* @memberOf Group
* @description グループ検索
* @param {Object} conditions 取得条件
*
*
* @param {Callbacks} callbacks 応答コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
* {
* "groupname" : "group1" // グループ名
* }
*
*/
static query(conditions: GroupQuery, callbacks?: Callbacks): Promise
*
*
ファイル名がセットされていない場合は null を返す
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var fileName = metadata.getFileName();
* ....
* @return
* {String} ファイル名を返す。ファイル名がセットされていない場合は、null を返す。
*/
getFileName(): string;
/**
* @memberOf FileMetadata
* @description
* ファイル名をセットする.
*
すでにファイル名がセットされている場合は上書きされる。
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* metadata.setFileName("NewFileName.txt");
* ....
* @param {String} fileName ファイル名
* @return {FileMetadata} this
*/
setFileName(fileName: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルに設定されているACLを取得する.
*
ACLがセットされていない場合は null を返す
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var acl = metadata.getAcl();
* ....
* @return
* {Acl} ACLを返す。ACLがセットされていない場合は、null を返す。
*/
getAcl(): Acl;
/**
* @memberOf FileMetadata
* @description
* ファイルにACLをセットする.
*
すでにACLがセットされている場合は上書きされる
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var newAcl = new Nebula.Acl();
* ....
* metadata.setAcl(newAcl);
* ....
* @param {Acl} acl セットするACL
* @return {FileMetadata} this
*/
setAcl(acl: Acl): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルに設定されているコンテンツタイプを取得する.
*
コンテンツタイプがセットされていない場合は null を返す。
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var contentType = metadata.getContentType();
* ....
* @return
* {String} ファイルにセットされているコンテンツタイプを返す。セットされていない場合は、null を返す。
*/
getContentType(): string;
/**
* @memberOf FileMetadata
* @description
* コンテンツタイプをセットする.
*
すでにコンテンツタイプがセットされている場合は上書きされる。
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* metadata.setContentType("image/jpeg");
* ....
* @param {Acl} contentType セットするコンテンツタイプ
* @return {FileMetadata} this
*/
setContentType(contentType: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルの作成日時を取得する.
*
作成日時は、ISO 8601日付形式の文字列として返す。(例：2014-03-12T09:12:53.000Z)
*
作成日時がセットされていない場合は null を返す。
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var createdAt = metadata.getCreatedAt();
* ....
* @return
* {String} ファイルの作成日時を返す。セットされていない場合は、null を返す。
*/
getCreatedAt(): string;
/**
* @memberOf FileMetadata
* @description ファイルの作成日時をセットする
* @private
*/
_setCreatedAt(createdAt: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルの更新日時を取得する.
*
更新日時は、ISO 8601日付形式の文字列として返す。(例：2014-03-12T09:12:53.000Z)
*
更新日時がセットされていない場合は null を返す。
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var updatedAt = metadata.getUpdatedAt();
* ....
* @return
* {String} ファイルの更新日時を返す。セットされていない場合は、null を返す。
*/
getUpdatedAt(): string;
/**
* @memberOf FileMetadata
* @description ファイルの更新日時をセットする
* @private
*/
_setUpdatedAt(updatedAt: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルのサイズを取得する.
*
ファイルサイズがセットされていない場合は -1 を返す
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var size = metadata.getSize();
* ....
* @return
* {Int} ファイルサイズを返す。セットされていない場合は、-1 を返す。
*/
getSize(): number;
/**
* @memberOf FileMetadata
* @description ファイルサイズをセットする
* @private
*/
_setSize(size: number): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルに設定されている公開URLを取得する.
*
公開URLがセットされていない場合は null を返す。
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var url = metadata.getPublicUrl();
* ....
* @return
* {String} 公開URLを返す。セットされていない場合は、null を返す。
*/
getPublicUrl(): string;
/**
* @memberOf FileMetadata
* @description 公開URLをセットする
* @private
*/
_setPublicUrl(url: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルの同期状態を取得する
*
現在、本APIは利用できません.
*
同期状態がセットされていない場合は Nebula.FileMetadata.SYNC_STATE_UNDEFINED を返す
*
本APIはオフラインのみで利用可能
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var syncState = metadata.getFileSyncState();
* ....
* @return
* {Integer} 以下のいずれかの同期状態を返す
*
*
* @private
*/
getFileSyncState(): number;
/**
* @memberOf FileMetadata
* @description ファイルの同期状態をセットする
* @private
*/
_setFileSyncState(syncState: number): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルの最終同期日時を取得する
*
現在、本APIは利用できません.
*
最終同期日時がセットされていない場合は null を返す
*
同期が完了していないファイルは、同期されるまで null が設定されている
*
本APIはオフラインのみで利用可能
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var lastSyncTime = metadata.getLastSyncTime();
* ....
* @return
* {String} 最終同期日時を返す。セットされていない場合は、null を返す。
* @private
*/
getLastSyncTime(): string;
/**
* @memberOf FileMetadata
* @description ファイルの最終同期日時をセットする
* @private
*/
_setLastSyncTime(lastSyncTime: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* ファイルメタデータIDを取得する.
*
ファイルメタデータIDがセットされていない場合は null を返す
*
同期が完了していないファイルは、同期されるまで null が設定されている
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var metaId = metadata.getMetaId();
* ....
* @return
* {String} ファイルメタデータIDを返す。セットされていない場合は、null を返す。
*/
getMetaId(): string;
/**
* @memberOf FileMetadata
* @description ファイルメタIDをセットする
* @private
*/
_setMetaId(metaId: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* metaETag(ファイルメタデータに対するETag)を取得する.
*
metaEtagがセットされていない場合は null を返す
*
同期が完了していないファイルは、同期されるまで null が設定されている
*
metaETag値は、サーバ側で同期するときに使用され、一致しない場合は衝突と判断される
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var etag = metadata.getMetaETag();
* ....
* @return
* {String} metaEtagを返す。セットされていない場合は、null を返す。
*/
getMetaETag(): string;
/**
* @memberOf FileMetadata
* @description metaETagをセットする
* @private
*/
_setMetaETag(metaETag: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* fileETag(ファイルに対するETag)を取得する.
*
fileEtagがセットされていない場合は null を返す
*
同期が完了していないファイルは、同期されるまで null が設定されている
*
fileETag値は、サーバ側で同期するときに使用され、一致しない場合は衝突と判断される
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* var etag = metadata.getFileETag();
* ....
* @return
* {String} fileEtagを返す。セットされていない場合は、null を返す。
*/
getFileETag(): string;
/**
* @memberOf FileMetadata
* @description metaETagをセットする
* @private
*/
_setFileETag(fileETag: string): FileMetadata;
/**
* @memberOf FileMetadata
* @description オプション情報(JSON)を取得する
* @returns {Object} オプション
*/
getOptions(): object;
/**
* @memberOf FileMetadata
* @description オプション情報(JSON)をセットする
* @param options オプション
* @return {FileMetadata} this
*/
setOptions(options: object): FileMetadata;
/**
* @memberOf FileMetadata
* @description
* キャッシュ禁止かどうかを問い合わせる
*
現在、本APIは利用できません.
*
setCacheDisabled()で設定したキャッシュ禁止フラグを参照する
*
キャッシュ禁止フラグが設定されていない場合は false を返す
*
本APIはオフラインのみで利用可能
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* if (metadata.isCacheDisabled()) {
* // キャッシュ禁止の場合の処理
* }
* else {
* // キャッシュOKの場合の処理
* ....
* }
* ....
* @return
* {Boolean} キャッシュ禁止の場合はtrue、それ以外の場合はfalseを返す
* @private
*/
isCacheDisabled(): boolean;
/**
* @memberOf FileMetadata
* @description
* キャッシュ禁止フラグを設定する
*
現在、本APIは利用できません.
*
キャッシュ禁止がtrueの場合、キャッシュへのファイル保存が行われない
*
本APIはオフラインのみで利用可能
* @example
* fileBucket.getMetadata("MyFile.txt").then(function(metadata) {
* metadata.setCacheDisabled(true);
* ....
* @param {Boolean} cacheDisabled キャッシュ禁止フラグ
* @private
*/
setCacheDisabled(cacheDisabled: boolean): FileMetadata;
/**
* @memberOf FileMetadata
* @description JSONからFileMetadataインスタンスにデータをセットする
* @private
*/
_setMetadata(obj: FileMetadataJson): FileMetadata;
}
/**
* @class バケット基底クラス
* @private
*/
export declare class BaseBucket {
_service: NebulaService;
_type: string;
_name: string;
_acl: Acl;
_noAcl: boolean;
_contentAcl: Acl;
_description: string;
_mode: number;
/**
* コンストラクタ
* @param service NebulaService
* @param name バケット名
* @param type 種別 ("object" or "file")
* @param mode バケットモード(BUCKET_MODE_*)
*/
constructor(service: NebulaService, name: string, type: string, mode?: number);
/**
* @description バケットの読み込み
* @private
*/
protected static _baseLoadBucket(type: string, service: NebulaService, name: string, mode: number, callbacks: Callbacks): Promise
*
* modeを省略した場合や上記以外が指定された場合は、オンラインモードとして処理する。
*/
constructor(name: string, mode?: number, service?: NebulaService);
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットを取得する
* @example
* Nebula.ObjectBucket.loadBucket("Books", callbacks)
* .then(function(bucket) { ... })
* .catch(function(err) { ... });
* @param {string} name 取得するバケットの名前
* @param {Callbacks} callbacks コールバック (Option)
* @param {number} mode バケットモード
*
*
* modeを省略した場合や上記以外が指定された場合は、オンラインモードとして処理する。
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
* ただし、modeを指定する場合は、callbacksにnullを指定すること(省略不可)。
*
*
*/
static loadBucket(name: string, callbacks?: Callbacks, mode?: number): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 取得に失敗したバケットの名前(nameと同じ)
* }
*
*
*
*/
static getBucketList(callbacks?: Callbacks): Promise
*
*/
static getLocalBucketList(callbacks?: Callbacks): Promise
*
*/
saveBucket(callbacks?: Callbacks): Promise
*
*/
deleteBucket(callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : Nebula.ObjectBucket インスタンス
* }
*
*
サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* ....
* var noAcl = true;
* bucket.setNoAcl(noAcl);
* @param noAcl {boolean} ACLレスモードを有効にする場合はtrueを指定する。
* @return {ObjectBucket} this
*/
setNoAcl(noAcl: boolean): ObjectBucket;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットのACLレスモード有効/無効を取得する。
* @example
* var bucket = ....;
* ....
* var noAcl = bucket.isNoAcl();
* @return
* {boolean} オブジェクトバケットがACLレスモード有効の場合はtrueを返す。
*/
isNoAcl(): boolean;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットのコンテンツACLを設定する。
*
*
*/
load(objectId: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 読み込みに失敗したオブジェクトID
* }
*
*
*
* @since v4.0.1
*/
remove(objectId: string, callbacks?: Callbacks, etag?: string): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 削除に失敗したオブジェクトID
* }
*
*
*
* @see #insert
*/
save(object: JsonObject, callbacks?: Callbacks): Promise
*
*
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 保存に失敗したオブジェクト
* }
*
*
*
* @see #save
* @since 7.5.1
*/
insert(object: JsonObject, callbacks?: Callbacks): Promise
新規オブジェクトの場合は、以下のフィールドが追加される。
*
*
*
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 保存に失敗したオブジェクト
* }
*
*
*
*/
query(aQuery: ObjectQuery, callbacks?: Callbacks): Promise
*
*/
queryWithCount(aQuery: ObjectQuery, callbacks?: Callbacks): Promise
*
*
* [
* { "$sort": { "item1": 1 } },
* { "$sort": { "item2": -1 } },
* { "$sort": { "item3": 1 } }
* ]
*
* @param {JsonObject} options オプション
* @param {Callbacks} callbacks コールバック
* @returns {Promise
*
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
setSyncScope(scope: ObjectQuery, callbacks?: Callbacks): Promise
*
*/
getSyncScope(callbacks?: Callbacks): Promise
*
*/
getResolveConflictPolicy(callbacks?: Callbacks): Promise
*
*
*
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*/
setResolveConflictPolicy(policy: number, callbacks?: Callbacks): Promise
* {
* onSyncStart: function(targetBucket) {
* // 同期開始時に呼び出される
* // targetBucket : 同期対象のバケット名
* },
* onSyncCompleted: function(targetBucket, objectIds) {
* // 同期完了時に呼び出される
* // targetBucket : 同期が完了したバケット名
* // objectIds : 同期が完了したオブジェクトIDの配列
* },
* onSyncConflicted: function(bucket, client, server) {
* // 衝突発生時に呼び出される
* // bucket : 衝突が発生したバケットのNebula.ObjectBucketインスタンス(衝突解決時に使用)
* // client : クライアント側の衝突データ
* // server : サーバ側の衝突データ
* },
* onResolveConflict: function(resolveObject, resolve) {
* // データの衝突の解決時に呼び出される
* // resolveObject : 解決に使用したデータ
* // resolve : 解決方法
* },
* onSyncError: function(errorCode, errorObject) {
* // 同期処理中のエラー発生時に呼び出される
* // errorCode : エラー種別
* // Nebula.ObjectBucket.SYNC_ERROR_PULL ： 同期処理のPULLエラー
* // Nebula.ObjectBucket.SYNC_ERROR_PUSH ： 同期処理のPUSHエラー
* // Nebula.ObjectBucket.SYNC_ERROR_PUSH_RESYNCING ： 同期処理のpushエラー後に、同期リトライ中
* // Nebula.ObjectBucket.SYNC_ERROR_OVERLAP_ID ： 同期処理のID重複エラー
* // errorObject : エラーが発生したオブジェクト
* }
* }
*
*/
setSyncEventListener(listener: SyncEventListener): any;
/**
* @memberOf ObjectBucket
* @description
* すべてのオブジェクトバケットの一括同期を実行する。(オフライン専用)
*
*
*/
resolveConflict(objectId: string, resolve: number): any;
/**
* @memberOf ObjectBucket
* @description
* オブジェクトバケットにインデックス設定する(オフライン専用)。
* 本APIはオフラインのみで利用可能
* @example
* var bucket = new Nebula.ObjectBucket("Books", Nebula.BUCKET_MODE_REPLICA);
* ....
* index = {
* "index": [{"name": "key1", "type": "string"}, {"name": "key2", "type": "number"}]
* };
* callbacks = {
* success: function() {....},
* error: function(err) {....}
* };
* bucket.setIndexToLocal(index, callbacks);
* @param {Object} index インデックス情報
* インデックス情報は以下のようにJSONで指定する
*
*
*
* {
* "index": [{"name": "key1", "type": "string"}, {"name": "key2", "type": "number"}]
* }
* index にはインデックスを設定するキー名と型を指定する。型は文字列で"string","boolean","number"のいずれかを指定する。
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*/
setIndexToLocal(index: JsonObject, callbacks?: Callbacks): Promise
*
*/
getIndexFromLocal(callbacks?: Callbacks): Promise
* {
* "index": [{"name": "key1", "type": "string"}, {"name": "Key2", "type": "number"}]
* }
*
*
*/
getLastSyncTime(callbacks?: Callbacks): Promise
*
* @since v4.0.0
*/
batch(request: BatchRequest, callbacks?: Callbacks): Promise
*
*/
static loadBucket(name: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : ファイルバケット名(nameに同じ)
* }
*
*
*
*/
static getBucketList(callbacks?: Callbacks): Promise
*
*/
saveBucket(callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : Nebula.FileBucket インスタンス
* }
*
*
*
*/
deleteBucket(callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : Nebula.FileBucket インスタンス
* }
*
*
サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* var acl = new Nebula.Acl();
* ....
* acl.addEntry(....);
* ....
* bucket.setAcl(acl);
* @param acl {Acl} Aclインスタンス
* @return {FileBucket} this
*/
setAcl(acl: Acl): FileBucket;
/**
* @memberOf FileBucket
* @description
* ファイルバケットのACLを取得する.
*
サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* ....
* var noAcl = true;
* bucket.setNoAcl(noAcl);
* @param noAcl {boolean} ACLレスモードを有効にする場合はtrueを指定する。
* @return {FileBucket} this
*/
setNoAcl(noAcl: boolean): FileBucket;
/**
* @memberOf FileBucket
* @description
* ファイルバケットのACLレスモード有効/無効を取得する。
* @example
* var bucket = ....;
* ....
* var noAcl = bucket.isNoAcl();
* @return
* {boolean} ファイルバケットがACLレスモード有効の場合はtrueを返す。
*/
isNoAcl(): boolean;
/**
* @memberOf FileBucket
* @description
* ファイルバケットのコンテンツACLを設定する.
*
サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* var acl = new Nebula.Acl();
* ....
* acl.addEntry(....);
* ....
* bucket.setContentAcl(acl);
* @param {Acl} acl Nebula.ACL のインスタンス
* @return {FileBucket} this
*/
setContentAcl(acl: Acl): FileBucket;
/**
* @memberOf FileBucket
* @description
* ファイルバケットのコンテンツACLを取得する.
*
サーバと同期するには、saveBucket()を呼び出す必要がある。
* @example
* var bucket = ....;
* var acl = new Nebula.Acl();
* ....
* acl.addEntry(....);
* ....
* bucket.setDescription("このバケットの説明文”);
* @param {String} description 設定する「説明文」
* @return {FileBucket} this
*/
setDescription(description: string): FileBucket;
/**
* @memberOf FileBucket
* @description
* ファイルバケットの「説明文」を取得する.
*
*
* @param {FileMetadata} metadata 保存するファイルのメタデータ
*
*
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
saveAs(fileName: string, data: any, metadata: FileMetadata, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : 引数で指定されたfileName
* }
*
*
*
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
save(fileName: string, data: any, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : 引数で指定されたfileName
* }
*
*
*
*/
load(fileName: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* "data" : 引数で指定されたfileName
* }
*
*
*
* @param {Callbacks} callbacks コールバック (Option)
*
*
*
*
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
* @since 7.5.0
* @example
* // Raw Requestの例
* // for HTTP/1.1
* var bucket = ....;
* ....
* // pipe()を使用する場合
* var writable = fs.createWriteStream(....);
* bucket.loadWithOptions("MyFile.jpg", {rawRequest: true})
* .then((message) => {
* message.pipe(writable);
* });
*
* // 'data'を実装する場合
* bucket.loadWithOptions("MyFile.jpg", {rawRequest: true})
* .then((message) => {
* message.on('data', () => {....});
* message.on('end', () => {....});
* message.on('error', () => {....});
* message.on('close', () => {....});
* });
*
* // for HTTP/2
* // 'data'を実装する場合
* var statusCode;
* bucket.loadWithOptions("MyFile.jpg", {rawRequest: true})
* .then((message) => {
* message.on('response', (headers, flags) => { statusCode = headers[':status'] });
* message.on('data', () => {....});
* message.on('end', () => {....});
* message.on('error', () => {....});
* message.on('close', () => {....});
* });
* @example
* // start,end 指定の例 詳細はRFC7233を参照
* // サーバに1000 byteのファイルが格納されている場合
* // 最初の50byteを取得
* var options = { rangeStart : 0, rangeEnd: 49 };
* // 次の50byteを取得
* options = { rangeStart : 50, rangeEnd: 99 };
* // 末尾の50byteを取得する(以下指定は等価である)
* options = { rangeStart : 950 };
* options = { rangeEnd : 50 };
* options = { rangeStart : 950, rangeEnd: 999 };
* // 先頭の1byteを指定
* options = { rangeStart: 0, rangeEnd: 0 };
* // 末尾の1byteを指定
* options = { rangeEnd: 1 };
*
* options["extraResponse"] = true; // ステータスコードなどを含めて取得
* // APIコール
* var bucket = ....;
* ....
* callbacks = {
* // options["extraResponse"] がtrueでない場合、dataにはファイルデータが設定される
* success: function(data) {
* var status = data.status;
* var headers = data.headers;
* var body = data.body;
* ....
* },
* error: function(err) {....}
* };
* bucket.loadWithOptions("MyFile.jpg", options, callbacks);
*/
loadWithOptions(fileName: string, options?: FileRequestOptions, callbacks?: Callbacks): Promise
*
*
* {
* status : ステータスコード,
* headers : レスポンスヘッダ情報を含むオブジェクト,
* body : ファイルデータが格納されたオブジェクト
* }
*
* 範囲囲指定のオプションを指定した場合、以下statusが返却される。
* ・200 ファイル全体を取得
* ・206 ファイルの一部取得
*
* headersには以下をヘッダを含む。
* ・etag : ファイルのETag。
* 値はダブルクオーテーション(")で囲まれている。
* etag参照時はクオーテーションを削除して使用すること。
* 例) headers["etag"].replace(/[¥"]/g, "");
*
*
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName,
* }
* 範囲指定の読み込みでは以下statusのエラーが発生することがある。
* 内容に応じて対処を行うこと。
* 412 : ファイルが更新されているためダウンロード失敗
* 416 : 範囲指定不正のためダウンロード失敗
*
*
* @since v4.0.1
*/
remove(fileName: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
*
*/
publish(fileName: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
*
*/
unpublish(fileName: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
*/
getList(callbacks?: Callbacks): Promise
*
*/
getPublishedList(callbacks?: Callbacks): Promise
*
*/
getMetadata(fileName: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
*/
updateMetadata(fileName: string, metadata: FileMetadata, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
*
*/
static selectUploadFile(callbacks?: Callbacks): Promise
* {
* "path" : "ファイルのパス情報",
* "name" : "ファイル名",
* "type" : "コンテンツタイプ" // ※ コンテンツタイプを特定できない場合は空白
* }
*
*
*
*/
static selectDirectory(callbacks?: Callbacks): Promise
指定できるメタデータは以下の通りである。(他のメタデータは参照されない)
*
*
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
uploadNewFile(fileName: string, filePath: string, metadata: FileMetadata, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
指定できるメタデータは以下の通りである。(他のメタデータは参照されない)
*
*
* @param {Callbacks} callbacks コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
uploadUpdateFile(fileName: string, filePath: string, metadata: FileMetadata, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
*
*/
downloadFile(fileName: string, filePath: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
現在、本APIは利用できません.
*
アップロードまたはダウンロードがキャンセルされた場合は、
* 各API(uploadNewFile(), uploadUpdateFile(), downloadFile())のエラーコールバックが呼ばれる。
*
*
* @private
*/
requestCancel(fileName: string, callbacks?: Callbacks): Promise
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ,
* "data" : 引数で指定されたfileName
* }
*
*
*
* @param {Callbacks} callbacks 応答コールバック (Option)
* @return {Promise} callbacksを指定しなかった場合、Promiseオブジェクトを返す。callback指定時は返り値なし(undefined)。
*
*
*/
execute(data: object, callbacks?: Callbacks): Promise
*
*
*
*/
send(callbacks?: Callbacks): Promise
* {
* "result": "ok",
* "installations": 条件に合致したインスタレーションの数
* }
*
*
* {
* "status" : ステータスコード,
* "statusText" : エラーメッセージ,
* "responseText" : レスポンスメッセージ
* }
*
*
* HTTP/2 を使用する場合は、Node.js v8.4 以上が必要。
* @returns {boolean} HTTP/2を使用する場合は trueを返却する。
*/
getHttp2(): boolean;
/**
* @memberOf NebulaService
* @description HTTP2 の有効/無効を指定する。(Node.js使用時のみ有効)
* HTTP/2 を使用する場合は、Node.js v8.4 以上が必要。
* HTTP/2使用時は、Proxy({@link NebulaService#setHttpProxy}、{@link NebulaService#setHttpsProxy})は無効である。
* @param {boolean} enable HTTP/2を使用する場合はtrueを設定する。
*/
setHttp2(enable: boolean): void;
/**
* @memberOf NebulaService
* @description MBaaS JavaScript SDK 初期化
*
* ・アプリケーションは、SDK の初回利用またはパラメータ変更を行う際に呼び出さなければならない。
*
* @param {Object} params MBaaS JavaScript SDK 初期化パラメータ
*
*
* @return {NebulaService} this
*/
initialize(params: NebulaInitParam): NebulaService;
/**
* @memberOf NebulaService
* @description ログインキャッシュ有効期限の設定（オフライン機能限定）
*
*
*
*
*/
getLoginCacheValidTime(callbacks?: Callbacks): Promise
*
* @return {NebulaService} this
*/
setNetworkEventListener(listener: NetworkEventListener): NebulaService;
/**
* @memberOf NebulaService
* @description HTTP プロキシを設定する (Node.js専用)。
*
* {
* onNetworkStateChanged : function(isOnline) {
* // ネットワークの接続状態が変更されたときに呼び出される
* // isOnline : trueはオンライン状態、falseはオフライン状態
* }
* }
*
*