OneSDK
    Preparing search index...

    Interface Api

    interface Api {
        platform: string;
        activatePlugin(uid: string): Promise<PluginList>;
        addBlock(comment: Comment): void;
        addWaitingList(comment: Comment): Promise<boolean>;
        appendEmptyTimelineItem(): Promise<TimelineItem>;
        appendTimelineItemFromTalkScript(): Promise<null | TimelineItem>;
        backupNow(): Promise<BackupFile>;
        cancelAllWaitingList(): Promise<void>;
        cancelWaitingList(ids: string[]): Promise<OrderItem[]>;
        changeActiveSurvey(activeSurvey: null | ActiveSurvey): void;
        changeBookmark(bookmark: Bookmark): void;
        changePlayings(count: number): Promise<OrderItem[]>;
        changeResultVisible(visible: boolean): void;
        changeServiceOrder(from: number, to: number): void;
        checkIntegration(name: string, ...args: any[]): Promise<any>;
        checkLoginStatus(platforms: (keyof ServiceList)[]): Promise<LoginStates>;
        checkUpdate(): Promise<UpdateCheckResult>;
        cleanUpDB(): Promise<boolean>;
        clearAllCache(): Promise<void>;
        clearAllStockComments(): Promise<void>;
        clearComents(): void;
        clearSurveyResult(surveyId: string, questionId: string): void;
        cloneTemplateResource(dir: string, files: string[]): Promise<string[]>;
        closeWindow(): void;
        completePlayingOrders(): Promise<OrderItem[]>;
        completeSetListItems(id: number, items: number[]): Promise<void>;
        completeTopOrder(): Promise<OrderItem[]>;
        completeWaitingList(ids: string[]): Promise<OrderItem[]>;
        createMusicBox(params: MusicBoxParams): Promise<MusicBox>;
        createReport(): void;
        createService(): Promise<Service>;
        deactivatePlugin(uid: string): Promise<PluginList>;
        decrementPlayingOrder(): Promise<OrderItem[]>;
        deleteComment(id: string): void;
        deleteMusicBox(id: number): Promise<void>;
        deleteMusicList(ids: number[]): Promise<void>;
        deleteRequests(ids: number[]): Promise<RequestItem[]>;
        deleteSetList(id: number): Promise<void>;
        deleteSurvey(surveyId: string): Promise<null | Survey>;
        deleteSurveyAnswer(
            surveyId: string,
            questionId: string,
            label: string,
        ): Promise<SurveyResult>;
        deleteTemplate(templateId: string): Promise<boolean>;
        deleteTemplateResource(dir: string, files: string[]): Promise<string[]>;
        deleteUserData(ids: string[]): void;
        dragFileStart(filename: string): void;
        dragStart(templateData: TemplateData): void;
        dragStaticFile(pathname: string): void;
        endSetList(): void;
        execAnalyze(
            conditions: SearchProps[],
            filters: SearchFilterProps,
        ): Promise<AnalysisResultData>;
        execUpdate(): void;
        generateAPIToken(): Promise<string>;
        getAivisSpeechVoiceList(): Promise<AivisSpeechSpeaker[]>;
        getAllComments(): Promise<Comment[]>;
        getAllMusicList(): Promise<MusicData[]>;
        getAllStockComments(): Promise<Comment[]>;
        getAPIToken(): Promise<string>;
        getBackupFiles(): Promise<BackupFile[]>;
        getBouyomiChanVoiceList(): Promise<BouyomiChanVoiceListResponse>;
        getCoeiroinkVoiceList(): Promise<CoeiroinkSpeaker[]>;
        getConfig(): Promise<Config>;
        getCurrentSetListId(): Promise<number>;
        getDictionary(): Promise<
            { speech: SpeechDictionaryConfig; word: WordDictionaryConfig },
        >;
        getExistsLogDates(
            year: number,
            month: number,
        ): Promise<{ date: string; has_data: number }[]>;
        getFavorites(): Promise<string[]>;
        getFilePath(file: File): string;
        getFontList(): Promise<string[]>;
        getListeners(): Promise<ListenerInfo[]>;
        getLocale(): Promise<string>;
        getLoginStatus(): Promise<LoginStates>;
        getMusicBoxList(): Promise<MusicBox[]>;
        getMusicList(boxId: number): Promise<MusicData[]>;
        getNews(): Promise<NewsData>;
        getOrderStats(): Promise<OrderStats>;
        getPlugins(): Promise<PluginList>;
        getQuizResult(surveyId: string): Promise<QuizResult>;
        getRequests(): Promise<RequestItem[]>;
        getServerInfo(): Promise<ServerInfo>;
        getService(serviceId: string): Promise<null | Service>;
        getServices(): Promise<Service[]>;
        getSetList(id: number): Promise<SetList>;
        getSetLists(): Promise<SetListArray[]>;
        getSurveyResult(
            surveyId: string,
            questionId: string,
        ): Promise<SurveyResult>;
        getSurveyResultAll(surveyId: string): Promise<SurveyResults>;
        getSurveys(): Promise<Survey[]>;
        getTemplateList(): Promise<TemplateData[]>;
        getTemplatePath(): Promise<string>;
        getTimestamps(): Promise<TimestampData>;
        getUserCommentHistory(
            userId: string,
            limit?: number,
            offset?: number,
        ): Promise<Comment[]>;
        getUserCurrentComments(userId: string): Promise<Comment[]>;
        getUserData(id: string): Promise<UserNameData>;
        getUserDatas(): Promise<UserStoreData>;
        getVersion(): Promise<string>;
        getVoicevoxVoiceList(): Promise<VoicevoxSpeaker[]>;
        getWaitingList(): Promise<OrderItem[]>;
        getYNCRegistry(): Promise<null | YNCNeoRegistoryData>;
        getYNCVoiceList(): Promise<string[]>;
        incrementPlayingOrder(): Promise<OrderItem[]>;
        insertLogs(): Promise<boolean>;
        insertMusicList(boxId: number, params: MusicDataParams): Promise<RunResult>;
        insertSetList(name: string): Promise<SetList>;
        insertSetListItem(id: number, itemId: number): Promise<void>;
        isProMode(): Promise<{ key: string; proMode: boolean; type: string }>;
        joinSurveyAnswers(
            surveyId: string,
            questionId: string,
            from: string,
            to: string,
        ): Promise<SurveyResult>;
        loadWordParty(): void;
        maximizeWindow(): void;
        minimizeWindow(): void;
        openAnalysisWindow(): void;
        openAppDirectory(): void;
        openBrowserWindow(url: string): Promise<void>;
        openChatWindow(serviceId: string): void;
        openCommentStock(): void;
        openCommentTester(): void;
        openDictionaryWindow(tab?: string): void;
        openDirectorySelectDialog(): Promise<undefined | string[]>;
        openFolder(path: string): void;
        openGiftWindow(): void;
        openLink(url: string): void;
        openListenersWindow(): void;
        openLogsDirectory(): void;
        openOrderManagerWindow(): void;
        openPluginDirectory(): void;
        openPluginManagerWindow(): void;
        openSetlistManagerWindow(): void;
        openSurveyManager(): void;
        openTemplateWindow(): void;
        openTimeStampTool(): void;
        openUserDirectory(templateName?: string): void;
        openWordPartyWindow(dir: string): void;
        pinComment(comment: null | Comment): void;
        pipMouseEvent(bool: boolean): void;
        prioritizeLowerCount(): Promise<OrderItem[]>;
        prioritizeLowerTotalCount(): Promise<OrderItem[]>;
        receiveBeepSound(
            callback: (file: string, volume: number, deviceId: string) => void,
        ): UnregisterFunction;
        receiveBookmark(callback: (bookmark: Bookmark) => void): UnregisterFunction;
        receiveClearComments(callback: () => void): UnregisterFunction;
        receiveClearMeta(callback: (id: string) => void): UnregisterFunction;
        receiveCommentNotification(
            callback: (data: CommentNotification) => void,
        ): UnregisterFunction;
        receiveComments(
            callback: (
                comments: Comment[],
                listeners: ListenerInfo[],
                options: CommentSenderOption,
            ) => void,
        ): UnregisterFunction;
        receiveConfigUpdate(callback: (config: Config) => void): UnregisterFunction;
        receiveDeleteComment(
            callback: (deleteComment: { id: string; message: string }[]) => void,
        ): UnregisterFunction;
        receiveDeleteUserDatas(
            callback: (ids: string[]) => void,
        ): UnregisterFunction;
        receiveDictionaryUpdate(
            callback: (
                config: { speech: SpeechDictionaryConfig; word: WordDictionaryConfig },
            ) => void,
        ): UnregisterFunction;
        receiveInvokeSpeech(
            callback: (
                buf: ArrayBuffer,
                deviceId: string,
                volume: number,
                callback: () => void,
            ) => void,
        ): UnregisterFunction;
        receiveLoadWordParty(
            callback: (data: WordPartyResponse) => void,
        ): UnregisterFunction;
        receiveNotification(
            callback: (type: string, message: string) => void,
        ): UnregisterFunction;
        receivePageError(
            callback: (error: ServiceError) => void,
        ): UnregisterFunction;
        receivePinned(
            callback: (comment: null | Comment) => void,
        ): UnregisterFunction;
        receiveProgress(callback: (message: string) => void): UnregisterFunction;
        receiveReactions(
            callback: (reactions: Reaction[]) => void,
        ): UnregisterFunction;
        receiveRequests(
            callback: (requests: RequestItem[]) => void,
        ): UnregisterFunction;
        receiveServices(
            callback: (services: Service[]) => void,
        ): UnregisterFunction;
        receiveSetList(callback: (data: SetList) => void): UnregisterFunction;
        receiveSpeech(
            callback: (text: string, config: SpeechConfig) => void,
        ): UnregisterFunction;
        receiveStockComments(
            callback: (data: Comment[]) => void,
        ): UnregisterFunction;
        receiveStopSpeech(callback: () => void): UnregisterFunction;
        receiveSurveyResult(
            callback: (result: SurveyResult) => void,
        ): UnregisterFunction;
        receiveTimestamps(
            callback: (data: TimestampData) => void,
        ): UnregisterFunction;
        receiveUpdate(
            callback: (info: UpdateCheckResult) => void,
        ): UnregisterFunction;
        receiveUpdateMeta(
            callback: (id: string, meta: ServiceMeta) => void,
        ): UnregisterFunction;
        receiveUpdateUserDatas(
            callback: (userData: UserStoreData) => void,
        ): UnregisterFunction;
        receiveWatings(
            callback: (orders: OrderItem[], stats: OrderStats) => void,
        ): UnregisterFunction;
        reloladPlugins(): Promise<PluginList>;
        removeService(service: Service): void;
        resetResultView(): void;
        resetSettings(type: keyof Config): void;
        resetTotalOrderCount(): Promise<boolean>;
        resetWindowPosition(): Promise<void>;
        restoreBackup(path: string): Promise<boolean>;
        rewriteOrderFile(): void;
        rewriteSetListTemplate(): void;
        rewriteSetListTemplates(): void;
        saveFavorites(names: string[]): Promise<string[]>;
        saveWordPartyConfig(
            dir: string,
            config: WordPartyGlobalConfig,
            items: WordPartyItem[],
        ): Promise<void>;
        searchMusic(name: string): Promise<MusicDataSearchResult[]>;
        sendCorrectAnswer(surveyId: string, questionId: string): void;
        sendQuizResult(surveyId: string): void;
        sendSurveyResult(surveyId: string, questionId: string): void;
        sendTestComment(comment: CommentData, option: TestCommentOption): void;
        showContextMenu(type: string, ...args: any[]): void;
        showNews(): void;
        shuffleWaitingList(): Promise<OrderItem[]>;
        speechPreview(
            comment: string,
            username: string,
            config: SpeechConfig,
        ): void;
        startSetList(id: number): void;
        stockComment(comment: Comment): Promise<void>;
        stopSpeech(): void;
        swapWaitingList(from: number, to: number): Promise<OrderItem[]>;
        togglePip(): void;
        toggleSecretMode(): Promise<boolean>;
        translateComment(lang: string, comment: Comment): void;
        unstockComments(ids: string[]): Promise<void>;
        updateConfig(config: RecursivePartial<Config>): Promise<Config>;
        updateLicense(licenseKey: string): void;
        updateMusicBox(id: number, params: MusicBoxParams): Promise<MusicBox>;
        updateMusicList(id: number, params: MusicDataParams): Promise<void>;
        updateOrderItems(items: UpdatableOrderItemProps[]): Promise<OrderItem[]>;
        updateService(service: Service): void;
        updateSetList(id: number, name: string): Promise<void>;
        updateSetListItems(id: number, items: number[]): Promise<void>;
        updateSpeechDictionaryConfig(
            config: Partial<SpeechDictionaryConfig>,
        ): Promise<SpeechDictionaryConfig>;
        updateSurveys(surveys: Survey[]): Promise<Survey[]>;
        updateTimestamps(data: Partial<TimestampData>): Promise<TimestampData>;
        updateUserData(id: string, userData: Partial<UserNameData>): void;
        updateWordDictionaryConfig(
            config: Partial<WordDictionaryConfig>,
        ): Promise<WordDictionaryConfig>;
        uploadTemplate(): Promise<
            { message: string; path?: string; status: "error"
            | "succeeded" },
        >;
        uploadTemplateFile(
            filepath: string,
        ): Promise<
            { message: string; path?: string; status: "error"
            | "succeeded" },
        >;
        uploadTemplateResource(
            dir: string,
            files: { buffer: ArrayBuffer; name: string; type: string }[],
        ): Promise<string[]>;
        wpExec(id: string): void;
    }
    Index

    Properties

    Methods

    activatePlugin addBlock addWaitingList appendEmptyTimelineItem appendTimelineItemFromTalkScript backupNow cancelAllWaitingList cancelWaitingList changeActiveSurvey changeBookmark changePlayings changeResultVisible changeServiceOrder checkIntegration checkLoginStatus checkUpdate cleanUpDB clearAllCache clearAllStockComments clearComents clearSurveyResult cloneTemplateResource closeWindow completePlayingOrders completeSetListItems completeTopOrder completeWaitingList createMusicBox createReport createService deactivatePlugin decrementPlayingOrder deleteComment deleteMusicBox deleteMusicList deleteRequests deleteSetList deleteSurvey deleteSurveyAnswer deleteTemplate deleteTemplateResource deleteUserData dragFileStart dragStart dragStaticFile endSetList execAnalyze execUpdate generateAPIToken getAivisSpeechVoiceList getAllComments getAllMusicList getAllStockComments getAPIToken getBackupFiles getBouyomiChanVoiceList getCoeiroinkVoiceList getConfig getCurrentSetListId getDictionary getExistsLogDates getFavorites getFilePath getFontList getListeners getLocale getLoginStatus getMusicBoxList getMusicList getNews getOrderStats getPlugins getQuizResult getRequests getServerInfo getService getServices getSetList getSetLists getSurveyResult getSurveyResultAll getSurveys getTemplateList getTemplatePath getTimestamps getUserCommentHistory getUserCurrentComments getUserData getUserDatas getVersion getVoicevoxVoiceList getWaitingList getYNCRegistry getYNCVoiceList incrementPlayingOrder insertLogs insertMusicList insertSetList insertSetListItem isProMode joinSurveyAnswers loadWordParty maximizeWindow minimizeWindow openAnalysisWindow openAppDirectory openBrowserWindow openChatWindow openCommentStock openCommentTester openDictionaryWindow openDirectorySelectDialog openFolder openGiftWindow openLink openListenersWindow openLogsDirectory openOrderManagerWindow openPluginDirectory openPluginManagerWindow openSetlistManagerWindow openSurveyManager openTemplateWindow openTimeStampTool openUserDirectory openWordPartyWindow pinComment pipMouseEvent prioritizeLowerCount prioritizeLowerTotalCount receiveBeepSound receiveBookmark receiveClearComments receiveClearMeta receiveCommentNotification receiveComments receiveConfigUpdate receiveDeleteComment receiveDeleteUserDatas receiveDictionaryUpdate receiveInvokeSpeech receiveLoadWordParty receiveNotification receivePageError receivePinned receiveProgress receiveReactions receiveRequests receiveServices receiveSetList receiveSpeech receiveStockComments receiveStopSpeech receiveSurveyResult receiveTimestamps receiveUpdate receiveUpdateMeta receiveUpdateUserDatas receiveWatings reloladPlugins removeService resetResultView resetSettings resetTotalOrderCount resetWindowPosition restoreBackup rewriteOrderFile rewriteSetListTemplate rewriteSetListTemplates saveFavorites saveWordPartyConfig searchMusic sendCorrectAnswer sendQuizResult sendSurveyResult sendTestComment showContextMenu showNews shuffleWaitingList speechPreview startSetList stockComment stopSpeech swapWaitingList togglePip toggleSecretMode translateComment unstockComments updateConfig updateLicense updateMusicBox updateMusicList updateOrderItems updateService updateSetList updateSetListItems updateSpeechDictionaryConfig updateSurveys updateTimestamps updateUserData updateWordDictionaryConfig uploadTemplate uploadTemplateFile uploadTemplateResource wpExec

    Properties

    platform: string

    Methods

    • Parameters

      Returns void

    • Parameters

      Returns Promise<boolean>

    • Returns Promise<void>

    • Parameters

      • ids: string[]

      Returns Promise<OrderItem[]>

    • Parameters

      Returns void

    • Parameters

      • count: number

      Returns Promise<OrderItem[]>

    • Parameters

      • visible: boolean

      Returns void

    • Parameters

      • from: number
      • to: number

      Returns void

    • Parameters

      • name: string
      • ...args: any[]

      Returns Promise<any>

    • Returns Promise<boolean>

    • Returns Promise<void>

    • Returns Promise<void>

    • Returns void

    • Parameters

      • surveyId: string
      • questionId: string

      Returns void

    • Parameters

      • dir: string
      • files: string[]

      Returns Promise<string[]>

    • Returns void

    • Parameters

      • id: number
      • items: number[]

      Returns Promise<void>

    • Parameters

      • ids: string[]

      Returns Promise<OrderItem[]>

    • Returns void

    • Parameters

      • id: string

      Returns void

    • Parameters

      • id: number

      Returns Promise<void>

    • Parameters

      • ids: number[]

      Returns Promise<void>

    • Parameters

      • id: number

      Returns Promise<void>

    • Parameters

      • surveyId: string

      Returns Promise<null | Survey>

    • Parameters

      • surveyId: string
      • questionId: string
      • label: string

      Returns Promise<SurveyResult>

    • Parameters

      • templateId: string

      Returns Promise<boolean>

    • Parameters

      • dir: string
      • files: string[]

      Returns Promise<string[]>

    • Parameters

      • ids: string[]

      Returns void

    • Parameters

      • filename: string

      Returns void

    • Parameters

      • pathname: string

      Returns void

    • Returns void

    • Returns void

    • Returns Promise<string>

    • Returns Promise<string>

    • Returns Promise<number>

    • Parameters

      • year: number
      • month: number

      Returns Promise<{ date: string; has_data: number }[]>

    • Returns Promise<string[]>

    • Parameters

      • file: File

      Returns string

    • Returns Promise<string[]>

    • Returns Promise<string>

    • Parameters

      • boxId: number

      Returns Promise<MusicData[]>

    • Parameters

      • surveyId: string

      Returns Promise<QuizResult>

    • Parameters

      • serviceId: string

      Returns Promise<null | Service>

    • Parameters

      • id: number

      Returns Promise<SetList>

    • Parameters

      • surveyId: string
      • questionId: string

      Returns Promise<SurveyResult>

    • Returns Promise<string>

    • Parameters

      • userId: string
      • Optionallimit: number
      • Optionaloffset: number

      Returns Promise<Comment[]>

    • Parameters

      • userId: string

      Returns Promise<Comment[]>

    • Returns Promise<string>

    • Returns Promise<string[]>

    • Returns Promise<boolean>

    • Parameters

      • name: string

      Returns Promise<SetList>

    • Parameters

      • id: number
      • itemId: number

      Returns Promise<void>

    • Returns Promise<{ key: string; proMode: boolean; type: string }>

    • Parameters

      • surveyId: string
      • questionId: string
      • from: string
      • to: string

      Returns Promise<SurveyResult>

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • url: string

      Returns Promise<void>

    • Parameters

      • serviceId: string

      Returns void

    • Returns void

    • Returns void

    • Parameters

      • Optionaltab: string

      Returns void

    • Returns Promise<undefined | string[]>

    • Parameters

      • path: string

      Returns void

    • Returns void

    • Parameters

      • url: string

      Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • OptionaltemplateName: string

      Returns void

    • Parameters

      • dir: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      • bool: boolean

      Returns void

    • Parameters

      • callback: (file: string, volume: number, deviceId: string) => void

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      • callback: () => void

      Returns UnregisterFunction

    • Parameters

      • callback: (id: string) => void

      Returns UnregisterFunction

    • Parameters

      • callback: (config: Config) => void

      Returns UnregisterFunction

    • Parameters

      • callback: (deleteComment: { id: string; message: string }[]) => void

      Returns UnregisterFunction

    • Parameters

      • callback: (ids: string[]) => void

      Returns UnregisterFunction

    • Parameters

      • callback: (
            buf: ArrayBuffer,
            deviceId: string,
            volume: number,
            callback: () => void,
        ) => void

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      • callback: (type: string, message: string) => void

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      • callback: (comment: null | Comment) => void

      Returns UnregisterFunction

    • Parameters

      • callback: (message: string) => void

      Returns UnregisterFunction

    • Parameters

      • callback: (reactions: Reaction[]) => void

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      • callback: (services: Service[]) => void

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      • callback: (data: Comment[]) => void

      Returns UnregisterFunction

    • Parameters

      • callback: () => void

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      Returns UnregisterFunction

    • Parameters

      Returns void

    • Returns void

    • Parameters

      Returns void

    • Returns Promise<boolean>

    • Returns Promise<void>

    • Parameters

      • path: string

      Returns Promise<boolean>

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • names: string[]

      Returns Promise<string[]>

    • Parameters

      • surveyId: string
      • questionId: string

      Returns void

    • Parameters

      • surveyId: string

      Returns void

    • Parameters

      • surveyId: string
      • questionId: string

      Returns void

    • Parameters

      • type: string
      • ...args: any[]

      Returns void

    • Returns void

    • Parameters

      Returns void

    • Parameters

      • id: number

      Returns void

    • Parameters

      Returns Promise<void>

    • Returns void

    • Parameters

      • from: number
      • to: number

      Returns Promise<OrderItem[]>

    • Returns void

    • Returns Promise<boolean>

    • Parameters

      Returns void

    • Parameters

      • ids: string[]

      Returns Promise<void>

    • Parameters

      • licenseKey: string

      Returns void

    • Parameters

      Returns void

    • Parameters

      • id: number
      • name: string

      Returns Promise<void>

    • Parameters

      • id: number
      • items: number[]

      Returns Promise<void>

    • Parameters

      Returns void

    • Returns Promise<{ message: string; path?: string; status: "error" | "succeeded" }>

    • Parameters

      • filepath: string

      Returns Promise<{ message: string; path?: string; status: "error" | "succeeded" }>

    • Parameters

      • dir: string
      • files: { buffer: ArrayBuffer; name: string; type: string }[]

      Returns Promise<string[]>

    • Parameters

      • id: string

      Returns void