Search
Preparing search index...
The search index is not available
cv-dialog-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"dialog/DialogService"
DialogService
Class DialogService
Hierarchy
DialogService
Implements
DialogApi
Index
Constructors
constructor
Properties
api
Version
base
Url
client
Accessors
last
Service
Activity
Methods
add
Attachment
add
Client
Listener
change
Mode
change
View
create
Session
d3lete
delete
Dialog
delete
Session
get
get
Actions
get
Available
Values
get
Content
get
Dialog
get
Editor
Property
get
Mode
get
Query
Property
get
Record
get
Records
get
Redirection
get
Session
get
View
get
Views
get
Workbench
get
Workbench
Actions
get
Workbenches
is
Any
User
InBriefcase
Mode
is
User
InBriefcase
Mode
open
Content
Stream
perform
Action
perform
Workbench
Action
post
property
Change
put
put
Record
remove
Client
Listener
stream
stream
Url
write
Property
Constructors
constructor
new
Dialog
Service
(
client
:
Client
, serverUrl
:
string
, apiVersion
:
any
)
:
DialogService
Parameters
client:
Client
serverUrl:
string
apiVersion:
any
Returns
DialogService
Properties
api
Version
api
Version
:
any
base
Url
base
Url
:
string
client
client
:
Client
Accessors
last
Service
Activity
get
lastServiceActivity
(
)
:
Date
Returns
Date
Methods
add
Attachment
add
Attachment
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, attachment
:
Attachment
)
:
Promise
<
void
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
attachment:
Attachment
Returns
Promise
<
void
>
add
Client
Listener
add
Client
Listener
(
clientListener
:
ClientListener
, locale
:
CvLocale
)
:
void
Parameters
clientListener:
ClientListener
locale:
CvLocale
Returns
void
change
Mode
change
Mode
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, mode
:
ViewMode
)
:
Promise
<
EditorDialog
|
Redirection
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
mode:
ViewMode
Returns
Promise
<
EditorDialog
|
Redirection
>
change
View
change
View
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, viewId
:
string
)
:
Promise
<
Dialog
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
viewId:
string
Returns
Promise
<
Dialog
>
create
Session
create
Session
(
tenantId
:
string
, login
:
Login
)
:
Promise
<
Session
|
Redirection
>
Parameters
tenantId:
string
login:
Login
Returns
Promise
<
Session
|
Redirection
>
Private
d3lete
d3lete
(
path
:
string
)
:
Promise
<
JsonClientResponse
>
Parameters
path:
string
Returns
Promise
<
JsonClientResponse
>
delete
Dialog
delete
Dialog
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
)
:
Promise
<
object
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
Returns
Promise
<
object
>
delete
Session
delete
Session
(
tenantId
:
string
, sessionId
:
string
)
:
Promise
<
object
>
Parameters
tenantId:
string
sessionId:
string
Returns
Promise
<
object
>
Private
get
get
(
path
:
string
, queryParams
?:
StringDictionary
)
:
Promise
<
JsonClientResponse
>
Parameters
path:
string
Optional
queryParams:
StringDictionary
Returns
Promise
<
JsonClientResponse
>
get
Actions
get
Actions
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
)
:
Promise
<
Array
<
Menu
>
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
Returns
Promise
<
Array
<
Menu
>
>
get
Available
Values
get
Available
Values
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, propertyName
:
string
, availableValuesParams
:
AvailableValuesParameters
)
:
Promise
<
Array
<
any
>
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
propertyName:
string
availableValuesParams:
AvailableValuesParameters
Returns
Promise
<
Array
<
any
>
>
get
Content
get
Content
(
tenantId
:
string
, sessionId
:
string
, contentId
:
string
, readLargePropertyParams
:
ReadLargePropertyParameters
)
:
Promise
<
LargeProperty
>
Parameters
tenantId:
string
sessionId:
string
contentId:
string
readLargePropertyParams:
ReadLargePropertyParameters
Returns
Promise
<
LargeProperty
>
get
Dialog
get
Dialog
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
)
:
Promise
<
Dialog
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
Returns
Promise
<
Dialog
>
get
Editor
Property
get
Editor
Property
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, propertyName
:
string
, readLargePropertyParams
:
ReadLargePropertyParameters
)
:
Promise
<
LargeProperty
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
propertyName:
string
readLargePropertyParams:
ReadLargePropertyParameters
Returns
Promise
<
LargeProperty
>
get
Mode
get
Mode
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
)
:
Promise
<
ViewMode
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
Returns
Promise
<
ViewMode
>
get
Query
Property
get
Query
Property
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, propertyName
:
string
, readLargePropertyParams
:
ReadLargePropertyParameters
)
:
Promise
<
LargeProperty
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
propertyName:
string
readLargePropertyParams:
ReadLargePropertyParameters
Returns
Promise
<
LargeProperty
>
get
Record
get
Record
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
)
:
Promise
<
Record
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
Returns
Promise
<
Record
>
get
Records
get
Records
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, queryParams
:
QueryParameters
)
:
Promise
<
RecordSet
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
queryParams:
QueryParameters
Returns
Promise
<
RecordSet
>
get
Redirection
get
Redirection
(
tenantId
:
string
, sessionId
:
string
, redirectionId
:
string
)
:
Promise
<
Redirection
>
Parameters
tenantId:
string
sessionId:
string
redirectionId:
string
Returns
Promise
<
Redirection
>
get
Session
get
Session
(
tenantId
:
string
, sessionId
:
string
)
:
Promise
<
Session
>
Parameters
tenantId:
string
sessionId:
string
Returns
Promise
<
Session
>
get
View
get
View
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
)
:
Promise
<
View
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
Returns
Promise
<
View
>
get
Views
get
Views
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
)
:
Promise
<
Array
<
ViewDescriptor
>
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
Returns
Promise
<
Array
<
ViewDescriptor
>
>
get
Workbench
get
Workbench
(
tenantId
:
string
, sessionId
:
string
, workbenchId
:
string
)
:
Promise
<
Workbench
>
Parameters
tenantId:
string
sessionId:
string
workbenchId:
string
Returns
Promise
<
Workbench
>
get
Workbench
Actions
get
Workbench
Actions
(
tenantId
:
string
, sessionId
:
string
, workbenchId
:
string
)
:
Promise
<
Array
<
WorkbenchAction
>
>
Parameters
tenantId:
string
sessionId:
string
workbenchId:
string
Returns
Promise
<
Array
<
WorkbenchAction
>
>
get
Workbenches
get
Workbenches
(
tenantId
:
string
, sessionId
:
string
)
:
Promise
<
Array
<
Workbench
>
>
Parameters
tenantId:
string
sessionId:
string
Returns
Promise
<
Array
<
Workbench
>
>
is
Any
User
InBriefcase
Mode
is
Any
User
InBriefcase
Mode
(
tenantId
:
string
)
:
Promise
<
boolean
>
Parameters
tenantId:
string
Returns
Promise
<
boolean
>
is
User
InBriefcase
Mode
is
User
InBriefcase
Mode
(
userInfo
:
__type
)
:
Promise
<
boolean
>
Parameters
userInfo:
__type
Returns
Promise
<
boolean
>
open
Content
Stream
open
Content
Stream
(
tenantId
:
string
, sessionId
:
string
, contentId
:
string
)
:
Promise
<
StreamProducer
>
Parameters
tenantId:
string
sessionId:
string
contentId:
string
Returns
Promise
<
StreamProducer
>
perform
Action
perform
Action
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, actionId
:
string
, actionParameters
:
ActionParameters
)
:
Promise
<
Redirection
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
actionId:
string
actionParameters:
ActionParameters
Returns
Promise
<
Redirection
>
perform
Workbench
Action
perform
Workbench
Action
(
tenantId
:
string
, sessionId
:
string
, workbenchId
:
string
, actionId
:
string
)
:
Promise
<
Redirection
>
Parameters
tenantId:
string
sessionId:
string
workbenchId:
string
actionId:
string
Returns
Promise
<
Redirection
>
Private
post
post<T>
(
path
:
string
, body
?:
T
)
:
Promise
<
JsonClientResponse
>
Type parameters
T
Parameters
path:
string
Optional
body:
T
Returns
Promise
<
JsonClientResponse
>
property
Change
property
Change
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, propertyName
:
string
, sideEffectsParams
:
SideEffectsParameters
)
:
Promise
<
SideEffectsResponse
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
propertyName:
string
sideEffectsParams:
SideEffectsParameters
Returns
Promise
<
SideEffectsResponse
>
Private
put
put<T>
(
path
:
string
, body
?:
T
)
:
Promise
<
JsonClientResponse
>
Type parameters
T
Parameters
path:
string
Optional
body:
T
Returns
Promise
<
JsonClientResponse
>
put
Record
put
Record
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, record
:
Record
)
:
Promise
<
EditorDialog
|
Redirection
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
record:
Record
Returns
Promise
<
EditorDialog
|
Redirection
>
remove
Client
Listener
remove
Client
Listener
(
clientListener
:
ClientListener
)
:
void
Parameters
clientListener:
ClientListener
Returns
void
Private
stream
stream
(
url
:
string
)
:
Promise
<
StreamProducer
>
Parameters
url:
string
Returns
Promise
<
StreamProducer
>
stream
Url
stream
Url
(
tentantId
:
string
, sessionId
:
string
, url
:
string
)
:
Promise
<
StreamProducer
>
Parameters
tentantId:
string
sessionId:
string
url:
string
Returns
Promise
<
StreamProducer
>
write
Property
write
Property
(
tenantId
:
string
, sessionId
:
string
, dialogId
:
string
, propertyName
:
string
, writeLargePropertyParams
:
WriteLargePropertyParameters
)
:
Promise
<
object
>
Parameters
tenantId:
string
sessionId:
string
dialogId:
string
propertyName:
string
writeLargePropertyParams:
WriteLargePropertyParameters
Returns
Promise
<
object
>
Globals
"dialog/
Dialog
Service"
Dialog
Service
constructor
api
Version
base
Url
client
last
Service
Activity
add
Attachment
add
Client
Listener
change
Mode
change
View
create
Session
d3lete
delete
Dialog
delete
Session
get
get
Actions
get
Available
Values
get
Content
get
Dialog
get
Editor
Property
get
Mode
get
Query
Property
get
Record
get
Records
get
Redirection
get
Session
get
View
get
Views
get
Workbench
get
Workbench
Actions
get
Workbenches
is
Any
User
InBriefcase
Mode
is
User
InBriefcase
Mode
open
Content
Stream
perform
Action
perform
Workbench
Action
post
property
Change
put
put
Record
remove
Client
Listener
stream
stream
Url
write
Property
Dialog
Service
Response
Dialog
Api
Response
Generated using
TypeDoc