createConversation(
args
: {comments?
:Pick
<NewState
<LixConversationMessage
>,"body"
> &Partial
<Pick
<NewState
<LixConversationMessage
>,"lixcol_metadata"
>>[];entity?
:LixEntityCanonical
|LixEntity
;id?
:string
;lix
:Lix
;versionId?
:string
; }):Promise
<LixSelectable
<EntityStateAllView
<{id
:LixGenerated
<string
>; }>> & {comments
:LixSelectable
<EntityStateAllView
<LixConversationMessage
>>[]; }>
Starts a new conversation.
Conversations allow collaborators to attach messages to a specific version or entity. Initial messages can be provided and will be inserted sequentially.
Parameter | Type | Description |
---|---|---|
args | { comments? : Pick <NewState <LixConversationMessage >, "body" > & Partial <Pick <NewState <LixConversationMessage >, "lixcol_metadata" >>[]; entity? : LixEntityCanonical | LixEntity ; id? : string ; lix : Lix ; versionId? : string ; } | - |
args.comments? | Pick <NewState <LixConversationMessage >, "body" > & Partial <Pick <NewState <LixConversationMessage >, "lixcol_metadata" >>[] | - |
args.entity? | LixEntityCanonical | LixEntity | Optional entity to attach the conversation to |
args.id? | string | - |
args.lix | Lix | - |
args.versionId? | string | defaults to global |
Promise
<LixSelectable
<EntityStateAllView
<{ id
: LixGenerated
<string
>; }>> & { comments
: LixSelectable
<EntityStateAllView
<LixConversationMessage
>>[]; }>