EdgesAPI

open class EdgesAPI

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

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

    Declaration

    Swift

    public var session: IntdashClient.Session?
  • EdgesAPIを生成します。

    Declaration

    Swift

    public init(session: IntdashClient.Session?)

    Parameters

    session

    セッション情報

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

    Declaration

    Swift

    public func list(uuid: String? = nil, order: IntdashClient.EdgesAPI.OrderType = .asc, limit: Int? = nil, page: Int? = nil, name: String? = nil, nickname: String? = nil, type: IntdashClient.EdgesAPI.EdgeType? = nil, completion: @escaping (_ response: EdgesListResponse?, _ error: RESTError?) -> ())

    Parameters

    uuid

    取得対象とするエッジのUUID

    order

    取得結果の順序

    limit

    取得対象とする最大のエッジ数

    page

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

    name

    取得対象とするエッジの名前

    nickname

    取得対象とするエッジの表示名

    type

    取得対象とするエッジのタイプ 省略した場合全てのタイプを取得対象とします。

    completion

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

    response

    レスポンスデータ

    error

    エラー情報

  • サインイン中のEdgeの情報を取得します。

    Declaration

    Swift

    public func me(completion: @escaping (_ response: EdgesMeResponse?, _ error: RESTError?) -> ())

    Parameters

    completion

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

    response

    レスポンスデータ

    error

    エラー情報

  • サインイン中のエッジのパスワード情報を取得します。

    Declaration

    Swift

    public func mePassword(completion: @escaping (_ response: EdgesMePasswordResponse?, _ error: RESTError?) -> ())

    Parameters

    completion

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

    response

    レスポンスデータ

    error

    エラー情報

  • 順序を表す列挙型。

    See more

    Declaration

    Swift

    public enum OrderType : String
  • エッジのタイプを表す列挙型。

    See more

    Declaration

    Swift

    public enum EdgeType : String