DataPointsAPI

open class DataPointsAPI

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

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

    Declaration

    Swift

    public var session: IntdashClient.Session?

  • DataPointsAPIを生成します。

    Declaration

    Swift

    public init(session: IntdashClient.Session?)

    Parameters

    session

    セッション情報

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

    Declaration

    Swift

    public func getDataPoints(name: String, filters: DataPointsAPI.RequestFilters?, start: TimeInterval, end: TimeInterval, limit: Int = -1, order: IntdashClient.DataPointsAPI.OrderType = .asc, completion: @escaping (_ response: DataPointsGetDataPointsResponse?, _ error: RESTError?) -> ())

    Parameters

    name

    取得対象とする検索名
    計測のUUID、エッジのUUID、エッジの名前を検索対象とし、計測のUUID > エッジのUUID > エッジの名前の順に優先して検索されます。
    filters

    どのデータを取得するかを指定するフィルター
    start

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

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

    取得する最大のデータポイント数
    order

    取得結果の順序
    completion

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

    レスポンスデータ
    error

    エラー情報

  • 順序を表す列挙型。

    See more

    Declaration

    Swift

    public enum OrderType : String

  • getDataPoints(name:filters:start:end:limit:order:completion:) で使用するフィルターを生成するクラス。

    See more

    Declaration

    Swift

    public class RequestFilters