NCMBScript

public struct NCMBScript

スクリプト機能を利用するためのクラスです。

  • Undocumented

    Declaration

    Swift

    public var name: String

  • イニシャライズです。

    エンドポイントURL、APIバージョンは他の機能とは異なります。

    Declaration

    Swift

    public init(
        name: String,
        method: NCMBHTTPMethod,
        endpoint: String = NCMB.DEFAULT_SCRIPT_ENDPOINT,
        apiVersion: String = NCMB.DEFAULT_SCRIPT_API_VERSION)

    Parameters

    name

    スクリプト名
    method

    スクリプトを実行する際の HTTPメソッド
    domainURL

    エンドポイントURL
    apiVersion

    APIバージョン

  • 設定されたスクリプトを同期処理にて実行します。

    Declaration

    Swift

    public func execute(
        headers: [String : String?] = [:],
        queries: [String : String?] = [:],
        body: [String : Any?] = [:]) -> NCMBResult<Data?>

    Parameters

    header

    スクリプト実行時のヘッダー（key-value形式）
    queries

    スクリプト実行時のクエリー（key-value形式）
    body

    スクリプト実行時のbody（key-value形式）

    Return Value

    リクエストが成功した場合は .success 、 失敗した場合は .failure<Error>

  • 設定されたスクリプトを非同期処理にて実行します。

    Declaration

    Swift

    public func executeInBackground(
        headers: [String : String?] = [:],
        queries: [String : String?] = [:],
        body: [String : Any?] = [:],
        callback: @escaping NCMBHandler<Data?>) -> Void

    Parameters

    header

    スクリプト実行時のヘッダー（key-value形式）
    queries

    スクリプト実行時のクエリー（key-value形式）
    body

    スクリプト実行時のbody
    callback

    レスポンス取得後に実行されるコールバックです。