API リファレンス - 共通モジュール

hylable.common

Hylable SDK で共通して使用するクラスや関数を定義するモジュールです。

class hylable.common.BaseClient(profile_name: str = 'default')

ベースクラス: object

Hylable のサービスと通信するための基底クラス

インスタンス作成時に profile_name にプロフィール名を指定することで 設定ファイルのプロフィールを切り替えられる

login() → None

ログインする関数。 インスタンス作成時に自動的にログインを行うので基本的に呼ぶ必要は無いが、 長時間に渡るとトークンの期限が切れるので、その場合は定期的に呼び出しが必要。

class hylable.common.BaseDataModel(rawdata: dict = <factory>)

ベースクラス: object

データクラスの元になる基底クラス

sync_data(client) → None

サーバにある最新の情報を取得して内容を更新する関数

パラメータ:

client (BaseClient) -- 通信するためのクライアントオブジェクト

hylable.error

exception hylable.error.AuthenticationError

ベースクラス: Exception

認証に失敗したことを表す

exception hylable.error.DataNotFoundError

ベースクラス: Exception

データが無いことを表す

exception hylable.error.InternalServerError

ベースクラス: Exception

サーバーエラーがあったことを表す