cb10-sdk/dist/page/folder/FolderClient.d.ts

Cybozu Office 10 SDK for Node.js

import Transport from '../../common/Transport';
import { FolderIndexOptions, FolderMessage } from './models';
/**
 * Cybozu Office 10の個人フォルダ機能にアクセスするためのクライアントクラス
 *
 * このクラスは個人フォルダのメッセージ一覧取得などの機能を提供します。
 */
export default class FolderClient {
    private readonly transport;
    constructor(transport: Transport);
    /**
     * 個人フォルダのメッセージ一覧を取得
     *
     * @param options - フォルダ一覧取得オプション
     * @returns メッセージ一覧、一覧が空の場合はnull
     * @throws {CybozuOfficeSDKException} メッセージの取得に失敗した場合
     */
    getMessages({ folderId, reversed }: FolderIndexOptions): Promise<FolderMessage[] | null>;
}