Interface Api

platform

addBlock

• addBlock(comment): void

• Parameters

  • comment: Comment

  Returns void

addWaitingList

• addWaitingList(comment): Promise<boolean>

• Parameters

  • comment: Comment

  Returns Promise<boolean>

backupNow

• backupNow(): Promise<BackupFile>

• Returns Promise<BackupFile>

cancelWaitingList

• cancelWaitingList(ids): Promise<OrderItem[]>

• Parameters

  • ids: string[]

  Returns Promise<OrderItem[]>

changeActiveSurvey

• changeActiveSurvey(activeSurvey): void

• Parameters

  • activeSurvey: null | ActiveSurvey

  Returns void

changeBookmark

• changeBookmark(bookmark): void

• Parameters

  • bookmark: Bookmark

  Returns void

changeOrderItemCount

• changeOrderItemCount(orderId, count): Promise<OrderItem[]>

• Parameters

  • orderId: string

  • count: number

  Returns Promise<OrderItem[]>

changeResultVisible

• changeResultVisible(visible): void

• Parameters

  • visible: boolean

  Returns void

changeServiceOrder

• changeServiceOrder(from, to): void

• Parameters

  • from: number

  • to: number

  Returns void

changeThemeTemporarily

• changeThemeTemporarily(mode): void

• Parameters

  • mode: "light" | "dark"

  Returns void

checkIntegration

• checkIntegration(name, ...args): Promise<any>

• Parameters

  • name: string

  • Rest ...args: any[]

  Returns Promise<any>

checkUpdate

• checkUpdate(): Promise<UpdateCheckResult>

• Returns Promise<UpdateCheckResult>

clearComents

• clearComents(): void

• Returns void

clearSurveyResult

• clearSurveyResult(surveyId, questionId): void

• Parameters

  • surveyId: string

  • questionId: string

  Returns void

cloneTemplateResource

• cloneTemplateResource(dir, files): Promise<string[]>

• Parameters

  • dir: string

  • files: string[]

  Returns Promise<string[]>

closeWindow

• closeWindow(): void

• Returns void

completeSetListItems

• completeSetListItems(id, items): Promise<void>

• Parameters

  • id: number

  • items: number[]

  Returns Promise<void>

completeWaitingList

• completeWaitingList(ids): Promise<OrderItem[]>

• Parameters

  • ids: string[]

  Returns Promise<OrderItem[]>

createMusicBox

• createMusicBox(params): Promise<MusicBox>

• Parameters

  • params: MusicBoxParams

  Returns Promise<MusicBox>

createReport

• createReport(): void

• Returns void

createService

• createService(): Promise<Service>

• Returns Promise<Service>

deleteComment

• deleteComment(id): void

• Parameters

  • id: string

  Returns void

deleteMusicBox

• deleteMusicBox(id): Promise<void>

• Parameters

  • id: number

  Returns Promise<void>

deleteMusicList

• deleteMusicList(ids): Promise<void>

• Parameters

  • ids: number[]

  Returns Promise<void>

deleteSetList

• deleteSetList(id): Promise<void>

• Parameters

  • id: number

  Returns Promise<void>

deleteSurvey

• deleteSurvey(surveyId): Promise<null | Survey>

• Parameters

  • surveyId: string

  Returns Promise<null | Survey>

deleteSurveyAnswer

• deleteSurveyAnswer(surveyId, questionId, label): Promise<SurveyResult>

• Parameters

  • surveyId: string

  • questionId: string

  • label: string

  Returns Promise<SurveyResult>

deleteTemplate

• deleteTemplate(templateId): Promise<boolean>

• Parameters

  • templateId: string

  Returns Promise<boolean>

deleteTemplateResource

• deleteTemplateResource(dir, files): Promise<string[]>

• Parameters

  • dir: string

  • files: string[]

  Returns Promise<string[]>

deleteUserData

• deleteUserData(ids): void

• Parameters

  • ids: string[]

  Returns void

downloadUpdate

• downloadUpdate(): void

• Returns void

dragFileStart

• dragFileStart(filename): void

• Parameters

  • filename: string

  Returns void

dragStart

• dragStart(templateData): void

• Parameters

  • templateData: TemplateData

  Returns void

dragStaticFile

• dragStaticFile(pathname): void

• Parameters

  • pathname: string

  Returns void

endSetList

• endSetList(): void

• Returns void

execAnalyze

• execAnalyze(conditions): Promise<AnalysisResultData>

• Parameters

  • conditions: SearchProps[]

  Returns Promise<AnalysisResultData>

generateAPIToken

• generateAPIToken(): Promise<string>

• Returns Promise<string>

getAPIToken

• getAPIToken(): Promise<string>

• Returns Promise<string>

getAllMusicList

• getAllMusicList(): Promise<MusicData[]>

• Returns Promise<MusicData[]>

getBackupFiles

• getBackupFiles(): Promise<BackupFile[]>

• Returns Promise<BackupFile[]>

getBouyomiChanVoiceList

• getBouyomiChanVoiceList(): Promise<BouyomiChanVoiceListResponse>

• Returns Promise<BouyomiChanVoiceListResponse>

getCommentLogFiles

• getCommentLogFiles(): Promise<CommentLogFile[]>

• Returns Promise<CommentLogFile[]>

getConfig

• getConfig(): Promise<Config>

• Returns Promise<Config>

getCurrentSetListId

• getCurrentSetListId(): Promise<number>

• Returns Promise<number>

getFavorites

• getFavorites(): Promise<string[]>

• Returns Promise<string[]>

getFontList

• getFontList(): Promise<string[]>

• Returns Promise<string[]>

getListeners

• getListeners(): Promise<ListenerInfo[]>

• Returns Promise<ListenerInfo[]>

getLocale

• getLocale(): Promise<string>

• Returns Promise<string>

getLoginStatus

• getLoginStatus(): Promise<LoginStatus>

• Returns Promise<LoginStatus>

getMusicBoxList

• getMusicBoxList(): Promise<MusicBox[]>

• Returns Promise<MusicBox[]>

getMusicList

• getMusicList(boxId): Promise<MusicData[]>

• Parameters

  • boxId: number

  Returns Promise<MusicData[]>

getNews

• getNews(): Promise<NewsData>

• Returns Promise<NewsData>

getQuizResult

• getQuizResult(surveyId): Promise<QuizResult>

• Parameters

  • surveyId: string

  Returns Promise<QuizResult>

getServerInfo

• getServerInfo(): Promise<ServerInfo>

• Returns Promise<ServerInfo>

getServices

• getServices(): Promise<Service[]>

• Returns Promise<Service[]>

getSetList

• getSetList(id): Promise<SetList>

• Parameters

  • id: number

  Returns Promise<SetList>

getSetLists

• getSetLists(): Promise<SetListArray[]>

• Returns Promise<SetListArray[]>

getSurveyResult

• getSurveyResult(surveyId, questionId): Promise<SurveyResult>

• Parameters

  • surveyId: string

  • questionId: string

  Returns Promise<SurveyResult>

getSurveyResultAll

• getSurveyResultAll(surveyId): Promise<SurveyResults>

• Parameters

  • surveyId: string

  Returns Promise<SurveyResults>

getSurveys

• getSurveys(): Promise<Survey[]>

• Returns Promise<Survey[]>

getTemplateList

• getTemplateList(): Promise<TemplateData[]>

• Returns Promise<TemplateData[]>

getTemplatePath

• getTemplatePath(): Promise<string>

• Returns Promise<string>

getUserDatas

• getUserDatas(): Promise<UserStoreData>

• Returns Promise<UserStoreData>

getVersion

• getVersion(): Promise<string>

• Returns Promise<string>

getWaitingList

• getWaitingList(): Promise<OrderItem[]>

• Returns Promise<OrderItem[]>

getYNCRegistry

• getYNCRegistry(): Promise<null | YNCNeoRegistoryData>

• Returns Promise<null | YNCNeoRegistoryData>

getYNCVoiceList

• getYNCVoiceList(): Promise<string[]>

• Returns Promise<string[]>

insertMusicList

• insertMusicList(boxId, params): Promise<void>

• Parameters

  • boxId: number

  • params: MusicDataParams

  Returns Promise<void>

insertSetList

• insertSetList(name): Promise<SetList>

• Parameters

  • name: string

  Returns Promise<SetList>

isProMode

• isProMode(): Promise<{
      key: string;
      proMode: boolean;
      type: string;
  }>

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

joinSurveyAnswers

• joinSurveyAnswers(surveyId, questionId, from, to): Promise<SurveyResult>

• Parameters

  • surveyId: string

  • questionId: string

  • from: string

  • to: string

  Returns Promise<SurveyResult>

loadWordParty

• loadWordParty(): void

• Returns void

maximizeWindow

• maximizeWindow(): void

• Returns void

minimizeWindow

• minimizeWindow(): void

• Returns void

openAnalysisWindow

• openAnalysisWindow(): void

• Returns void

openAppDirectory

• openAppDirectory(): void

• Returns void

openBrowserWindow

• openBrowserWindow(url): Promise<void>

• Parameters

  • url: string

  Returns Promise<void>

openChatWindow

• openChatWindow(serviceId): void

• Parameters

  • serviceId: string

  Returns void

openCommentTester

• openCommentTester(): void

• Returns void

openDirectorySelectDialog

• openDirectorySelectDialog(): Promise<undefined | string[]>

• Returns Promise<undefined | string[]>

openFolder

• openFolder(path): void

• Parameters

  • path: string

  Returns void

openLink

• openLink(url): void

• Parameters

  • url: string

  Returns void

openListenersWindow

• openListenersWindow(): void

• Returns void

openLogsDirectory

• openLogsDirectory(): void

• Returns void

openOrderManagerWindow

• openOrderManagerWindow(): void

• Returns void

openSetlistManagerWindow

• openSetlistManagerWindow(): void

• Returns void

openSurveyManager

• openSurveyManager(): void

• Returns void

openTemplateWindow

• openTemplateWindow(): void

• Returns void

openUserDirectory

• openUserDirectory(templateName?): void

• Parameters

  • Optional templateName: string

  Returns void

openWordPartyWindow

• openWordPartyWindow(dir): void

• Parameters

  • dir: string

  Returns void

pinComment

• pinComment(comment): void

• Parameters

  • comment: null | Comment

  Returns void

prioritizeLowerCount

• prioritizeLowerCount(): Promise<OrderItem[]>

• Returns Promise<OrderItem[]>

receiveBeepSound

• receiveBeepSound(callback): UnregisterFunction

• Parameters

  • callback: ((file, volume) => void)

    • • (file, volume): void

      • Parameters

        • file: string

        • volume: number

        Returns void

  Returns UnregisterFunction

receiveBookmark

• receiveBookmark(callback): UnregisterFunction

• Parameters

  • callback: ((bookmark) => void)

    • • (bookmark): void

      • Parameters

        • bookmark: Bookmark

        Returns void

  Returns UnregisterFunction

receiveClearMeta

• receiveClearMeta(callback): UnregisterFunction

• Parameters

  • callback: ((id) => void)

    • • (id): void

      • Parameters

        • id: string

        Returns void

  Returns UnregisterFunction

receiveComments

• receiveComments(callback): UnregisterFunction

• Parameters

  • callback: ((comments, listeners, options) => void)

    • • (comments, listeners, options): void

      • Parameters

        • comments: Comment[]

        • listeners: ListenerInfo[]

        • options: CommentSenderOption

        Returns void

  Returns UnregisterFunction

receiveConfigUpdate

• receiveConfigUpdate(callback): UnregisterFunction

• Parameters

  • callback: ((config) => void)

    • • (config): void

      • Parameters

        • config: Config

        Returns void

  Returns UnregisterFunction

receiveDeleteComment

• receiveDeleteComment(callback): UnregisterFunction

• Parameters

  • callback: ((deleteComment) => void)

    • • (deleteComment): void

      • Parameters

        • deleteComment: {
              id: string;
              message: string;
          }[]

        Returns void

  Returns UnregisterFunction

receiveDeleteUserDatas

• receiveDeleteUserDatas(callback): UnregisterFunction

• Parameters

  • callback: ((ids) => void)

    • • (ids): void

      • Parameters

        • ids: string[]

        Returns void

  Returns UnregisterFunction

receiveLoadWordParty

• receiveLoadWordParty(callback): UnregisterFunction

• Parameters

  • callback: ((data) => void)

    • • (data): void

      • Parameters

        • data: WordPartyResponse

        Returns void

  Returns UnregisterFunction

receiveNotification

• receiveNotification(callback): UnregisterFunction

• Parameters

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

    • • (type, message): void

      • Parameters

        • type: string

        • message: string

        Returns void

  Returns UnregisterFunction

receivePageError

• receivePageError(callback): UnregisterFunction

• Parameters

  • callback: ((error) => void)

    • • (error): void

      • Parameters

        • error: ServiceError

        Returns void

  Returns UnregisterFunction

receivePinned

• receivePinned(callback): UnregisterFunction

• Parameters

  • callback: ((comment) => void)

    • • (comment): void

      • Parameters

        • comment: null | Comment

        Returns void

  Returns UnregisterFunction

receiveProgress

• receiveProgress(callback): UnregisterFunction

• Parameters

  • callback: ((message) => void)

    • • (message): void

      • Parameters

        • message: string

        Returns void

  Returns UnregisterFunction

receiveReactions

• receiveReactions(callback): UnregisterFunction

• Parameters

  • callback: ((reactions) => void)

    • • (reactions): void

      • Parameters

        • reactions: Reaction[]

        Returns void

  Returns UnregisterFunction

receiveSpeech

• receiveSpeech(callback): UnregisterFunction

• Parameters

  • callback: ((text, config) => void)

    • • (text, config): void

      • Parameters

        • text: string

        • config: SpeechConfig

        Returns void

  Returns UnregisterFunction

receiveSurveyResult

• receiveSurveyResult(callback): UnregisterFunction

• Parameters

  • callback: ((result) => void)

    • • (result): void

      • Parameters

        • result: SurveyResult

        Returns void

  Returns UnregisterFunction

receiveUpdateMeta

• receiveUpdateMeta(callback): UnregisterFunction

• Parameters

  • callback: ((id, meta) => void)

    • • (id, meta): void

      • Parameters

        • id: string

        • meta: ServiceMeta

        Returns void

  Returns UnregisterFunction

receiveUpdateUserDatas

• receiveUpdateUserDatas(callback): UnregisterFunction

• Parameters

  • callback: ((userData) => void)

    • • (userData): void

      • Parameters

        • userData: UserStoreData

        Returns void

  Returns UnregisterFunction

receiveWatings

• receiveWatings(callback): UnregisterFunction

• Parameters

  • callback: ((orders) => void)

    • • (orders): void

      • Parameters

        • orders: OrderItem[]

        Returns void

  Returns UnregisterFunction

removeService

• removeService(service): void

• Parameters

  • service: Service

  Returns void

resetResultView

• resetResultView(): void

• Returns void

resetSettings

• resetSettings(type): void

• Parameters

  • type: keyof Config

  Returns void

restoreBackup

• restoreBackup(path): Promise<boolean>

• Parameters

  • path: string

  Returns Promise<boolean>

rewriteOrderFile

• rewriteOrderFile(): void

• Returns void

rewriteSetListTemplates

• rewriteSetListTemplates(): void

• Returns void

saveFavorites

• saveFavorites(names): Promise<string[]>

• Parameters

  • names: string[]

  Returns Promise<string[]>

saveWordPartyConfig

• saveWordPartyConfig(dir, config, items): Promise<void>

• Parameters

  • dir: string

  • config: GlobalConfig

  • items: WordPartyItem[]

  Returns Promise<void>

sendCorrectAnswer

• sendCorrectAnswer(surveyId, questionId): void

• Parameters

  • surveyId: string

  • questionId: string

  Returns void

sendQuizResult

• sendQuizResult(surveyId): void

• Parameters

  • surveyId: string

  Returns void

sendSurveyResult

• sendSurveyResult(surveyId, questionId): void

• Parameters

  • surveyId: string

  • questionId: string

  Returns void

sendTestComment

• sendTestComment(comment, option): void

• Parameters

  • comment: CommentData

  • option: TestCommentOption

  Returns void

showContextMenu

• showContextMenu(type, ...args): void

• Parameters

  • type: string

  • Rest ...args: any[]

  Returns void

showNews

• showNews(): void

• Returns void

shuffleWaitingList

• shuffleWaitingList(): Promise<OrderItem[]>

• Returns Promise<OrderItem[]>

speechPreview

• speechPreview(comment, username, config): void

• Parameters

  • comment: string

  • username: string

  • config: SpeechConfig

  Returns void

startSetList

• startSetList(id): void

• Parameters

  • id: number

  Returns void

stopSpeech

• stopSpeech(): void

• Returns void

swapWaitingList

• swapWaitingList(from, to): Promise<OrderItem[]>

• Parameters

  • from: number

  • to: number

  Returns Promise<OrderItem[]>

toggleSecretMode

• toggleSecretMode(): Promise<boolean>

• Returns Promise<boolean>

translateComment

• translateComment(lang, comment): void

• Parameters

  • lang: string

  • comment: Comment

  Returns void

updateConfig

• updateConfig(config): Promise<Config>

• Parameters

  • config: RecursivePartial<Config>

  Returns Promise<Config>

updateLicense

• updateLicense(licenseKey): void

• Parameters

  • licenseKey: string

  Returns void

updateMusicBox

• updateMusicBox(id, params): Promise<MusicBox>

• Parameters

  • id: number

  • params: MusicBoxParams

  Returns Promise<MusicBox>

updateMusicList

• updateMusicList(id, params): Promise<void>

• Parameters

  • id: number

  • params: MusicDataParams

  Returns Promise<void>

updateService

• updateService(service): void

• Parameters

  • service: Service

  Returns void

updateSetList

• updateSetList(id, name): Promise<void>

• Parameters

  • id: number

  • name: string

  Returns Promise<void>

updateSetListItems

• updateSetListItems(id, items): Promise<void>

• Parameters

  • id: number

  • items: number[]

  Returns Promise<void>

updateSurveys

• updateSurveys(surveys): Promise<Survey[]>

• Parameters

  • surveys: Survey[]

  Returns Promise<Survey[]>

updateUserData

• updateUserData(id, userData): void

• Parameters

  • id: string

  • userData: Partial<UserNameData>

  Returns void

uploadTemplate

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

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

uploadTemplateFile

• uploadTemplateFile(filepath): Promise<{
      message: string;
      path?: string;
      status: "error" | "succeeded";
  }>

• Parameters

  • filepath: string

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

uploadTemplateResource

• uploadTemplateResource(dir, files): Promise<string[]>

• Parameters

  • dir: string

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

  Returns Promise<string[]>