cb10-sdk/dist/index.d.ts

Cybozu Office 10 SDK for Node.js

import Transport, { CybozuOfficeOptions, SessionCredentials } from './common/Transport';
import MessageClient from './page/message/MessageClient';
import FileClient from './page/file/FileClient';
import UserClient from './page/user/UserClient';
import FolderClient from './page/folder/FolderClient';
import BulletinClient from './page/bullentin/BulletinClient';
import NotificationClient from './page/notification/NotificationClient';
import ScheduleClient from './page/schedule/ScheduleClient';
export { CybozuOfficeOptions, SessionCredentials };
/**
 * Cybozu Office 10の操作APIを提供するメインクラス
 *
 * このクラスは以下の機能へのアクセスを提供します：
 * - メッセージ管理 ({@link MessageClient})
 * - ファイル管理 ({@link FileClient})
 * - ユーザー管理 ({@link UserClient})
 * - フォルダ管理 ({@link FolderClient})
 * - 掲示板管理 ({@link BulletinClient})
 * - 通知一覧管理 ({@link NotificationClient})
 * - スケジュール管理 ({@link ScheduleClient})
 */
export declare class CybozuOffice {
    /**
     * 内部通信を行うTransportインスタンス
     */
    readonly transport: Transport;
    /**
     * メッセージ管理クライアント
     * メッセージの送信、閲覧、編集などの機能を提供します。
     */
    readonly message: MessageClient;
    /**
     * ファイル管理クライアント
     * ファイルのダウンロードなどの機能を提供します。
     */
    readonly file: FileClient;
    /**
     * ユーザー管理クライアント
     * ユーザー情報の取得などの機能を提供します。
     */
    readonly user: UserClient;
    /**
     * フォルダ管理クライアント
     * 個人フォルダの操作機能を提供します。
     */
    readonly folder: FolderClient;
    /**
     * 掲示板管理クライアント
     * 掲示板の閲覧、投稿などの機能を提供します。
     */
    readonly bulletin: BulletinClient;
    /**
     * 通知一覧クライアント
     * 未読一覧が取得できる機能を提供します。
     */
    readonly notification: NotificationClient;
    /**
     * スケジュール管理クライアント
     * スケジュールのイベント一覧が取得できる機能を提供します。
     */
    readonly schedule: ScheduleClient;
    /**
     * CybozuOfficeのインスタンスを作成します
     *
     * @param options - サイボウズOfficeの接続オプション
     */
    constructor(options: CybozuOfficeOptions);
}