NCMBScript Class Reference

Inherits from	NSObject
Declared in	NCMBScript.h

Overview

NCMBScriptクラスは、ニフクラ mobile backendに登録されているスクリプトを実行するためのクラスです。

`service`

service スクリプト実行APIをリクエストするためのService

@property NCMBScriptService *service

Declared In

NCMBScript.h

`scriptName`

scriptName スクリプトのファイル名

@property NSString *scriptName

Declared In

NCMBScript.h

`method`

method スクリプトをリクエストする場合のメソッド

@property NCMBScriptRequestMethod method

Declared In

NCMBScript.h

`+ scriptWithName:method:`

スクリプト名とリクエストメソッドを指定してNCMBScriptのインスタンスを作成

+ (instancetype)scriptWithName:(NSString *)name method:(NCMBScriptRequestMethod)method

Parameters

`name`	スクリプトのファイル名
`method`	スクリプトをリクエストする場合のメソッド

Return Value

NCMBScriptのインスタンス

Declared In

NCMBScript.h

`+ scriptWithName:method:endpoint:`

スクリプト名とリクエストメソッド、APIのエンドポイントを指定してNCMBScriptのインスタンスを作成

+ (instancetype)scriptWithName:(NSString *)name method:(NCMBScriptRequestMethod)method endpoint:(NSString *)endpoint

Parameters

`name`	スクリプトのファイル名
`method`	スクリプトをリクエストする場合のメソッド
`endpoint`	ローカルで動作させているスクリプトをリクエストする場合などに指定するAPIサーバーのエンドポイント

Return Value

NCMBScriptのインスタンス

Declared In

NCMBScript.h

`– execute:headers:queries:error:`

リクエストパラメータを指定してスクリプトを同期通信で実行し、結果を取得する

- (NSData *)execute:(NSDictionary *)data headers:(NSDictionary *)headers queries:(NSDictionary *)queries error:(NSError **)error

Parameters

`data`	リクエスト時のbodyデータ（リクエストメソッドが NCMBExecuteWithPostMethod / NCMBExecuteWithPutMethod の場合のみ送信される）
`headers`	リクエスト時のヘッダー
`queries`	リクエスト時のクエリパラメータ(クエリストリングに変換されます)
`error`	エラーオブジェクトのポインタ

Return Value

スクリプトを実行した結果をNSDataで返す

Declared In

NCMBScript.h

`– execute:headers:queries:withBlock:`

リクエストパラメータを指定してスクリプトを非同期通信で実行し、結果を取得する

- (void)execute:(NSDictionary *)data headers:(NSDictionary *)headers queries:(NSDictionary *)queries withBlock:(NCMBScriptExecuteCallback)block

Parameters

`data`	リクエスト時のbodyデータ（リクエストメソッドが NCMBExecuteWithPostMethod / NCMBExecuteWithPutMethod の場合のみ送信される）
`headers`	リクエスト時のヘッダー
`queries`	リクエスト時のクエリパラメータ(クエリストリングに変換されます)
`block`	スクリプト実行APIをリクエストしたあとに実行されるコールバック。コールバック引数のdataにはスクリプト実行後の結果が入ります。errorにはスクリプト実行後のエラーが入ります。

Declared In

NCMBScript.h