OneSDK
Preparing search index...
types/Api
Api
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
platform
Methods
activate
Plugin
add
Block
add
Waiting
List
append
Empty
Timeline
Item
append
Timeline
Item
From
Talk
Script
backup
Now
cancel
All
Waiting
List
cancel
Waiting
List
change
Active
Survey
change
Bookmark
change
Playings
change
Result
Visible
change
Service
Order
check
Integration
check
Login
Status
check
Update
clean
Up
DB
clear
All
Cache
clear
All
Stock
Comments
clear
Coments
clear
Survey
Result
clone
Template
Resource
close
Window
complete
Playing
Orders
complete
Set
List
Items
complete
Top
Order
complete
Waiting
List
create
Music
Box
create
Report
create
Service
deactivate
Plugin
decrement
Playing
Order
delete
Comment
delete
Music
Box
delete
Music
List
delete
Requests
delete
Set
List
delete
Survey
delete
Survey
Answer
delete
Template
delete
Template
Resource
delete
User
Data
drag
File
Start
drag
Start
drag
Static
File
end
Set
List
exec
Analyze
exec
Update
generate
API
Token
get
Aivis
Speech
Voice
List
get
All
Comments
get
All
Music
List
get
All
Stock
Comments
get
API
Token
get
Backup
Files
get
Bouyomi
Chan
Voice
List
get
Coeiroink
Voice
List
get
Config
get
Current
Set
List
Id
get
Dictionary
get
Exists
Log
Dates
get
Favorites
get
File
Path
get
Font
List
get
Listeners
get
Locale
get
Login
Status
get
Music
Box
List
get
Music
List
get
News
get
Order
Stats
get
Plugins
get
Quiz
Result
get
Requests
get
Server
Info
get
Service
get
Services
get
Set
List
get
Set
Lists
get
Survey
Result
get
Survey
Result
All
get
Surveys
get
Template
List
get
Template
Path
get
Timestamps
get
User
Comment
History
get
User
Current
Comments
get
User
Data
get
User
Datas
get
Version
get
Voicevox
Voice
List
get
Waiting
List
get
YNC
Registry
get
YNC
Voice
List
increment
Playing
Order
insert
Logs
insert
Music
List
insert
Set
List
insert
Set
List
Item
is
Pro
Mode
join
Survey
Answers
load
Word
Party
maximize
Window
minimize
Window
open
Analysis
Window
open
App
Directory
open
Browser
Window
open
Chat
Window
open
Comment
Stock
open
Comment
Tester
open
Dictionary
Window
open
Directory
Select
Dialog
open
Folder
open
Gift
Window
open
Link
open
Listeners
Window
open
Logs
Directory
open
Order
Manager
Window
open
Plugin
Directory
open
Plugin
Manager
Window
open
Setlist
Manager
Window
open
Survey
Manager
open
Template
Window
open
Time
Stamp
Tool
open
User
Directory
open
Word
Party
Window
pin
Comment
pip
Mouse
Event
prioritize
Lower
Count
prioritize
Lower
Total
Count
receive
Beep
Sound
receive
Bookmark
receive
Clear
Comments
receive
Clear
Meta
receive
Comment
Notification
receive
Comments
receive
Config
Update
receive
Delete
Comment
receive
Delete
User
Datas
receive
Dictionary
Update
receive
Invoke
Speech
receive
Load
Word
Party
receive
Notification
receive
Page
Error
receive
Pinned
receive
Progress
receive
Reactions
receive
Requests
receive
Services
receive
Set
List
receive
Speech
receive
Stock
Comments
receive
Stop
Speech
receive
Survey
Result
receive
Timestamps
receive
Update
receive
Update
Meta
receive
Update
User
Datas
receive
Watings
relolad
Plugins
remove
Service
reset
Result
View
reset
Settings
reset
Total
Order
Count
reset
Window
Position
restore
Backup
rewrite
Order
File
rewrite
Set
List
Template
rewrite
Set
List
Templates
save
Favorites
save
Word
Party
Config
search
Music
send
Correct
Answer
send
Quiz
Result
send
Survey
Result
send
Test
Comment
show
Context
Menu
show
News
shuffle
Waiting
List
speech
Preview
start
Set
List
stock
Comment
stop
Speech
swap
Waiting
List
toggle
Pip
toggle
Secret
Mode
translate
Comment
unstock
Comments
update
Config
update
License
update
Music
Box
update
Music
List
update
Order
Items
update
Service
update
Set
List
update
Set
List
Items
update
Speech
Dictionary
Config
update
Surveys
update
Timestamps
update
User
Data
update
Word
Dictionary
Config
upload
Template
upload
Template
File
upload
Template
Resource
wp
Exec
Properties
platform
platform
:
string
Methods
activate
Plugin
activatePlugin
(
uid
:
string
)
:
Promise
<
PluginList
>
Parameters
uid
:
string
Returns
Promise
<
PluginList
>
add
Block
addBlock
(
comment
:
Comment
)
:
void
Parameters
comment
:
Comment
Returns
void
add
Waiting
List
addWaitingList
(
comment
:
Comment
)
:
Promise
<
boolean
>
Parameters
comment
:
Comment
Returns
Promise
<
boolean
>
append
Empty
Timeline
Item
appendEmptyTimelineItem
()
:
Promise
<
TimelineItem
>
Returns
Promise
<
TimelineItem
>
append
Timeline
Item
From
Talk
Script
appendTimelineItemFromTalkScript
()
:
Promise
<
null
|
TimelineItem
>
Returns
Promise
<
null
|
TimelineItem
>
backup
Now
backupNow
()
:
Promise
<
BackupFile
>
Returns
Promise
<
BackupFile
>
cancel
All
Waiting
List
cancelAllWaitingList
()
:
Promise
<
void
>
Returns
Promise
<
void
>
cancel
Waiting
List
cancelWaitingList
(
ids
:
string
[]
)
:
Promise
<
OrderItem
[]
>
Parameters
ids
:
string
[]
Returns
Promise
<
OrderItem
[]
>
change
Active
Survey
changeActiveSurvey
(
activeSurvey
:
null
|
ActiveSurvey
)
:
void
Parameters
activeSurvey
:
null
|
ActiveSurvey
Returns
void
change
Bookmark
changeBookmark
(
bookmark
:
Bookmark
)
:
void
Parameters
bookmark
:
Bookmark
Returns
void
change
Playings
changePlayings
(
count
:
number
)
:
Promise
<
OrderItem
[]
>
Parameters
count
:
number
Returns
Promise
<
OrderItem
[]
>
change
Result
Visible
changeResultVisible
(
visible
:
boolean
)
:
void
Parameters
visible
:
boolean
Returns
void
change
Service
Order
changeServiceOrder
(
from
:
number
,
to
:
number
)
:
void
Parameters
from
:
number
to
:
number
Returns
void
check
Integration
checkIntegration
(
name
:
string
,
...
args
:
any
[]
)
:
Promise
<
any
>
Parameters
name
:
string
...
args
:
any
[]
Returns
Promise
<
any
>
check
Login
Status
checkLoginStatus
(
platforms
:
(
keyof
ServiceList
)
[]
)
:
Promise
<
LoginStates
>
Parameters
platforms
: (
keyof
ServiceList
)
[]
Returns
Promise
<
LoginStates
>
check
Update
checkUpdate
()
:
Promise
<
UpdateCheckResult
>
Returns
Promise
<
UpdateCheckResult
>
clean
Up
DB
cleanUpDB
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
clear
All
Cache
clearAllCache
()
:
Promise
<
void
>
Returns
Promise
<
void
>
clear
All
Stock
Comments
clearAllStockComments
()
:
Promise
<
void
>
Returns
Promise
<
void
>
clear
Coments
clearComents
()
:
void
Returns
void
clear
Survey
Result
clearSurveyResult
(
surveyId
:
string
,
questionId
:
string
)
:
void
Parameters
surveyId
:
string
questionId
:
string
Returns
void
clone
Template
Resource
cloneTemplateResource
(
dir
:
string
,
files
:
string
[]
)
:
Promise
<
string
[]
>
Parameters
dir
:
string
files
:
string
[]
Returns
Promise
<
string
[]
>
close
Window
closeWindow
()
:
void
Returns
void
complete
Playing
Orders
completePlayingOrders
()
:
Promise
<
OrderItem
[]
>
Returns
Promise
<
OrderItem
[]
>
complete
Set
List
Items
completeSetListItems
(
id
:
number
,
items
:
number
[]
)
:
Promise
<
void
>
Parameters
id
:
number
items
:
number
[]
Returns
Promise
<
void
>
complete
Top
Order
completeTopOrder
()
:
Promise
<
OrderItem
[]
>
Returns
Promise
<
OrderItem
[]
>
complete
Waiting
List
completeWaitingList
(
ids
:
string
[]
)
:
Promise
<
OrderItem
[]
>
Parameters
ids
:
string
[]
Returns
Promise
<
OrderItem
[]
>
create
Music
Box
createMusicBox
(
params
:
MusicBoxParams
)
:
Promise
<
MusicBox
>
Parameters
params
:
MusicBoxParams
Returns
Promise
<
MusicBox
>
create
Report
createReport
()
:
void
Returns
void
create
Service
createService
()
:
Promise
<
Service
>
Returns
Promise
<
Service
>
deactivate
Plugin
deactivatePlugin
(
uid
:
string
)
:
Promise
<
PluginList
>
Parameters
uid
:
string
Returns
Promise
<
PluginList
>
decrement
Playing
Order
decrementPlayingOrder
()
:
Promise
<
OrderItem
[]
>
Returns
Promise
<
OrderItem
[]
>
delete
Comment
deleteComment
(
id
:
string
)
:
void
Parameters
id
:
string
Returns
void
delete
Music
Box
deleteMusicBox
(
id
:
number
)
:
Promise
<
void
>
Parameters
id
:
number
Returns
Promise
<
void
>
delete
Music
List
deleteMusicList
(
ids
:
number
[]
)
:
Promise
<
void
>
Parameters
ids
:
number
[]
Returns
Promise
<
void
>
delete
Requests
deleteRequests
(
ids
:
number
[]
)
:
Promise
<
RequestItem
[]
>
Parameters
ids
:
number
[]
Returns
Promise
<
RequestItem
[]
>
delete
Set
List
deleteSetList
(
id
:
number
)
:
Promise
<
void
>
Parameters
id
:
number
Returns
Promise
<
void
>
delete
Survey
deleteSurvey
(
surveyId
:
string
)
:
Promise
<
null
|
Survey
>
Parameters
surveyId
:
string
Returns
Promise
<
null
|
Survey
>
delete
Survey
Answer
deleteSurveyAnswer
(
surveyId
:
string
,
questionId
:
string
,
label
:
string
,
)
:
Promise
<
SurveyResult
>
Parameters
surveyId
:
string
questionId
:
string
label
:
string
Returns
Promise
<
SurveyResult
>
delete
Template
deleteTemplate
(
templateId
:
string
)
:
Promise
<
boolean
>
Parameters
templateId
:
string
Returns
Promise
<
boolean
>
delete
Template
Resource
deleteTemplateResource
(
dir
:
string
,
files
:
string
[]
)
:
Promise
<
string
[]
>
Parameters
dir
:
string
files
:
string
[]
Returns
Promise
<
string
[]
>
delete
User
Data
deleteUserData
(
ids
:
string
[]
)
:
void
Parameters
ids
:
string
[]
Returns
void
drag
File
Start
dragFileStart
(
filename
:
string
)
:
void
Parameters
filename
:
string
Returns
void
drag
Start
dragStart
(
templateData
:
TemplateData
)
:
void
Parameters
templateData
:
TemplateData
Returns
void
drag
Static
File
dragStaticFile
(
pathname
:
string
)
:
void
Parameters
pathname
:
string
Returns
void
end
Set
List
endSetList
()
:
void
Returns
void
exec
Analyze
execAnalyze
(
conditions
:
SearchProps
[]
,
filters
:
SearchFilterProps
,
)
:
Promise
<
AnalysisResultData
>
Parameters
conditions
:
SearchProps
[]
filters
:
SearchFilterProps
Returns
Promise
<
AnalysisResultData
>
exec
Update
execUpdate
()
:
void
Returns
void
generate
API
Token
generateAPIToken
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Aivis
Speech
Voice
List
getAivisSpeechVoiceList
()
:
Promise
<
AivisSpeechSpeaker
[]
>
Returns
Promise
<
AivisSpeechSpeaker
[]
>
get
All
Comments
getAllComments
()
:
Promise
<
Comment
[]
>
Returns
Promise
<
Comment
[]
>
get
All
Music
List
getAllMusicList
()
:
Promise
<
MusicData
[]
>
Returns
Promise
<
MusicData
[]
>
get
All
Stock
Comments
getAllStockComments
()
:
Promise
<
Comment
[]
>
Returns
Promise
<
Comment
[]
>
get
API
Token
getAPIToken
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Backup
Files
getBackupFiles
()
:
Promise
<
BackupFile
[]
>
Returns
Promise
<
BackupFile
[]
>
get
Bouyomi
Chan
Voice
List
getBouyomiChanVoiceList
()
:
Promise
<
BouyomiChanVoiceListResponse
>
Returns
Promise
<
BouyomiChanVoiceListResponse
>
get
Coeiroink
Voice
List
getCoeiroinkVoiceList
()
:
Promise
<
CoeiroinkSpeaker
[]
>
Returns
Promise
<
CoeiroinkSpeaker
[]
>
get
Config
getConfig
()
:
Promise
<
Config
>
Returns
Promise
<
Config
>
get
Current
Set
List
Id
getCurrentSetListId
()
:
Promise
<
number
>
Returns
Promise
<
number
>
get
Dictionary
getDictionary
()
:
Promise
<
{
speech
:
SpeechDictionaryConfig
;
word
:
WordDictionaryConfig
}
,
>
Returns
Promise
<
{
speech
:
SpeechDictionaryConfig
;
word
:
WordDictionaryConfig
}
>
get
Exists
Log
Dates
getExistsLogDates
(
year
:
number
,
month
:
number
,
)
:
Promise
<
{
date
:
string
;
has_data
:
number
}
[]
>
Parameters
year
:
number
month
:
number
Returns
Promise
<
{
date
:
string
;
has_data
:
number
}
[]
>
get
Favorites
getFavorites
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
get
File
Path
getFilePath
(
file
:
File
)
:
string
Parameters
file
:
File
Returns
string
get
Font
List
getFontList
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
get
Listeners
getListeners
()
:
Promise
<
ListenerInfo
[]
>
Returns
Promise
<
ListenerInfo
[]
>
get
Locale
getLocale
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Login
Status
getLoginStatus
()
:
Promise
<
LoginStates
>
Returns
Promise
<
LoginStates
>
get
Music
Box
List
getMusicBoxList
()
:
Promise
<
MusicBox
[]
>
Returns
Promise
<
MusicBox
[]
>
get
Music
List
getMusicList
(
boxId
:
number
)
:
Promise
<
MusicData
[]
>
Parameters
boxId
:
number
Returns
Promise
<
MusicData
[]
>
get
News
getNews
()
:
Promise
<
NewsData
>
Returns
Promise
<
NewsData
>
get
Order
Stats
getOrderStats
()
:
Promise
<
OrderStats
>
Returns
Promise
<
OrderStats
>
get
Plugins
getPlugins
()
:
Promise
<
PluginList
>
Returns
Promise
<
PluginList
>
get
Quiz
Result
getQuizResult
(
surveyId
:
string
)
:
Promise
<
QuizResult
>
Parameters
surveyId
:
string
Returns
Promise
<
QuizResult
>
get
Requests
getRequests
()
:
Promise
<
RequestItem
[]
>
Returns
Promise
<
RequestItem
[]
>
get
Server
Info
getServerInfo
()
:
Promise
<
ServerInfo
>
Returns
Promise
<
ServerInfo
>
get
Service
getService
(
serviceId
:
string
)
:
Promise
<
null
|
Service
>
Parameters
serviceId
:
string
Returns
Promise
<
null
|
Service
>
get
Services
getServices
()
:
Promise
<
Service
[]
>
Returns
Promise
<
Service
[]
>
get
Set
List
getSetList
(
id
:
number
)
:
Promise
<
SetList
>
Parameters
id
:
number
Returns
Promise
<
SetList
>
get
Set
Lists
getSetLists
()
:
Promise
<
SetListArray
[]
>
Returns
Promise
<
SetListArray
[]
>
get
Survey
Result
getSurveyResult
(
surveyId
:
string
,
questionId
:
string
)
:
Promise
<
SurveyResult
>
Parameters
surveyId
:
string
questionId
:
string
Returns
Promise
<
SurveyResult
>
get
Survey
Result
All
getSurveyResultAll
(
surveyId
:
string
)
:
Promise
<
SurveyResults
>
Parameters
surveyId
:
string
Returns
Promise
<
SurveyResults
>
get
Surveys
getSurveys
()
:
Promise
<
Survey
[]
>
Returns
Promise
<
Survey
[]
>
get
Template
List
getTemplateList
()
:
Promise
<
TemplateData
[]
>
Returns
Promise
<
TemplateData
[]
>
get
Template
Path
getTemplatePath
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Timestamps
getTimestamps
()
:
Promise
<
TimestampData
>
Returns
Promise
<
TimestampData
>
get
User
Comment
History
getUserCommentHistory
(
userId
:
string
,
limit
?:
number
,
offset
?:
number
,
)
:
Promise
<
Comment
[]
>
Parameters
userId
:
string
Optional
limit
:
number
Optional
offset
:
number
Returns
Promise
<
Comment
[]
>
get
User
Current
Comments
getUserCurrentComments
(
userId
:
string
)
:
Promise
<
Comment
[]
>
Parameters
userId
:
string
Returns
Promise
<
Comment
[]
>
get
User
Data
getUserData
(
id
:
string
)
:
Promise
<
UserNameData
>
Parameters
id
:
string
Returns
Promise
<
UserNameData
>
get
User
Datas
getUserDatas
()
:
Promise
<
UserStoreData
>
Returns
Promise
<
UserStoreData
>
get
Version
getVersion
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Voicevox
Voice
List
getVoicevoxVoiceList
()
:
Promise
<
VoicevoxSpeaker
[]
>
Returns
Promise
<
VoicevoxSpeaker
[]
>
get
Waiting
List
getWaitingList
()
:
Promise
<
OrderItem
[]
>
Returns
Promise
<
OrderItem
[]
>
get
YNC
Registry
getYNCRegistry
()
:
Promise
<
null
|
YNCNeoRegistoryData
>
Returns
Promise
<
null
|
YNCNeoRegistoryData
>
get
YNC
Voice
List
getYNCVoiceList
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
increment
Playing
Order
incrementPlayingOrder
()
:
Promise
<
OrderItem
[]
>
Returns
Promise
<
OrderItem
[]
>
insert
Logs
insertLogs
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
insert
Music
List
insertMusicList
(
boxId
:
number
,
params
:
MusicDataParams
)
:
Promise
<
RunResult
>
Parameters
boxId
:
number
params
:
MusicDataParams
Returns
Promise
<
RunResult
>
insert
Set
List
insertSetList
(
name
:
string
)
:
Promise
<
SetList
>
Parameters
name
:
string
Returns
Promise
<
SetList
>
insert
Set
List
Item
insertSetListItem
(
id
:
number
,
itemId
:
number
)
:
Promise
<
void
>
Parameters
id
:
number
itemId
:
number
Returns
Promise
<
void
>
is
Pro
Mode
isProMode
()
:
Promise
<
{
key
:
string
;
proMode
:
boolean
;
type
:
string
}
>
Returns
Promise
<
{
key
:
string
;
proMode
:
boolean
;
type
:
string
}
>
join
Survey
Answers
joinSurveyAnswers
(
surveyId
:
string
,
questionId
:
string
,
from
:
string
,
to
:
string
,
)
:
Promise
<
SurveyResult
>
Parameters
surveyId
:
string
questionId
:
string
from
:
string
to
:
string
Returns
Promise
<
SurveyResult
>
load
Word
Party
loadWordParty
()
:
void
Returns
void
maximize
Window
maximizeWindow
()
:
void
Returns
void
minimize
Window
minimizeWindow
()
:
void
Returns
void
open
Analysis
Window
openAnalysisWindow
()
:
void
Returns
void
open
App
Directory
openAppDirectory
()
:
void
Returns
void
open
Browser
Window
openBrowserWindow
(
url
:
string
)
:
Promise
<
void
>
Parameters
url
:
string
Returns
Promise
<
void
>
open
Chat
Window
openChatWindow
(
serviceId
:
string
)
:
void
Parameters
serviceId
:
string
Returns
void
open
Comment
Stock
openCommentStock
()
:
void
Returns
void
open
Comment
Tester
openCommentTester
()
:
void
Returns
void
open
Dictionary
Window
openDictionaryWindow
(
tab
?:
string
)
:
void
Parameters
Optional
tab
:
string
Returns
void
open
Directory
Select
Dialog
openDirectorySelectDialog
()
:
Promise
<
undefined
|
string
[]
>
Returns
Promise
<
undefined
|
string
[]
>
open
Folder
openFolder
(
path
:
string
)
:
void
Parameters
path
:
string
Returns
void
open
Gift
Window
openGiftWindow
()
:
void
Returns
void
open
Link
openLink
(
url
:
string
)
:
void
Parameters
url
:
string
Returns
void
open
Listeners
Window
openListenersWindow
()
:
void
Returns
void
open
Logs
Directory
openLogsDirectory
()
:
void
Returns
void
open
Order
Manager
Window
openOrderManagerWindow
()
:
void
Returns
void
open
Plugin
Directory
openPluginDirectory
()
:
void
Returns
void
open
Plugin
Manager
Window
openPluginManagerWindow
()
:
void
Returns
void
open
Setlist
Manager
Window
openSetlistManagerWindow
()
:
void
Returns
void
open
Survey
Manager
openSurveyManager
()
:
void
Returns
void
open
Template
Window
openTemplateWindow
()
:
void
Returns
void
open
Time
Stamp
Tool
openTimeStampTool
()
:
void
Returns
void
open
User
Directory
openUserDirectory
(
templateName
?:
string
)
:
void
Parameters
Optional
templateName
:
string
Returns
void
open
Word
Party
Window
openWordPartyWindow
(
dir
:
string
)
:
void
Parameters
dir
:
string
Returns
void
pin
Comment
pinComment
(
comment
:
null
|
Comment
)
:
void
Parameters
comment
:
null
|
Comment
Returns
void
pip
Mouse
Event
pipMouseEvent
(
bool
:
boolean
)
:
void
Parameters
bool
:
boolean
Returns
void
prioritize
Lower
Count
prioritizeLowerCount
()
:
Promise
<
OrderItem
[]
>
Returns
Promise
<
OrderItem
[]
>
prioritize
Lower
Total
Count
prioritizeLowerTotalCount
()
:
Promise
<
OrderItem
[]
>
Returns
Promise
<
OrderItem
[]
>
receive
Beep
Sound
receiveBeepSound
(
callback
:
(
file
:
string
,
volume
:
number
,
deviceId
:
string
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
file
:
string
,
volume
:
number
,
deviceId
:
string
)
=>
void
Returns
UnregisterFunction
receive
Bookmark
receiveBookmark
(
callback
:
(
bookmark
:
Bookmark
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
bookmark
:
Bookmark
)
=>
void
Returns
UnregisterFunction
receive
Clear
Comments
receiveClearComments
(
callback
:
()
=>
void
)
:
UnregisterFunction
Parameters
callback
:
()
=>
void
Returns
UnregisterFunction
receive
Clear
Meta
receiveClearMeta
(
callback
:
(
id
:
string
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
id
:
string
)
=>
void
Returns
UnregisterFunction
receive
Comment
Notification
receiveCommentNotification
(
callback
:
(
data
:
CommentNotification
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
data
:
CommentNotification
)
=>
void
Returns
UnregisterFunction
receive
Comments
receiveComments
(
callback
:
(
comments
:
Comment
[]
,
listeners
:
ListenerInfo
[]
,
options
:
CommentSenderOption
,
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
comments
:
Comment
[]
,
listeners
:
ListenerInfo
[]
,
options
:
CommentSenderOption
,
)
=>
void
Returns
UnregisterFunction
receive
Config
Update
receiveConfigUpdate
(
callback
:
(
config
:
Config
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
config
:
Config
)
=>
void
Returns
UnregisterFunction
receive
Delete
Comment
receiveDeleteComment
(
callback
:
(
deleteComment
:
{
id
:
string
;
message
:
string
}
[]
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
deleteComment
:
{
id
:
string
;
message
:
string
}
[]
)
=>
void
Returns
UnregisterFunction
receive
Delete
User
Datas
receiveDeleteUserDatas
(
callback
:
(
ids
:
string
[]
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
ids
:
string
[]
)
=>
void
Returns
UnregisterFunction
receive
Dictionary
Update
receiveDictionaryUpdate
(
callback
:
(
config
:
{
speech
:
SpeechDictionaryConfig
;
word
:
WordDictionaryConfig
}
,
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
config
:
{
speech
:
SpeechDictionaryConfig
;
word
:
WordDictionaryConfig
}
)
=>
void
Returns
UnregisterFunction
receive
Invoke
Speech
receiveInvokeSpeech
(
callback
:
(
buf
:
ArrayBuffer
,
deviceId
:
string
,
volume
:
number
,
callback
:
()
=>
void
,
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
buf
:
ArrayBuffer
,
deviceId
:
string
,
volume
:
number
,
callback
:
()
=>
void
,
)
=>
void
Returns
UnregisterFunction
receive
Load
Word
Party
receiveLoadWordParty
(
callback
:
(
data
:
WordPartyResponse
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
data
:
WordPartyResponse
)
=>
void
Returns
UnregisterFunction
receive
Notification
receiveNotification
(
callback
:
(
type
:
string
,
message
:
string
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
type
:
string
,
message
:
string
)
=>
void
Returns
UnregisterFunction
receive
Page
Error
receivePageError
(
callback
:
(
error
:
ServiceError
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
error
:
ServiceError
)
=>
void
Returns
UnregisterFunction
receive
Pinned
receivePinned
(
callback
:
(
comment
:
null
|
Comment
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
comment
:
null
|
Comment
)
=>
void
Returns
UnregisterFunction
receive
Progress
receiveProgress
(
callback
:
(
message
:
string
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
message
:
string
)
=>
void
Returns
UnregisterFunction
receive
Reactions
receiveReactions
(
callback
:
(
reactions
:
Reaction
[]
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
reactions
:
Reaction
[]
)
=>
void
Returns
UnregisterFunction
receive
Requests
receiveRequests
(
callback
:
(
requests
:
RequestItem
[]
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
requests
:
RequestItem
[]
)
=>
void
Returns
UnregisterFunction
receive
Services
receiveServices
(
callback
:
(
services
:
Service
[]
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
services
:
Service
[]
)
=>
void
Returns
UnregisterFunction
receive
Set
List
receiveSetList
(
callback
:
(
data
:
SetList
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
data
:
SetList
)
=>
void
Returns
UnregisterFunction
receive
Speech
receiveSpeech
(
callback
:
(
text
:
string
,
config
:
SpeechConfig
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
text
:
string
,
config
:
SpeechConfig
)
=>
void
Returns
UnregisterFunction
receive
Stock
Comments
receiveStockComments
(
callback
:
(
data
:
Comment
[]
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
data
:
Comment
[]
)
=>
void
Returns
UnregisterFunction
receive
Stop
Speech
receiveStopSpeech
(
callback
:
()
=>
void
)
:
UnregisterFunction
Parameters
callback
:
()
=>
void
Returns
UnregisterFunction
receive
Survey
Result
receiveSurveyResult
(
callback
:
(
result
:
SurveyResult
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
result
:
SurveyResult
)
=>
void
Returns
UnregisterFunction
receive
Timestamps
receiveTimestamps
(
callback
:
(
data
:
TimestampData
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
data
:
TimestampData
)
=>
void
Returns
UnregisterFunction
receive
Update
receiveUpdate
(
callback
:
(
info
:
UpdateCheckResult
)
=>
void
)
:
UnregisterFunction
Parameters
callback
:
(
info
:
UpdateCheckResult
)
=>
void
Returns
UnregisterFunction
receive
Update
Meta
receiveUpdateMeta
(
callback
:
(
id
:
string
,
meta
:
ServiceMeta
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
id
:
string
,
meta
:
ServiceMeta
)
=>
void
Returns
UnregisterFunction
receive
Update
User
Datas
receiveUpdateUserDatas
(
callback
:
(
userData
:
UserStoreData
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
userData
:
UserStoreData
)
=>
void
Returns
UnregisterFunction
receive
Watings
receiveWatings
(
callback
:
(
orders
:
OrderItem
[]
,
stats
:
OrderStats
)
=>
void
,
)
:
UnregisterFunction
Parameters
callback
:
(
orders
:
OrderItem
[]
,
stats
:
OrderStats
)
=>
void
Returns
UnregisterFunction
relolad
Plugins
reloladPlugins
()
:
Promise
<
PluginList
>
Returns
Promise
<
PluginList
>
remove
Service
removeService
(
service
:
Service
)
:
void
Parameters
service
:
Service
Returns
void
reset
Result
View
resetResultView
()
:
void
Returns
void
reset
Settings
resetSettings
(
type
:
keyof
Config
)
:
void
Parameters
type
:
keyof
Config
Returns
void
reset
Total
Order
Count
resetTotalOrderCount
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
reset
Window
Position
resetWindowPosition
()
:
Promise
<
void
>
Returns
Promise
<
void
>
restore
Backup
restoreBackup
(
path
:
string
)
:
Promise
<
boolean
>
Parameters
path
:
string
Returns
Promise
<
boolean
>
rewrite
Order
File
rewriteOrderFile
()
:
void
Returns
void
rewrite
Set
List
Template
rewriteSetListTemplate
()
:
void
Returns
void
rewrite
Set
List
Templates
rewriteSetListTemplates
()
:
void
Returns
void
save
Favorites
saveFavorites
(
names
:
string
[]
)
:
Promise
<
string
[]
>
Parameters
names
:
string
[]
Returns
Promise
<
string
[]
>
save
Word
Party
Config
saveWordPartyConfig
(
dir
:
string
,
config
:
WordPartyGlobalConfig
,
items
:
WordPartyItem
[]
,
)
:
Promise
<
void
>
Parameters
dir
:
string
config
:
WordPartyGlobalConfig
items
:
WordPartyItem
[]
Returns
Promise
<
void
>
search
Music
searchMusic
(
name
:
string
)
:
Promise
<
MusicDataSearchResult
[]
>
Parameters
name
:
string
Returns
Promise
<
MusicDataSearchResult
[]
>
send
Correct
Answer
sendCorrectAnswer
(
surveyId
:
string
,
questionId
:
string
)
:
void
Parameters
surveyId
:
string
questionId
:
string
Returns
void
send
Quiz
Result
sendQuizResult
(
surveyId
:
string
)
:
void
Parameters
surveyId
:
string
Returns
void
send
Survey
Result
sendSurveyResult
(
surveyId
:
string
,
questionId
:
string
)
:
void
Parameters
surveyId
:
string
questionId
:
string
Returns
void
send
Test
Comment
sendTestComment
(
comment
:
CommentData
,
option
:
TestCommentOption
)
:
void
Parameters
comment
:
CommentData
option
:
TestCommentOption
Returns
void
show
Context
Menu
showContextMenu
(
type
:
string
,
...
args
:
any
[]
)
:
void
Parameters
type
:
string
...
args
:
any
[]
Returns
void
show
News
showNews
()
:
void
Returns
void
shuffle
Waiting
List
shuffleWaitingList
()
:
Promise
<
OrderItem
[]
>
Returns
Promise
<
OrderItem
[]
>
speech
Preview
speechPreview
(
comment
:
string
,
username
:
string
,
config
:
SpeechConfig
)
:
void
Parameters
comment
:
string
username
:
string
config
:
SpeechConfig
Returns
void
start
Set
List
startSetList
(
id
:
number
)
:
void
Parameters
id
:
number
Returns
void
stock
Comment
stockComment
(
comment
:
Comment
)
:
Promise
<
void
>
Parameters
comment
:
Comment
Returns
Promise
<
void
>
stop
Speech
stopSpeech
()
:
void
Returns
void
swap
Waiting
List
swapWaitingList
(
from
:
number
,
to
:
number
)
:
Promise
<
OrderItem
[]
>
Parameters
from
:
number
to
:
number
Returns
Promise
<
OrderItem
[]
>
toggle
Pip
togglePip
()
:
void
Returns
void
toggle
Secret
Mode
toggleSecretMode
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
translate
Comment
translateComment
(
lang
:
string
,
comment
:
Comment
)
:
void
Parameters
lang
:
string
comment
:
Comment
Returns
void
unstock
Comments
unstockComments
(
ids
:
string
[]
)
:
Promise
<
void
>
Parameters
ids
:
string
[]
Returns
Promise
<
void
>
update
Config
updateConfig
(
config
:
RecursivePartial
<
Config
>
)
:
Promise
<
Config
>
Parameters
config
:
RecursivePartial
<
Config
>
Returns
Promise
<
Config
>
update
License
updateLicense
(
licenseKey
:
string
)
:
void
Parameters
licenseKey
:
string
Returns
void
update
Music
Box
updateMusicBox
(
id
:
number
,
params
:
MusicBoxParams
)
:
Promise
<
MusicBox
>
Parameters
id
:
number
params
:
MusicBoxParams
Returns
Promise
<
MusicBox
>
update
Music
List
updateMusicList
(
id
:
number
,
params
:
MusicDataParams
)
:
Promise
<
void
>
Parameters
id
:
number
params
:
MusicDataParams
Returns
Promise
<
void
>
update
Order
Items
updateOrderItems
(
items
:
UpdatableOrderItemProps
[]
)
:
Promise
<
OrderItem
[]
>
Parameters
items
:
UpdatableOrderItemProps
[]
Returns
Promise
<
OrderItem
[]
>
update
Service
updateService
(
service
:
Service
)
:
void
Parameters
service
:
Service
Returns
void
update
Set
List
updateSetList
(
id
:
number
,
name
:
string
)
:
Promise
<
void
>
Parameters
id
:
number
name
:
string
Returns
Promise
<
void
>
update
Set
List
Items
updateSetListItems
(
id
:
number
,
items
:
number
[]
)
:
Promise
<
void
>
Parameters
id
:
number
items
:
number
[]
Returns
Promise
<
void
>
update
Speech
Dictionary
Config
updateSpeechDictionaryConfig
(
config
:
Partial
<
SpeechDictionaryConfig
>
,
)
:
Promise
<
SpeechDictionaryConfig
>
Parameters
config
:
Partial
<
SpeechDictionaryConfig
>
Returns
Promise
<
SpeechDictionaryConfig
>
update
Surveys
updateSurveys
(
surveys
:
Survey
[]
)
:
Promise
<
Survey
[]
>
Parameters
surveys
:
Survey
[]
Returns
Promise
<
Survey
[]
>
update
Timestamps
updateTimestamps
(
data
:
Partial
<
TimestampData
>
)
:
Promise
<
TimestampData
>
Parameters
data
:
Partial
<
TimestampData
>
Returns
Promise
<
TimestampData
>
update
User
Data
updateUserData
(
id
:
string
,
userData
:
Partial
<
UserNameData
>
)
:
void
Parameters
id
:
string
userData
:
Partial
<
UserNameData
>
Returns
void
update
Word
Dictionary
Config
updateWordDictionaryConfig
(
config
:
Partial
<
WordDictionaryConfig
>
,
)
:
Promise
<
WordDictionaryConfig
>
Parameters
config
:
Partial
<
WordDictionaryConfig
>
Returns
Promise
<
WordDictionaryConfig
>
upload
Template
uploadTemplate
()
:
Promise
<
{
message
:
string
;
path
?:
string
;
status
:
"error"
|
"succeeded"
}
,
>
Returns
Promise
<
{
message
:
string
;
path
?:
string
;
status
:
"error"
|
"succeeded"
}
>
upload
Template
File
uploadTemplateFile
(
filepath
:
string
,
)
:
Promise
<
{
message
:
string
;
path
?:
string
;
status
:
"error"
|
"succeeded"
}
,
>
Parameters
filepath
:
string
Returns
Promise
<
{
message
:
string
;
path
?:
string
;
status
:
"error"
|
"succeeded"
}
>
upload
Template
Resource
uploadTemplateResource
(
dir
:
string
,
files
:
{
buffer
:
ArrayBuffer
;
name
:
string
;
type
:
string
}
[]
,
)
:
Promise
<
string
[]
>
Parameters
dir
:
string
files
:
{
buffer
:
ArrayBuffer
;
name
:
string
;
type
:
string
}
[]
Returns
Promise
<
string
[]
>
wp
Exec
wpExec
(
id
:
string
)
:
void
Parameters
id
:
string
Returns
void
Settings
Theme
OS
Light
Dark
On This Page
Properties
platform
Methods
activate
Plugin
add
Block
add
Waiting
List
append
Empty
Timeline
Item
append
Timeline
Item
From
Talk
Script
backup
Now
cancel
All
Waiting
List
cancel
Waiting
List
change
Active
Survey
change
Bookmark
change
Playings
change
Result
Visible
change
Service
Order
check
Integration
check
Login
Status
check
Update
clean
Up
DB
clear
All
Cache
clear
All
Stock
Comments
clear
Coments
clear
Survey
Result
clone
Template
Resource
close
Window
complete
Playing
Orders
complete
Set
List
Items
complete
Top
Order
complete
Waiting
List
create
Music
Box
create
Report
create
Service
deactivate
Plugin
decrement
Playing
Order
delete
Comment
delete
Music
Box
delete
Music
List
delete
Requests
delete
Set
List
delete
Survey
delete
Survey
Answer
delete
Template
delete
Template
Resource
delete
User
Data
drag
File
Start
drag
Start
drag
Static
File
end
Set
List
exec
Analyze
exec
Update
generate
API
Token
get
Aivis
Speech
Voice
List
get
All
Comments
get
All
Music
List
get
All
Stock
Comments
get
API
Token
get
Backup
Files
get
Bouyomi
Chan
Voice
List
get
Coeiroink
Voice
List
get
Config
get
Current
Set
List
Id
get
Dictionary
get
Exists
Log
Dates
get
Favorites
get
File
Path
get
Font
List
get
Listeners
get
Locale
get
Login
Status
get
Music
Box
List
get
Music
List
get
News
get
Order
Stats
get
Plugins
get
Quiz
Result
get
Requests
get
Server
Info
get
Service
get
Services
get
Set
List
get
Set
Lists
get
Survey
Result
get
Survey
Result
All
get
Surveys
get
Template
List
get
Template
Path
get
Timestamps
get
User
Comment
History
get
User
Current
Comments
get
User
Data
get
User
Datas
get
Version
get
Voicevox
Voice
List
get
Waiting
List
get
YNC
Registry
get
YNC
Voice
List
increment
Playing
Order
insert
Logs
insert
Music
List
insert
Set
List
insert
Set
List
Item
is
Pro
Mode
join
Survey
Answers
load
Word
Party
maximize
Window
minimize
Window
open
Analysis
Window
open
App
Directory
open
Browser
Window
open
Chat
Window
open
Comment
Stock
open
Comment
Tester
open
Dictionary
Window
open
Directory
Select
Dialog
open
Folder
open
Gift
Window
open
Link
open
Listeners
Window
open
Logs
Directory
open
Order
Manager
Window
open
Plugin
Directory
open
Plugin
Manager
Window
open
Setlist
Manager
Window
open
Survey
Manager
open
Template
Window
open
Time
Stamp
Tool
open
User
Directory
open
Word
Party
Window
pin
Comment
pip
Mouse
Event
prioritize
Lower
Count
prioritize
Lower
Total
Count
receive
Beep
Sound
receive
Bookmark
receive
Clear
Comments
receive
Clear
Meta
receive
Comment
Notification
receive
Comments
receive
Config
Update
receive
Delete
Comment
receive
Delete
User
Datas
receive
Dictionary
Update
receive
Invoke
Speech
receive
Load
Word
Party
receive
Notification
receive
Page
Error
receive
Pinned
receive
Progress
receive
Reactions
receive
Requests
receive
Services
receive
Set
List
receive
Speech
receive
Stock
Comments
receive
Stop
Speech
receive
Survey
Result
receive
Timestamps
receive
Update
receive
Update
Meta
receive
Update
User
Datas
receive
Watings
relolad
Plugins
remove
Service
reset
Result
View
reset
Settings
reset
Total
Order
Count
reset
Window
Position
restore
Backup
rewrite
Order
File
rewrite
Set
List
Template
rewrite
Set
List
Templates
save
Favorites
save
Word
Party
Config
search
Music
send
Correct
Answer
send
Quiz
Result
send
Survey
Result
send
Test
Comment
show
Context
Menu
show
News
shuffle
Waiting
List
speech
Preview
start
Set
List
stock
Comment
stop
Speech
swap
Waiting
List
toggle
Pip
toggle
Secret
Mode
translate
Comment
unstock
Comments
update
Config
update
License
update
Music
Box
update
Music
List
update
Order
Items
update
Service
update
Set
List
update
Set
List
Items
update
Speech
Dictionary
Config
update
Surveys
update
Timestamps
update
User
Data
update
Word
Dictionary
Config
upload
Template
upload
Template
File
upload
Template
Resource
wp
Exec
OneSDK
Loading...