Repository - ShunMitsuoka/ts-kintone-package GitHub Wiki
kintoneで用意されているapiに関して、以下のRepositoryが対応しています。
オブジェクト | 説明 |
---|---|
KintoneAppRepository | kintoneアプリ情報に対する操作 |
KintoneFieldsRepository | kintoneアプリのフィールドに対する操作 |
KintoneRecordRepository | kintoneアプリのレコードに対する操作 |
KintoneViewRepository | kintoneアプリの一覧に対する操作 |
KintoneUserRepository | kintoneユーザーに対する操作 |
KintonePluginConfigRepository | kintoneプラグインの設定情報に対する操作 |
アプリ情報:KintoneAppRepository
getCurrentAppId()
現在のアプリのAppIdを取得する。
- 引数 : 無し
- 戻り値 :
AppId
getCurrentApp(preview : boolean = false)
現在のアプリ情報を取得する。
- 引数
変数名 | 型 | デフォルト | 説明 |
---|---|---|---|
preview |
boolean | false | 動作テスト環境を対象とするか |
- 戻り値 :
Promise<KintoneApp>
getByAppId(appId: AppId, preview : boolean = false)
対象idのアプリ情報を取得する。
- 引数
変数名 | 型 | デフォルト | 説明 |
---|---|---|---|
appId |
AppId | 取得したいアプリのappId | |
preview |
boolean | false | 動作テスト環境を対象とするか |
- 戻り値 :
Promise<KintoneApp>