Preparing search index...
The search index is not available
quip-api-typescript
quip-api-typescript
ThreadsAPI
Class ThreadsAPI
Hierarchy
ThreadsAPI
Index
Properties
add
Blob
To
Thread
add
Members
To
Thread
Or
Add
Thread
To
Folders
copyADocument
Or
Template
V2
createAChat
Room
createADocument
Or
Spreadsheet
create
Bulk
Export
Request
create
Export
Pdf
Request
create
Live
Paste
Section
deleteAThread
editADocument
edit
Thread
Link
Share
Settings
export
Document
To
Docx
export
Slides
To
Pdf
export
Spreadsheet
To
Xlsx
get
Blob
From
Thread
get
Recent
Threads
get
Thread
Folders
V2
get
Thread
Html
V2
get
Thread
Invited
Members
V2
get
Thread
Members
V2
get
Thread
V2
get
Threads
V2
lock
Or
UnlockASection
lock
Or
UnlockAThread
remove
People
From
Thread
retrieve
Bulk
Export
Response
retrieve
Export
Pdf
Response
search
For
Threads
Properties
add
Blob
To
Thread
add
Blob
To
Thread
:
(
(
props
:
AddBlobToThreadRequestProps
)
=>
Promise
<
AddBlobToThreadResponse
>
)
Type declaration
(
props
:
AddBlobToThreadRequestProps
)
:
Promise
<
AddBlobToThreadResponse
>
Quip API Reference
Parameters
props:
AddBlobToThreadRequestProps
Returns
Promise
<
AddBlobToThreadResponse
>
add
Members
To
Thread
Or
Add
Thread
To
Folders
add
Members
To
Thread
Or
Add
Thread
To
Folders
:
(
(
props
:
AddPeopleToAThreadRequestProps
)
=>
Promise
<
AddPeopleToAThreadResponse
>
)
Type declaration
(
props
:
AddPeopleToAThreadRequestProps
)
:
Promise
<
AddPeopleToAThreadResponse
>
Quip API Reference
Parameters
props:
AddPeopleToAThreadRequestProps
Returns
Promise
<
AddPeopleToAThreadResponse
>
copyADocument
Or
Template
V2
copyADocument
Or
Template
V2
:
(
(
props
:
CopyADocumentOrTemplateV2RequestProps
)
=>
Promise
<
CopyADocumentOrTemplateV2Response
>
)
Type declaration
(
props
:
CopyADocumentOrTemplateV2RequestProps
)
:
Promise
<
CopyADocumentOrTemplateV2Response
>
Quip API Reference
Parameters
props:
CopyADocumentOrTemplateV2RequestProps
Returns
Promise
<
CopyADocumentOrTemplateV2Response
>
createAChat
Room
createAChat
Room
:
(
(
props
:
CreateAChatRoomRequestProps
)
=>
Promise
<
CreateAChatRoomResponse
>
)
Type declaration
(
props
:
CreateAChatRoomRequestProps
)
:
Promise
<
CreateAChatRoomResponse
>
Quip API Reference
Parameters
props:
CreateAChatRoomRequestProps
Returns
Promise
<
CreateAChatRoomResponse
>
createADocument
Or
Spreadsheet
createADocument
Or
Spreadsheet
:
(
(
props
:
CreateADocumentOrSpreadsheetRequestProps
)
=>
Promise
<
CreateADocumentOrSpreadsheetResponse
>
)
Type declaration
(
props
:
CreateADocumentOrSpreadsheetRequestProps
)
:
Promise
<
CreateADocumentOrSpreadsheetResponse
>
Quip API Reference
Parameters
props:
CreateADocumentOrSpreadsheetRequestProps
Returns
Promise
<
CreateADocumentOrSpreadsheetResponse
>
create
Bulk
Export
Request
create
Bulk
Export
Request
:
(
(
props
:
CreateBulkExportRequestRequestProps
)
=>
Promise
<
CreateBulkExportRequestResponse
>
)
Type declaration
(
props
:
CreateBulkExportRequestRequestProps
)
:
Promise
<
CreateBulkExportRequestResponse
>
Quip API Reference
Parameters
props:
CreateBulkExportRequestRequestProps
Returns
Promise
<
CreateBulkExportRequestResponse
>
create
Export
Pdf
Request
create
Export
Pdf
Request
:
(
(
props
:
CreateExportPdfRequestRequestProps
)
=>
Promise
<
CreateExportPdfRequestResponse
>
)
Type declaration
(
props
:
CreateExportPdfRequestRequestProps
)
:
Promise
<
CreateExportPdfRequestResponse
>
Quip API Reference
Parameters
props:
CreateExportPdfRequestRequestProps
Returns
Promise
<
CreateExportPdfRequestResponse
>
create
Live
Paste
Section
create
Live
Paste
Section
:
(
(
props
:
CreateLivePasteSectionRequestProps
)
=>
Promise
<
CreateLivePasteSectionResponse
>
)
Type declaration
(
props
:
CreateLivePasteSectionRequestProps
)
:
Promise
<
CreateLivePasteSectionResponse
>
Quip API Reference
Parameters
props:
CreateLivePasteSectionRequestProps
Returns
Promise
<
CreateLivePasteSectionResponse
>
deleteAThread
deleteAThread
:
(
(
props
:
DeleteAThreadRequestProps
)
=>
Promise
<
DeleteAThreadResponse
>
)
Type declaration
(
props
:
DeleteAThreadRequestProps
)
:
Promise
<
DeleteAThreadResponse
>
Quip API Reference
Parameters
props:
DeleteAThreadRequestProps
Returns
Promise
<
DeleteAThreadResponse
>
editADocument
editADocument
:
(
(
props
:
EditADocumentRequestProps
)
=>
Promise
<
EditADocumentResponse
>
)
Type declaration
(
props
:
EditADocumentRequestProps
)
:
Promise
<
EditADocumentResponse
>
Quip API Reference
Parameters
props:
EditADocumentRequestProps
Returns
Promise
<
EditADocumentResponse
>
edit
Thread
Link
Share
Settings
edit
Thread
Link
Share
Settings
:
(
(
props
:
EditThreadLinkShareSettingsRequestProps
)
=>
Promise
<
EditThreadLinkShareSettingsResponse
>
)
Type declaration
(
props
:
EditThreadLinkShareSettingsRequestProps
)
:
Promise
<
EditThreadLinkShareSettingsResponse
>
Quip API Reference
Parameters
props:
EditThreadLinkShareSettingsRequestProps
Returns
Promise
<
EditThreadLinkShareSettingsResponse
>
export
Document
To
Docx
export
Document
To
Docx
:
(
(
props
:
ExportDocumentToDocxRequestProps
)
=>
Promise
<
any
>
)
Type declaration
(
props
:
ExportDocumentToDocxRequestProps
)
:
Promise
<
any
>
Quip API Reference
Parameters
props:
ExportDocumentToDocxRequestProps
Returns
Promise
<
any
>
export
Slides
To
Pdf
export
Slides
To
Pdf
:
(
(
props
:
ExportSlidesToPdfRequestProps
)
=>
Promise
<
any
>
)
Type declaration
(
props
:
ExportSlidesToPdfRequestProps
)
:
Promise
<
any
>
Quip API Reference
Parameters
props:
ExportSlidesToPdfRequestProps
Returns
Promise
<
any
>
export
Spreadsheet
To
Xlsx
export
Spreadsheet
To
Xlsx
:
(
(
props
:
ExportSpreadsheetToXlsxRequestProps
)
=>
Promise
<
any
>
)
Type declaration
(
props
:
ExportSpreadsheetToXlsxRequestProps
)
:
Promise
<
any
>
Quip API Reference
Parameters
props:
ExportSpreadsheetToXlsxRequestProps
Returns
Promise
<
any
>
get
Blob
From
Thread
get
Blob
From
Thread
:
(
(
props
:
GetBlobFromThreadRequestProps
)
=>
Promise
<
any
>
)
Type declaration
(
props
:
GetBlobFromThreadRequestProps
)
:
Promise
<
any
>
Quip API Reference
Parameters
props:
GetBlobFromThreadRequestProps
Returns
Promise
<
any
>
get
Recent
Threads
get
Recent
Threads
:
(
(
props
:
GetRecentThreadsRequestProps
)
=>
Promise
<
GetRecentThreadsResponse
>
)
Type declaration
(
props
:
GetRecentThreadsRequestProps
)
:
Promise
<
GetRecentThreadsResponse
>
Quip API Reference
Parameters
props:
GetRecentThreadsRequestProps
Returns
Promise
<
GetRecentThreadsResponse
>
get
Thread
Folders
V2
get
Thread
Folders
V2
:
(
(
props
:
GetThreadFoldersV2RequestProps
)
=>
Promise
<
GetThreadFoldersV2Response
>
)
Type declaration
(
props
:
GetThreadFoldersV2RequestProps
)
:
Promise
<
GetThreadFoldersV2Response
>
Quip API Reference
Parameters
props:
GetThreadFoldersV2RequestProps
Returns
Promise
<
GetThreadFoldersV2Response
>
get
Thread
Html
V2
get
Thread
Html
V2
:
(
(
props
:
GetThreadHtmlV2RequestProps
)
=>
Promise
<
GetThreadHtmlV2Response
>
)
Type declaration
(
props
:
GetThreadHtmlV2RequestProps
)
:
Promise
<
GetThreadHtmlV2Response
>
Quip API Reference
Parameters
props:
GetThreadHtmlV2RequestProps
Returns
Promise
<
GetThreadHtmlV2Response
>
get
Thread
Invited
Members
V2
get
Thread
Invited
Members
V2
:
(
(
props
:
GetThreadInvitedMembersV2RequestProps
)
=>
Promise
<
GetThreadInvitedMembersV2Response
>
)
Type declaration
(
props
:
GetThreadInvitedMembersV2RequestProps
)
:
Promise
<
GetThreadInvitedMembersV2Response
>
Quip API Reference
Parameters
props:
GetThreadInvitedMembersV2RequestProps
Returns
Promise
<
GetThreadInvitedMembersV2Response
>
get
Thread
Members
V2
get
Thread
Members
V2
:
(
(
props
:
GetThreadMembersV2RequestProps
)
=>
Promise
<
GetThreadMembersV2Response
>
)
Type declaration
(
props
:
GetThreadMembersV2RequestProps
)
:
Promise
<
GetThreadMembersV2Response
>
Quip API Reference
Parameters
props:
GetThreadMembersV2RequestProps
Returns
Promise
<
GetThreadMembersV2Response
>
get
Thread
V2
get
Thread
V2
:
(
(
props
:
GetThreadV2RequestProps
)
=>
Promise
<
GetThreadV2Response
>
)
Type declaration
(
props
:
GetThreadV2RequestProps
)
:
Promise
<
GetThreadV2Response
>
Quip API Reference
Parameters
props:
GetThreadV2RequestProps
Returns
Promise
<
GetThreadV2Response
>
get
Threads
V2
get
Threads
V2
:
(
(
props
:
GetThreadsV2RequestProps
)
=>
Promise
<
GetThreadsV2Response
>
)
Type declaration
(
props
:
GetThreadsV2RequestProps
)
:
Promise
<
GetThreadsV2Response
>
Quip API Reference
Parameters
props:
GetThreadsV2RequestProps
Returns
Promise
<
GetThreadsV2Response
>
lock
Or
UnlockASection
lock
Or
UnlockASection
:
(
(
props
:
LockOrUnlockASectionRequestProps
)
=>
Promise
<
LockOrUnlockASectionResponse
>
)
Type declaration
(
props
:
LockOrUnlockASectionRequestProps
)
:
Promise
<
LockOrUnlockASectionResponse
>
Quip API Reference
Parameters
props:
LockOrUnlockASectionRequestProps
Returns
Promise
<
LockOrUnlockASectionResponse
>
lock
Or
UnlockAThread
lock
Or
UnlockAThread
:
(
(
props
:
LockOrUnlockAThreadRequestProps
)
=>
Promise
<
LockOrUnlockAThreadResponse
>
)
Type declaration
(
props
:
LockOrUnlockAThreadRequestProps
)
:
Promise
<
LockOrUnlockAThreadResponse
>
Quip API Reference
Parameters
props:
LockOrUnlockAThreadRequestProps
Returns
Promise
<
LockOrUnlockAThreadResponse
>
remove
People
From
Thread
remove
People
From
Thread
:
(
(
props
:
RemovePeopleFromThreadRequestProps
)
=>
Promise
<
RemovePeopleFromThreadResponse
>
)
Type declaration
(
props
:
RemovePeopleFromThreadRequestProps
)
:
Promise
<
RemovePeopleFromThreadResponse
>
Quip API Reference
Parameters
props:
RemovePeopleFromThreadRequestProps
Returns
Promise
<
RemovePeopleFromThreadResponse
>
retrieve
Bulk
Export
Response
retrieve
Bulk
Export
Response
:
(
(
props
:
RetrieveBulkExportResponseRequestProps
)
=>
Promise
<
RetrieveBulkExportResponseResponse
>
)
Type declaration
(
props
:
RetrieveBulkExportResponseRequestProps
)
:
Promise
<
RetrieveBulkExportResponseResponse
>
Quip API Reference
Parameters
props:
RetrieveBulkExportResponseRequestProps
Returns
Promise
<
RetrieveBulkExportResponseResponse
>
retrieve
Export
Pdf
Response
retrieve
Export
Pdf
Response
:
(
(
props
:
RetrieveExportPdfResponseRequestProps
)
=>
Promise
<
RetrieveExportPdfResponseResponse
>
)
Type declaration
(
props
:
RetrieveExportPdfResponseRequestProps
)
:
Promise
<
RetrieveExportPdfResponseResponse
>
Quip API Reference
Parameters
props:
RetrieveExportPdfResponseRequestProps
Returns
Promise
<
RetrieveExportPdfResponseResponse
>
search
For
Threads
search
For
Threads
:
(
(
props
:
SearchForThreadsRequestProps
)
=>
Promise
<
SearchForThreadsResponse
>
)
Type declaration
(
props
:
SearchForThreadsRequestProps
)
:
Promise
<
SearchForThreadsResponse
>
Quip API Reference
Parameters
props:
SearchForThreadsRequestProps
Returns
Promise
<
SearchForThreadsResponse
>
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
quip-
api-
typescript
ThreadsAPI
add
Blob
To
Thread
add
Members
To
Thread
Or
Add
Thread
To
Folders
copyADocument
Or
Template
V2
createAChat
Room
createADocument
Or
Spreadsheet
create
Bulk
Export
Request
create
Export
Pdf
Request
create
Live
Paste
Section
deleteAThread
editADocument
edit
Thread
Link
Share
Settings
export
Document
To
Docx
export
Slides
To
Pdf
export
Spreadsheet
To
Xlsx
get
Blob
From
Thread
get
Recent
Threads
get
Thread
Folders
V2
get
Thread
Html
V2
get
Thread
Invited
Members
V2
get
Thread
Members
V2
get
Thread
V2
get
Threads
V2
lock
Or
UnlockASection
lock
Or
UnlockAThread
remove
People
From
Thread
retrieve
Bulk
Export
Response
retrieve
Export
Pdf
Response
search
For
Threads
Generated using
TypeDoc
Quip API Reference