APIドキュメント¶
pykayacim.api¶
このモジュールはim.kayac.comと通信するためのものです。
-
class
pykayacim.api.KayacIMAPI(username, method='none', key=None)[ソース]¶ im.kayac.com APIを利用するためのクラスです。
パラメタ: - username (str (on Python 3) or unicode (on Python 2)) – あなたのアカウントのユーザ名です。
- method (str (on Python 3) or unicode (on Python 2)) – （任意）認証方法です。
pykayacim.constants.KAYACIM_METHODSから選択してください。 - key (str (on Python 3) or unicode (on Python 2)) – （任意）パスワードあるいは秘密鍵です。
例外 pykayacim.exceptions.PyKayacIMMethodError: 利用不可能の方法が指定されたか、与えられた情報が不十分であるとき
-
key= None¶ パスワードあるいは秘密鍵です。
-
method= None¶ im.kayac.comが受け入れる認証方法です。
-
post_params= None¶ POST要求のパラメータです。
-
post_request= None¶ im.kayac.comに送信された要求を表すオブジェクトです。
-
post_response= None¶ im.kayac.comからの応答を表す辞書です。
-
post_url= None¶ POST要求を送信すべきURLです。
-
prepare_parameters(message, handler=None)[ソース]¶ 与えられたパラメータを表す辞書を作成します。
このメソッドは
pykayacim.api.KayacIMAPI.send()により呼び出され、直接呼び出す必要はありません。パラメタ: - message (str (on Python 3) or unicode (on Python 2)) – 送信すべきメッセージです。
- handler – （任意）iPhoneアプリケーションのためのURIスキームです。これはたとえば “mailto:” で始まります。
-
resend()[ソース]¶ 直前のメッセージを再送信します。
例外: - pykayacim.exceptions.PyKayacIMAPIError – im.kayac.comがエラーを伝えたとき
- pykayacim.exceptions.PyKayacIMCommunicationError – im.kayac.comとの接続に失敗したとき
- pykayacim.exceptions.PyKayacIMMessageError – 以前にまったくメッセージが送信されていないとき
-
send(message, handler=None)[ソース]¶ im.kayac.com経由でプッシュ通知を送信します。
パラメタ: - message (str (on Python 3) or unicode (on Python 2)) – 送信すべきメッセージです。
- handler (str (on Python 3) or unicode (on Python 2)) – （任意）iPhoneアプリケーションのためのURIスキームです。これはたとえば “mailto:” で始まります。
例外: - pykayacim.exceptions.PyKayacIMAPIError – im.kayac.comがエラーを伝えたとき
- pykayacim.exceptions.PyKayacIMCommunicationError – im.kayac.comとの接続に失敗したとき
-
username= None¶ あなたのim.kayac.comアカウントのユーザ名です。
-
pykayacim.api.api_logger= <logging.Logger object at 0x000000000517B208>¶ このモジュールのロガーです。
-
pykayacim.api.create_post_request(url, params, encoding='utf-8')[ソース]¶ パラメータをURLエンコードし、POST要求を作成します。
パラメタ: - url (str (on Python 3) or unicode (on Python 2)) – POST要求を送信すべきURLです。
- params (dict) – パラメータを表す辞書です。その値は文字列型（Python 3上）あるいはUnicode文字列型（Python 2上）であるべきです。
- encoding (str (on Python 3) or unicode (on Python 2)) – 使用すべきエンコーディングです。
戻り値: HTTP POST要求です。
戻り値の型: urllib.request.Request（Python 3上）あるいはfuture.backports.urllib.request.Request（Python 2上）
-
pykayacim.api.generate_signature(data, encoding='utf-8')[ソース]¶ 与えられた文字列のSHA-1ダイジェストを生成します。
パラメタ: data (str (on Python 3) or unicode (on Python 2)) – 処理すべき文字列です。 戻り値: SHA-1ダイジェストです。 戻り値の型: 文字列型（Python 3上）あるいは future.types.newstr.newstr（Python 2上）
注釈
上述のように、 pykayacim.api はPythonの logging 機構を使用します。あなたのアプリケーションから pykayacim.api で定義されているロガーを利用し、そのログを処理することができます。
pykayacim.constants¶
このモジュールはPyKayacIMの定数を含みます。
-
pykayacim.constants.KAYACIM_ENCODING= 'utf-8'¶ im.kayac.comが受け入れるエンコーディングです。
-
pykayacim.constants.KAYACIM_METHODS= ['none', 'password', 'secret']¶ im.kayac.comが受け入れる認証方法です。
- “none”
認証を行いません。
- “password”
パスワードでの認証を使用します。
- “secret”
秘密鍵暗号法を用います。
-
pykayacim.constants.KAYACIM_URL= 'http://im.kayac.com/api/post/'¶ APIエンドポイントのURLです。
pykayacim.exceptions¶
このモジュールはPyKayacIMの例外を含みます。
-
exception
pykayacim.exceptions.PyKayacIMAPIError(errmsg)[ソース]¶ im.kayac.comがエラーを伝えたときに発生します。
パラメタ: errmsg (str (on Python 3) or unicode (on Python 2)) – エラーに関する詳細情報です。
-
exception
pykayacim.exceptions.PyKayacIMCommunicationError(reason)[ソース]¶ im.kayac.comとの通信に失敗すると発生します。
このモジュールがim.kayac.comとの接続を確立できないか、HTTPエラーが起こると、この例外が発生するでしょう。
パラメタ: reason (str (on Python 3) or unicode (on Python 2)) – 通信に失敗した理由です。