IntdashClient

open class IntdashClient : NSObject

intdashへ接続するクライアントを表すクラス。intdashへのアクセス全体を管理します。

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

    Declaration

    Swift

    public var session: IntdashClient.Session?

  • 出力するログのレベル。指定した値以上のレベルのログが出力されます。

    Declaration

    Swift

    public var logLevel: IntdashLogLevel { get set }
  • tag

    オブジェクトを識別するためのタグ。

    Declaration

    Swift

    public var tag: Int

  • IntdashClientを生成します。各種APIへアクセスするには session に適切なセッション情報を設定する必要があります。

    Declaration

    Swift

    public override init()

  • リアルタイムAPIへの再接続時間のデフォルト値。2秒が設定されています。

    Declaration

    Swift

    public static let reconnectTimeInterval: TimeInterval

  • DownstreamManager のオブジェクトです。 init() により初期化され、使用可能になります。 connect(reconnectTimeInterval:completion:) 等によりリアルタイムAPIに接続してから、ダウンストリームを操作するために使用します。

    Declaration

    Swift

    public let downstreamManager: IntdashClient.DownstreamManager

  • UpstreamManager のオブジェクトです。 init() により初期化され、使用可能になります。 connect(reconnectTimeInterval:completion:) 等によりリアルタイムAPIに接続してから、アップストリームを操作するために使用します。

    Declaration

    Swift

    public let upstreamManager: IntdashClient.UpstreamManager

  • リアルタイムAPIに接続します。 接続先のURLには、 session が持つ情報が使用されます。

    Declaration

    Swift

    public func connect(reconnectTimeInterval: TimeInterval = reconnectTimeInterval,
                    completion: @escaping (Error?)->())

    Parameters

    reconnectTimeInterval

    切断時の再接続時間
    リアルタイムAPIから切断された場合に、この設定値の間隔が経過した後に再接続します。0を指定すると再接続しません。
    completion

    接続完了時のコールバック

  • リアルタイムAPIに接続します。

    Declaration

    Swift

    public func connect(url: URL,
                    reconnectTimeInterval: TimeInterval = reconnectTimeInterval,
                    completion: @escaping (Error?)->())

    Parameters

    url

    接続先のURL
    （ 例: https://example.com:443/api/v1/ws/measurements ）
    reconnectTimeInterval

    切断時の再接続時間
    リアルタイムAPIから切断された場合に、この設定値の間隔が経過した後に再接続します。0を指定すると再接続しません。
    completion

    接続完了時のコールバック

  • リアルタイムAPIに接続します。

    Declaration

    Swift

    public func connect(string: String,
                    reconnectTimeInterval: TimeInterval = reconnectTimeInterval,
                    completion: @escaping (Error?)->())

    Parameters

    string

    接続先のURLを表す文字列
    （ 例: https://example.com:443/api/v1/ws/measurements ）
    reconnectTimeInterval

    切断時の再接続時間
    リアルタイムAPIから切断された場合に、この設定値の間隔が経過した後に再接続します。0を指定すると再接続しません。
    completion

    接続完了時のコールバック

  • リアルタイムAPIから切断します。

    Declaration

    Swift

    public func disconnect(completion: @escaping (Error?) -> ())

    Parameters

    completion

    切断完了時のコールバック

  • Delegateを追加します。

    Declaration

    Swift

    public func addDelegate(_ delegate: IntdashClientDelegate)

    Parameters

    delegate

    追加するDelegate

  • Delegateを削除します。

    Declaration

    Swift

    public func removeDelegate(_ delegate: IntdashClientDelegate)

    Parameters

    delegate

    削除するDelegate

  • 割り当てを解除します。

    Declaration

    Swift

    public func dispose()

  • intdashとの間に張られたセッションの情報を保存するクラス。

    See more

    Declaration

    Swift

    open class Session : TokenRefresherDelegate

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

    See more

    Declaration

    Swift

    open class DataPointsAPI

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

    See more

    Declaration

    Swift

    open class EdgesAPI

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

    See more

    Declaration

    Swift

    open class MeasurementsAPI

  • ダウンストリームを管理するクラス。

    See more

    Declaration

    Swift

    open class DownstreamManager : NSObject

  • アップストリームを管理するクラス。

    See more

    Declaration

    Swift

    public class UpstreamManager : NSObject

  • OAuth2.0に関連するAPIへアクセスする機能を提供するクラス。

    See more

    Declaration

    Swift

    open class OAuth2API

  • OAuth2API のオブジェクト。

    Declaration

    Swift

    public var oauth2: OAuth2API { get }

  • EdgesAPI のオブジェクト。

    Declaration

    Swift

    public var edges: EdgesAPI { get }

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

    See more

    Declaration

    Swift

    open class CapturesAPI

  • CapturesAPI のオブジェクト。

    Declaration

    Swift

    public var captures: CapturesAPI { get }

  • MeasurementsAPI のオブジェクト。

    Declaration

    Swift

    public var measurements: MeasurementsAPI { get }

  • DataPointsAPI のオブジェクト。

    Declaration

    Swift

    public var dataPoints: DataPointsAPI { get }

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

    See more

    Declaration

    Swift

    open class VersionsAPI

  • VersionsAPI のオブジェクト。

    Declaration

    Swift

    public var version: VersionsAPI { get }