CBLabs.CybozuConnect.App

CBLabs.CybozuConnect.App

サイボウズ Office 8/ガルーン 3 連携 API を実行するためのクラス

Constuctors

CBLabs.CybozuConnect.App(url, username, password)

Arguments

• url (String)

  アクセス先のURL。URlは ag.exe(cgi) または grn.exe(cgi) で終わる必要がある。

• username (String)

  省略可。username と password を指定した場合、クラス生成時に auth を実行する。

• password (String)

  省略可。username と password を指定した場合、クラス生成時に auth を実行する。

Fields

.debug

(Boolean)
デバッグモードか否か

.error

(Object)
直前のエラー情報

.user

(Object)
認証を行ったユーザー情報

.userId

(String)
認証を行ったユーザーのID

Methods

.auth()

auth(username, password)

APIに対して認証を行う。auth 実行後、query, exec を呼び出すことができる。

Arguments

• username (String)

  ログイン名

• password (String)

  パスワード

Returns

(Boolean)
true: 成功、false: 失敗

.clearAuth()

clearAuth()

認証をクリアする。再度 auth を実行しない限り、query, exec を呼び出すことはできなくなる。

.exec()

exec(service, method, params, alertIfError, debug)

APIを実行する。

Arguments

• service (String)

  アプリケーション識別子 (Base/Schedule/...)

• method (String)

  API名

• params (Object)

  APIへのパラメータ

• alertIfError (Boolean)

  true のとき、API実行時にエラーが出た場合、アラートボックスを表示する。

• debug (Boolean)

  true のとき、デバッグモードになり、APIへのリクエストおよびレスポンスのXMLの内容が、アラートボックスに表示される。

Returns

(Object)
(obj).response にAPIからの戻り値のXMLが入る。エラーの場合 (obj).error.code にエラーコード、(obj).error.message にエラーメッセージが入る。

.getRequestToken()

getRequestToken()

リクエストトークンを返す。

.isSSO()

isSSO()

Cookie認証が有効化どうかを返す。

.query()

query(service, method, params, alertIfError, debug)

APIのうち、データ取得系についてのみ実行する。誤ってデータを更新することを防ぐことができる。引数と戻り値は exec と同様。

Arguments

• service
• method
• params
• alertIfError
• debug

.sso()

sso()

Cookie認証を有効にする。

.update()

update(service, method, params, alertIfError, debug)

APIのうち、データ更新系についてのみ実行する。Cookie認証が有効のときデータ更新系ではリクエストトークンが必要となるが、このAPIではリクエストトークンのセットを代行する。

Arguments

• service
• method
• params
• alertIfError
• debug