Interface Api

interface Api {
    platform: string;
    activatePlugin(uid): Promise<PluginList>;
    addBlock(comment): void;
    addWaitingList(comment): Promise<boolean>;
    backupNow(): Promise<BackupFile>;
    cancelWaitingList(ids): Promise<OrderItem[]>;
    changeActiveSurvey(activeSurvey): void;
    changeBookmark(bookmark): void;
    changePlayings(count): Promise<OrderItem[]>;
    changeResultVisible(visible): void;
    changeServiceOrder(from, to): void;
    changeThemeTemporarily(mode): void;
    checkIntegration(name, ...args): Promise<any>;
    checkLoginStatus(platforms): Promise<LoginStates>;
    checkUpdate(): Promise<UpdateCheckResult>;
    clearAllCache(): Promise<void>;
    clearAllStockComments(): Promise<void>;
    clearComents(): void;
    clearSurveyResult(surveyId, questionId): void;
    cloneTemplateResource(dir, files): Promise<string[]>;
    closeWindow(): void;
    completePlayingOrders(): Promise<OrderItem[]>;
    completeSetListItems(id, items): Promise<void>;
    completeTopOrder(): Promise<OrderItem[]>;
    completeWaitingList(ids): Promise<OrderItem[]>;
    createMusicBox(params): Promise<MusicBox>;
    createReport(): void;
    createService(): Promise<Service>;
    deactivatePlugin(uid): Promise<PluginList>;
    decrementPlayingOrder(): Promise<OrderItem[]>;
    deleteComment(id): void;
    deleteMusicBox(id): Promise<void>;
    deleteMusicList(ids): Promise<void>;
    deleteRequests(ids): Promise<RequestItem[]>;
    deleteSetList(id): Promise<void>;
    deleteSurvey(surveyId): Promise<null | Survey>;
    deleteSurveyAnswer(surveyId, questionId, label): Promise<SurveyResult>;
    deleteTemplate(templateId): Promise<boolean>;
    deleteTemplateResource(dir, files): Promise<string[]>;
    deleteUserData(ids): void;
    downloadUpdate(): void;
    dragFileStart(filename): void;
    dragStart(templateData): void;
    dragStaticFile(pathname): void;
    endSetList(): void;
    execAnalyze(conditions, filters): Promise<AnalysisResultData>;
    generateAPIToken(): Promise<string>;
    getAPIToken(): Promise<string>;
    getAllComments(): Promise<Comment[]>;
    getAllMusicList(): Promise<MusicData[]>;
    getAllStockComments(): Promise<Comment[]>;
    getBackupFiles(): Promise<BackupFile[]>;
    getBouyomiChanVoiceList(): Promise<BouyomiChanVoiceListResponse>;
    getCommentLogFiles(): Promise<CommentLogFile[]>;
    getConfig(): Promise<Config>;
    getCurrentSetListId(): Promise<number>;
    getFavorites(): Promise<string[]>;
    getFontList(): Promise<string[]>;
    getListeners(): Promise<ListenerInfo[]>;
    getLocale(): Promise<string>;
    getLoginStatus(): Promise<LoginStates>;
    getMusicBoxList(): Promise<MusicBox[]>;
    getMusicList(boxId): Promise<MusicData[]>;
    getNews(): Promise<NewsData>;
    getOrderStats(): Promise<OrderStats>;
    getPlugins(): Promise<PluginList>;
    getQuizResult(surveyId): Promise<QuizResult>;
    getRequests(): Promise<RequestItem[]>;
    getServerInfo(): Promise<ServerInfo>;
    getServices(): Promise<Service[]>;
    getSetList(id): Promise<SetList>;
    getSetLists(): Promise<SetListArray[]>;
    getSurveyResult(surveyId, questionId): Promise<SurveyResult>;
    getSurveyResultAll(surveyId): Promise<SurveyResults>;
    getSurveys(): Promise<Survey[]>;
    getTemplateList(): Promise<TemplateData[]>;
    getTemplatePath(): Promise<string>;
    getUserData(id): Promise<UserNameData>;
    getUserDatas(): Promise<UserStoreData>;
    getVersion(): Promise<string>;
    getWaitingList(): Promise<OrderItem[]>;
    getYNCRegistry(): Promise<null | YNCNeoRegistoryData>;
    getYNCVoiceList(): Promise<string[]>;
    incrementPlayingOrder(): Promise<OrderItem[]>;
    insertMusicList(boxId, params): Promise<RunResult>;
    insertSetList(name): Promise<SetList>;
    insertSetListItem(id, itemId): Promise<void>;
    isProMode(): Promise<{
        key: string;
        proMode: boolean;
        type: string;
    }>;
    joinSurveyAnswers(surveyId, questionId, from, to): Promise<SurveyResult>;
    loadWordParty(): void;
    maximizeWindow(): void;
    minimizeWindow(): void;
    openAnalysisWindow(): void;
    openAppDirectory(): void;
    openBrowserWindow(url): Promise<void>;
    openChatWindow(serviceId): void;
    openCommentStock(): void;
    openCommentTester(): void;
    openDirectorySelectDialog(): Promise<undefined | string[]>;
    openFolder(path): void;
    openGiftWindow(): void;
    openLink(url): void;
    openListenersWindow(): void;
    openLogsDirectory(): void;
    openOrderManagerWindow(): void;
    openPluginDirectory(): void;
    openPluginManagerWindow(): void;
    openSetlistManagerWindow(): void;
    openSurveyManager(): void;
    openTemplateWindow(): void;
    openUserDirectory(templateName?): void;
    openWordPartyWindow(dir): void;
    pinComment(comment): void;
    prioritizeLowerCount(): Promise<OrderItem[]>;
    prioritizeLowerTotalCount(): Promise<OrderItem[]>;
    receiveBeepSound(callback): UnregisterFunction;
    receiveBookmark(callback): UnregisterFunction;
    receiveClearComments(callback): UnregisterFunction;
    receiveClearMeta(callback): UnregisterFunction;
    receiveCommentNotification(callback): UnregisterFunction;
    receiveComments(callback): UnregisterFunction;
    receiveConfigUpdate(callback): UnregisterFunction;
    receiveDeleteComment(callback): UnregisterFunction;
    receiveDeleteUserDatas(callback): UnregisterFunction;
    receiveLoadWordParty(callback): UnregisterFunction;
    receiveNotification(callback): UnregisterFunction;
    receivePageError(callback): UnregisterFunction;
    receivePinned(callback): UnregisterFunction;
    receiveProgress(callback): UnregisterFunction;
    receiveReactions(callback): UnregisterFunction;
    receiveRequests(callback): UnregisterFunction;
    receiveServices(callback): UnregisterFunction;
    receiveSetList(callback): UnregisterFunction;
    receiveSpeech(callback): UnregisterFunction;
    receiveStockComments(callback): UnregisterFunction;
    receiveStopSpeech(callback): UnregisterFunction;
    receiveSurveyResult(callback): UnregisterFunction;
    receiveUpdateMeta(callback): UnregisterFunction;
    receiveUpdateUserDatas(callback): UnregisterFunction;
    receiveWatings(callback): UnregisterFunction;
    reloladPlugins(): Promise<PluginList>;
    removeService(service): void;
    resetResultView(): void;
    resetSettings(type): void;
    restoreBackup(path): Promise<boolean>;
    rewriteOrderFile(): void;
    rewriteSetListTemplate(): void;
    rewriteSetListTemplates(): void;
    saveFavorites(names): Promise<string[]>;
    saveWordPartyConfig(dir, config, items): Promise<void>;
    searchMusic(name): Promise<MusicDataSearchResult[]>;
    sendCorrectAnswer(surveyId, questionId): void;
    sendQuizResult(surveyId): void;
    sendSurveyResult(surveyId, questionId): void;
    sendTestComment(comment, option): void;
    showContextMenu(type, ...args): void;
    showNews(): void;
    shuffleWaitingList(): Promise<OrderItem[]>;
    speechPreview(comment, username, config): void;
    startSetList(id): void;
    stockComment(comment): Promise<void>;
    stopSpeech(): void;
    swapWaitingList(from, to): Promise<OrderItem[]>;
    toggleSecretMode(): Promise<boolean>;
    translateComment(lang, comment): void;
    unstockComments(ids): Promise<void>;
    updateConfig(config): Promise<Config>;
    updateLicense(licenseKey): void;
    updateMusicBox(id, params): Promise<MusicBox>;
    updateMusicList(id, params): Promise<void>;
    updateOrderItems(items): Promise<OrderItem[]>;
    updateService(service): void;
    updateSetList(id, name): Promise<void>;
    updateSetListItems(id, items): Promise<void>;
    updateSurveys(surveys): Promise<Survey[]>;
    updateUserData(id, userData): void;
    uploadTemplate(): Promise<{
        message: string;
        path?: string;
        status: "error" | "succeeded";
    }>;
    uploadTemplateFile(filepath): Promise<{
        message: string;
        path?: string;
        status: "error" | "succeeded";
    }>;
    uploadTemplateResource(dir, files): Promise<string[]>;
}

Index

Properties

platform

Methods

activatePlugin addBlock addWaitingList backupNow cancelWaitingList changeActiveSurvey changeBookmark changePlayings changeResultVisible changeServiceOrder changeThemeTemporarily checkIntegration checkLoginStatus checkUpdate 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 downloadUpdate dragFileStart dragStart dragStaticFile endSetList execAnalyze generateAPIToken getAPIToken getAllComments getAllMusicList getAllStockComments getBackupFiles getBouyomiChanVoiceList getCommentLogFiles getConfig getCurrentSetListId getFavorites getFontList getListeners getLocale getLoginStatus getMusicBoxList getMusicList getNews getOrderStats getPlugins getQuizResult getRequests getServerInfo getServices getSetList getSetLists getSurveyResult getSurveyResultAll getSurveys getTemplateList getTemplatePath getUserData getUserDatas getVersion getWaitingList getYNCRegistry getYNCVoiceList incrementPlayingOrder insertMusicList insertSetList insertSetListItem isProMode joinSurveyAnswers loadWordParty maximizeWindow minimizeWindow openAnalysisWindow openAppDirectory openBrowserWindow openChatWindow openCommentStock openCommentTester openDirectorySelectDialog openFolder openGiftWindow openLink openListenersWindow openLogsDirectory openOrderManagerWindow openPluginDirectory openPluginManagerWindow openSetlistManagerWindow openSurveyManager openTemplateWindow openUserDirectory openWordPartyWindow pinComment prioritizeLowerCount prioritizeLowerTotalCount receiveBeepSound receiveBookmark receiveClearComments receiveClearMeta receiveCommentNotification receiveComments receiveConfigUpdate receiveDeleteComment receiveDeleteUserDatas receiveLoadWordParty receiveNotification receivePageError receivePinned receiveProgress receiveReactions receiveRequests receiveServices receiveSetList receiveSpeech receiveStockComments receiveStopSpeech receiveSurveyResult receiveUpdateMeta receiveUpdateUserDatas receiveWatings reloladPlugins removeService resetResultView resetSettings restoreBackup rewriteOrderFile rewriteSetListTemplate rewriteSetListTemplates saveFavorites saveWordPartyConfig searchMusic sendCorrectAnswer sendQuizResult sendSurveyResult sendTestComment showContextMenu showNews shuffleWaitingList speechPreview startSetList stockComment stopSpeech swapWaitingList toggleSecretMode translateComment unstockComments updateConfig updateLicense updateMusicBox updateMusicList updateOrderItems updateService updateSetList updateSetListItems updateSurveys updateUserData uploadTemplate uploadTemplateFile uploadTemplateResource

Properties

platform

platform: string

Methods

activatePlugin

activatePlugin(uid): Promise<PluginList>
Parameters
- uid: string
Returns Promise<PluginList>

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

changePlayings

changePlayings(count): Promise<OrderItem[]>
Parameters
- 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>

checkLoginStatus

checkLoginStatus(platforms): Promise<LoginStates>
Parameters
- platforms: (keyof ServiceList)[]
Returns Promise<LoginStates>

checkUpdate

checkUpdate(): Promise<UpdateCheckResult>
Returns Promise<UpdateCheckResult>

clearAllCache

clearAllCache(): Promise<void>
Returns Promise<void>

clearAllStockComments

clearAllStockComments(): Promise<void>
Returns Promise<void>

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

completePlayingOrders

completePlayingOrders(): Promise<OrderItem[]>
Returns Promise<OrderItem[]>

completeSetListItems

completeSetListItems(id, items): Promise<void>
Parameters
- id: number
- items: number[]
Returns Promise<void>

completeTopOrder

completeTopOrder(): Promise<OrderItem[]>
Returns Promise<OrderItem[]>

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>

deactivatePlugin

deactivatePlugin(uid): Promise<PluginList>
Parameters
- uid: string
Returns Promise<PluginList>

decrementPlayingOrder

decrementPlayingOrder(): Promise<OrderItem[]>
Returns Promise<OrderItem[]>

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>

deleteRequests

deleteRequests(ids): Promise<RequestItem[]>
Parameters
- ids: number[]
Returns Promise<RequestItem[]>

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, filters): Promise<AnalysisResultData>
Parameters
- conditions: SearchProps[]
- filters: SearchFilterProps
Returns Promise<AnalysisResultData>

generateAPIToken

generateAPIToken(): Promise<string>
Returns Promise<string>

getAPIToken

getAPIToken(): Promise<string>
Returns Promise<string>

getAllComments

getAllComments(): Promise<Comment[]>
Returns Promise<Comment[]>

getAllMusicList

getAllMusicList(): Promise<MusicData[]>
Returns Promise<MusicData[]>

getAllStockComments

getAllStockComments(): Promise<Comment[]>
Returns Promise<Comment[]>

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<LoginStates>
Returns Promise<LoginStates>

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>

getOrderStats

getOrderStats(): Promise<OrderStats>
Returns Promise<OrderStats>

getPlugins

getPlugins(): Promise<PluginList>
Returns Promise<PluginList>

getQuizResult

getQuizResult(surveyId): Promise<QuizResult>
Parameters
- surveyId: string
Returns Promise<QuizResult>

getRequests

getRequests(): Promise<RequestItem[]>
Returns Promise<RequestItem[]>

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>

getUserData

getUserData(id): Promise<UserNameData>
Parameters
- id: string
Returns Promise<UserNameData>

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[]>

incrementPlayingOrder

incrementPlayingOrder(): Promise<OrderItem[]>
Returns Promise<OrderItem[]>

insertMusicList

insertMusicList(boxId, params): Promise<RunResult>
Parameters
- boxId: number
- params: MusicDataParams
Returns Promise<RunResult>

insertSetList

insertSetList(name): Promise<SetList>
Parameters
- name: string
Returns Promise<SetList>

insertSetListItem

insertSetListItem(id, itemId): Promise<void>
Parameters
- id: number
- itemId: number
Returns Promise<void>

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

openCommentStock

openCommentStock(): void
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

openGiftWindow

openGiftWindow(): void
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

openPluginDirectory

openPluginDirectory(): void
Returns void

openPluginManagerWindow

openPluginManagerWindow(): 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[]>

prioritizeLowerTotalCount

prioritizeLowerTotalCount(): 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

receiveClearComments

receiveClearComments(callback): UnregisterFunction
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns UnregisterFunction

receiveClearMeta

receiveClearMeta(callback): UnregisterFunction
Parameters
- callback: ((id) => void)
  - - (id): void
    - Parameters
      id: string
      Returns void
Returns UnregisterFunction

receiveCommentNotification

receiveCommentNotification(callback): UnregisterFunction
Parameters
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: CommentNotification
      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

receiveRequests

receiveRequests(callback): UnregisterFunction
Parameters
- callback: ((requests) => void)
  - - (requests): void
    - Parameters
      requests: RequestItem[]
      Returns void
Returns UnregisterFunction

receiveServices

receiveServices(callback): UnregisterFunction
Parameters
- callback: ((services) => void)
  - - (services): void
    - Parameters
      services: Service[]
      Returns void
Returns UnregisterFunction

receiveSetList

receiveSetList(callback): UnregisterFunction
Parameters
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: SetList
      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

receiveStockComments

receiveStockComments(callback): UnregisterFunction
Parameters
- callback: ((data) => void)
  - - (data): void
    - Parameters
      data: Comment[]
      Returns void
Returns UnregisterFunction

receiveStopSpeech

receiveStopSpeech(callback): UnregisterFunction
Parameters
- callback: (() => void)
  - - (): void
    - 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, stats) => void)
  - - (orders, stats): void
    - Parameters
      orders: OrderItem[]
      stats: OrderStats
      Returns void
Returns UnregisterFunction

reloladPlugins

reloladPlugins(): Promise<PluginList>
Returns Promise<PluginList>

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

rewriteSetListTemplate

rewriteSetListTemplate(): 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>

searchMusic

searchMusic(name): Promise<MusicDataSearchResult[]>
Parameters
- name: string
Returns Promise<MusicDataSearchResult[]>

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

stockComment

stockComment(comment): Promise<void>
Parameters
- comment: Comment
Returns Promise<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

unstockComments

unstockComments(ids): Promise<void>
Parameters
- ids: string[]
Returns Promise<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>

updateOrderItems

updateOrderItems(items): Promise<OrderItem[]>
Parameters
- items: UpdatableOrderItemProps[]
Returns Promise<OrderItem[]>

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[]>

Interface Api

Index

Properties

Methods

Properties

platform

Methods

activatePlugin

Parameters

Returns Promise<PluginList>

addBlock

Parameters

Returns void

addWaitingList

Parameters

Returns Promise<boolean>

backupNow

Returns Promise<BackupFile>

cancelWaitingList

Parameters

Returns Promise<OrderItem[]>

changeActiveSurvey

Parameters

Returns void

changeBookmark

Parameters

Returns void

changePlayings

Parameters

Returns Promise<OrderItem[]>

changeResultVisible

Parameters

Returns void

changeServiceOrder

Parameters

Returns void

changeThemeTemporarily

Parameters

Returns void

checkIntegration

Parameters

Returns Promise<any>

checkLoginStatus

Parameters

Returns Promise<LoginStates>

checkUpdate

Returns Promise<UpdateCheckResult>

clearAllCache

Returns Promise<void>

clearAllStockComments

Returns Promise<void>

clearComents

Returns void

clearSurveyResult

Parameters

Returns void

cloneTemplateResource

Parameters

Returns Promise<string[]>

closeWindow

Returns void

completePlayingOrders

Returns Promise<OrderItem[]>

completeSetListItems

Parameters

Returns Promise<void>

completeTopOrder

Returns Promise<OrderItem[]>

completeWaitingList

Parameters

Returns Promise<OrderItem[]>

createMusicBox

Parameters

Returns Promise<MusicBox>

createReport

Returns void

createService

Returns Promise<Service>

deactivatePlugin

Parameters