MeasurementsAPI

open class MeasurementsAPI

Measurements APIにアクセスする機能を提供するクラス。

  • intdashとの間に張られたセッションの情報。

    Declaration

    Swift

    public var session: IntdashClient.Session?

  • MeasurementsAPIを生成します。

    Declaration

    Swift

    public init(session: IntdashClient.Session?)

    Parameters

    session

    セッション情報

  • Measurementのリストを取得します。

    Declaration

    Swift

    public func list(uuid: String? = nil, name: String? = nil, edgeUuid: String? = nil, start: TimeInterval? = nil, end: TimeInterval? = nil, durationStart: TimeInterval? = nil, durationEnd: TimeInterval? = nil, status: IntdashClient.MeasurementsAPI.Status? = nil, limit: Int? = nil, page: Int? = nil, order: IntdashClient.MeasurementsAPI.OrderType = .asc, completion: @escaping (_ response: MeasurementsListResponse?, _ error: RESTError?) -> ())

    Parameters

    uuid

    取得対象とする計測のUUID
    name

    取得対象とする計測の名前
    edgeUuid

    取得対象とする計測が紐づくエッジのUUID
    start

    取得対象とする範囲の始点（UNIXエポックからの経過時間を使用します）
    end

    取得対象とする範囲の終点（UNIXエポックからの経過時間を使用します）
    durationStart

    取得対象とする計測の長さの最小値（長さがこの値以上の計測を取得対象とします）
    durationEnd

    取得対象とする計測の長さの最大値（長さがこの値未満の計測を取得対象とします）
    status

    取得対象とする計測の状態
    limit

    取得対象とする最大の計測数
    page

    取得対象とするページ番号
    order

    取得結果の順序
    completion

    処理終了時のコールバック
    response

    レスポンスデータ
    error

    エラー情報

  • 順序を表す列挙型。

    See more

    Declaration

    Swift

    public enum OrderType : String
  • See more

    Declaration

    Swift

    public enum Status : String