CommandArgs

ts

type CommandArgs: object;

This is a type declaration whose purpose is to allow TypeScript to enforce the correct parameter and
return types from EditorClient.sendCommand based on
which command name you pass in as the first parameter.

IMPORTANT - Before you add a new command bring it up in #api-committee to get feedback

Type declaration

a

ts

a: object;

a.query

ts

query: AlertQuery;

a.result

ts

result: AlertResult;

aafh

ts

aafh: object;

aafh.query

ts

query: AddAuthorizationFlowHandlerQuery;

aafh.result

ts

result: AddAuthorizationFlowHandlerResult;

aci

ts

aci: object;

aci.query

ts

query: AddCardIntegrationQuery;

aci.result

ts

result: AddCardIntegrationResult;

adfm

ts

adfm: object;

adfm.query

ts

query: AddDiagramFromMermaidQuery;

adfm.result

ts

result: AddDiagramFromMermaidResult;

adft

ts

adft: object;

adft.query

ts

query: AddDiagramFromTextQuery;

adft.result

ts

result: AddDiagramFromTextResult;

adi

ts

adi: object;

adi.query

ts

query: AwaitDataSourceImportQuery;

adi.result

ts

result: AwaitDataSourceImportResult;

ai

ts

ai: object;

ai.query

ts

query: AwaitImportQuery;

ai.result

ts

result: AwaitImportResult;

alta

ts

alta: object;

alta.query

ts

query: AddLineTextAreaQuery;

alta.result

ts

result: AddLineTextAreaResult;

ami

ts

ami: object;

ami.query

ts

query: AddMenuItemQuery;

ami.result

ts

result: AddMenuItemResult;

aoauth

ts

aoauth: object;

aoauth.query

ts

query: SendAsyncOAuthRequestQuery;

aoauth.result

ts

result: SendOAuthRequestResponse;

aqa

ts

aqa: object;

aqa.query

ts

query: AddQuickActionQuery;

aqa.result

ts

result: AddQuickActionResult;

asd

ts

asd: object;

asd.query

ts

query: AddShapeDataQuery;

asd.result

ts

result: AddShapeDataResult;

asi

ts

asi: object;

asi.query

ts

query: AddSpreadsheetIntegrationQuery;

asi.result

ts

result: AddSpreadsheetIntegrationResult;

atc

ts

atc: object;

atc.query

ts

query: AddTableColumnQuery;

atc.result

ts

result: AddTableColumnResult;

atr

ts

atr: object;

atr.query

ts

query: AddTableRowQuery;

atr.result

ts

result: AddTableRowResult;

av

ts

av: object;

av.query

ts

query: AnimateViewportQuery;

av.result

ts

result: AnimateViewportResult;

b

ts

b: object;

b.query

ts

query: BootstrapQuery;

b.result

ts

result: BootstrapResult;

c

ts

c: object;

c.query

ts

query: ConfirmQuery;

c.result

ts

result: ConfirmResult;

ca

ts

ca: object;

ca.query

ts

query: CreateCardsQuery;

ca.result

ts

result: CreateCardsResult;

cb

ts

cb: object;

cb.query

ts

query: CreateBlockQuery;

cb.result

ts

result: CreateBlockResult;

cc

ts

cc: object;

cc.query

ts

query: CreateCollectionQuery;

cc.result

ts

result: CreateCollectionResult;

cdc

ts

cdc: object;

cdc.query

ts

query: CancelDragBlockToCanvasQuery;

cdc.result

ts

result: CancelDragBlockToCanvasResult;

cde

ts

cde: object;

cde.query

ts

query: CreateDocumentElementQuery;

cde.result

ts

result: CreateDocumentElementResult;

cds

ts

cds: object;

cds.query

ts

query: CreateDataSourceQuery;

cds.result

ts

result: CreateDataSourceResult;

ceps

ts

ceps: object;

ceps.query

ts

query: CanEditPackageSettingsQuery;

ceps.result

ts

result: CanEditPackageSettingsResult;

cg

ts

cg: object;

cg.query

ts

query: CreateGroupQuery;

cg.result

ts

result: CreateGroupResult;

cl

ts

cl: object;

cl.query

ts

query: CreateLineQuery;

cl.result

ts

result: CreateLineResult;

cp

ts

cp: object;

cp.query

ts

query: CreatePageQuery;

cp.result

ts

result: CreatePageResult;

cui

ts

cui: object;

cui.query

ts

query: CreateUserImageQuery;

cui.result

ts

result: CreateUserImageResult;

d

ts

d: object;

d.query

ts

query: DownloadQuery;

d.result

ts

result: DownloadResult;

da

ts

da: object;

da.query

ts

query: DataActionQuery;

da.result

ts

result: DataActionResult;

dde

ts

dde: object;

dde.query

ts

query: DeleteDocumentElementQuery;

dde.result

ts

result: DeleteDocumentElementResult;

di

ts

di: object;

di.query

ts

query: DeleteItemQuery;

di.result

ts

result: DeleteItemResult;

die

ts

die: object;

die.query

ts

query: DataItemExistsQuery;

die.result

ts

result: DataItemExistsResult;

dis

ts

dis: object;

dis.query

ts

query: DuplicateItemsQuery;

dis.result

ts

result: DuplicateItemsResult;

dp

ts

dp: object;

dp.query

ts

query: DeletePageQuery;

dp.result

ts

result: DeletePageResult;

dpm

ts

dpm: object;

dpm.query

ts

query: DragPointerMoveQuery;

dpm.result

ts

result: DragPointerMoveResult;

dpu

ts

dpu: object;

dpu.query

ts

query: DragPointerUpQuery;

dpu.result

ts

result: DragPointerUpResult;

dsd

ts

dsd: object;

dsd.query

ts

query: DeleteShapeDataQuery;

dsd.result

ts

result: DeleteShapeDataResult;

dtc

ts

dtc: object;

dtc.query

ts

query: DeleteTableColumnQuery;

dtc.result

ts

result: DeleteTableColumnResult;

dtr

ts

dtr: object;

dtr.query

ts

query: DeleteTableRowQuery;

dtr.result

ts

result: DeleteTableRowResult;

ee

ts

ee: object;

ee.query

ts

query: ElementExistsQuery;

ee.result

ts

result: ElementExistsResult;

ef

ts

ef: object;

ef.query

ts

query: ExecuteFormulaQuery;

ef.result

ts

result: ExecuteFormulaResult;

fas

ts

fas: object;

fas.query

ts

query: FindAvailableSpaceQuery;

fas.result

ts

result: FindAvailableSpaceResult;

fbe

ts

fbe: object;

fbe.query

ts

query: FireBeaconEventQuery;

fbe.result

ts

result: FireBeaconEventResult;

gcl

ts

gcl: object;

gcl.query

ts

query: GetConnectedLinesQuery;

gcl.result

ts

result: GetConnectedLinesResult;

gcp

ts

gcp: object;

gcp.query

ts

query: GetCurrentPageQuery;

gcp.result

ts

result: GetCurrentPageResult;

gcs

ts

gcs: object;

gcs.query

ts

query: GetCustomShapeQuery;

gcs.result

ts

result: GetCustomShapeResult;

gdap

ts

gdap: object;

gdap.query

ts

query: GetDocumentAccessPermissionQuery;

gdap.result

ts

result: GetDocumentAccessPermissionResult;

gdc

ts

gdc: object;

gdc.query

ts

query: GetDocumentChunksQuery;

gdc.result

ts

result: GetDocumentChunksResult;

gdid

ts

gdid: object;

gdid.query

ts

query: GetDocumentIdQuery;

gdid.result

ts

result: GetDocumentIdResult;

gdif

ts

gdif: object;

gdif.query

ts

query: GetDataItemFieldQuery;

gdif.result

ts

result: GetDataItemFieldResult;

gec

ts

gec: object;

gec.query

ts

query: GetEnvironmentConfigQuery;

gec.result

ts

result: GetEnvironmentConfigResult;

get

ts

get: object;

get.query

ts

query: GetElementTypeQuery;

get.result

ts

result: GetElementTypeResult;

gia

ts

gia: object;

gia.query

ts

query: GetItemsAtQuery;

gia.result

ts

result: GetItemsAtResult;

gip

ts

gip: object;

gip.query

ts

query: GetItemPageIdQuery;

gip.result

ts

result: GetItemPageIdResult;

goci

ts

goci: object;

goci.query

ts

query: GetOAuthClientIdQuery;

goci.result

ts

result: GetOAuthClientIdResult;

got

ts

got: object;

got.query

ts

query: GetOAuthTokenQuery;

got.result

ts

result: GetOAuthTokenResult;

gp

ts

gp: object;

gp.query

ts

query: GetPropertyQuery;

gp.result

ts

result: GetPropertyResult;

gpr

ts

gpr: object;

gpr.query

ts

query: GetProductQuery;

gpr.result

ts

result: GetProductResult;

gps

ts

gps: object;

gps.query

ts

query: GetPackageSettingsQuery;

gps.result

ts

result: GetPackageSettingsResult;

grk

ts

grk: object;

grk.query

ts

query: GetReferenceKeyQuery;

grk.result

ts

result: GetReferenceKeyResult;

grlp

ts

grlp: object;

grlp.query

ts

query: GetRelativeLinePositionQuery;

grlp.result

ts

result: GetRelativeLinePositionResult;

gs

ts

gs: object;

gs.query

ts

query: GetSelectionQuery;

gs.result

ts

result: GetSelectionResult;

gsd

ts

gsd: object;

gsd.query

ts

query: GetShapeDataQuery;

gsd.result

ts

result: GetShapeDataResult;

gsvg

ts

gsvg: object;

gsvg.query

ts

query: GetSvgQuery;

gsvg.result

ts

result: GetSvgResult;

gts

ts

gts: object;

gts.query

ts

query: GetTextStyleQuery;

gts.result

ts

result: GetTextStyleResult;

guid

ts

guid: object;

guid.query

ts

query: GetUserIdQuery;

guid.result

ts

result: GetUserIdResult;

gvr

ts

gvr: object;

gvr.query

ts

query: GetVisibleRectQuery;

gvr.result

ts

result: GetVisibleRectResult;

hac

ts

hac: object;

hac.query

ts

query: HookAllChangesQuery;

hac.result

ts

result: HookAllChangesResult;

hci

ts

hci: object;

hci.query

ts

query: HookCreateItemsQuery;

hci.result

ts

result: HookCreateItemsResult;

hdi

ts

hdi: object;

hdi.query

ts

query: HookDeleteItemsQuery;

hdi.result

ts

result: HookDeleteItemsResult;

hm

ts

hm: object;

hm.query

ts

query: HideModalQuery;

hm.result

ts

result: HideModalResult;

hp

ts

hp: object;

hp.query

ts

query: HidePanelQuery;

hp.result

ts

result: HidePanelResult;

hs

ts

hs: object;

hs.query

ts

query: HookSelectionQuery;

hs.result

ts

result: HookSelectionResult;

hsh

ts

hsh: object;

hsh.query

ts

query: CalculateHashQuery;

hsh.result

ts

result: CalculateHashResult;

hte

ts

hte: object;

hte.query

ts

query: HookTextEditQuery;

hte.result

ts

result: HookTextEditResult;

ic

ts

ic: object;

ic.query

ts

query: ImportCardsQuery;

ic.result

ts

result: ImportCardsResult;

il

ts

il: object;

il.query

ts

query: ImportLinksQuery;

il.result

ts

result: ImportLinksResult;

imp

ts

imp: object;

imp.query

ts

query: ImportPageQuery;

imp.result

ts

result: ImportPageResult;

k

ts

k: object;

k.query

ts

query: KillExtensionQuery;

k.result

ts

result: KillExtensionResult;

lb

ts

lb: object;

lb.query

ts

query: ListChildrenQuery;

lb.result

ts

result: ListChildrenResult;

lbc

ts

lbc: object;

lbc.query

ts

query: LoadBlockClassesQuery;

lbc.result

ts

result: LoadBlockClassesResult;

lc

ts

lc: object;

lc.query

ts

query: ListCollectionsQuery;

lc.result

ts

result: ListCollectionsResult;

lcf

ts

lcf: object;

lcf.query

ts

query: ListCollectionFieldsQuery;

lcf.result

ts

result: ListCollectionFieldsResult;

lde

ts

lde: object;

lde.query

ts

query: ListDocumentElementsQuery;

lde.result

ts

result: ListDocumentElementsResult;

ldi

ts

ldi: object;

ldi.query

ts

query: ListDataItemsQuery;

ldi.result

ts

result: ListDataItemsResult;

lds

ts

lds: object;

lds.query

ts

query: ListDataSourcesQuery;

lds.result

ts

result: ListDataSourcesResult;

lg

ts

lg: object;

lg.query

ts

query: ListChildrenQuery;

lg.result

ts

result: ListChildrenResult;

ll

ts

ll: object;

ll.query

ts

query: ListChildrenQuery;

ll.result

ts

result: ListChildrenResult;

llm

ts

llm: object;

llm.query

ts

query: GetLLMContextFromItemsQuery;

llm.result

ts

result: GetLLMContextFromItemsResult;

log

ts

log: object;

log.query

ts

query: JsonSerializable;

log.result

ts

result: JsonSerializable;

lp

ts

lp: object;

lp.query

ts

query: ListPagesQuery;

lp.result

ts

result: ListPagesResult;

lpr

ts

lpr: object;

lpr.query

ts

query: ListPropertiesQuery;

lpr.result

ts

result: ListPropertiesResult;

lrk

ts

lrk: object;

lrk.query

ts

query: ListReferenceKeysQuery;

lrk.result

ts

result: ListReferenceKeysResult;

lsd

ts

lsd: object;

lsd.query

ts

query: ListShapeDataQuery;

lsd.result

ts

result: ListShapeDataResult;

lta

ts

lta: object;

lta.query

ts

query: ListTextAreasQuery;

lta.result

ts

result: ListTextAreasResult;

luma

ts

luma: object;

luma.query

ts

query: AddDiagramFromLumaQuery;

luma.result

ts

result: AddDiagramFromLumaResult;

mt

ts

mt: object;

mt.query

ts

query: MeasureTextQuery;

mt.result

ts

result: MeasureTextResult;

oauth

ts

oauth: object;

oauth.query

ts

query: SendOAuthRequestQuery;

oauth.result

ts

result: SendOAuthRequestResponse;

oi

ts

oi: object;

oi.query

ts

query: OffsetItemsQuery;

oi.result

ts

result: OffsetItemsResult;

p

ts

p: object;

p.query

ts

query: PromptQuery;

p.result

ts

result: PromptResult;

pdf

ts

pdf: object;

pdf.query

ts

query: StartPDFUploadRequestQuery;

pdf.result

ts

result: StartPDFUploadRequestResponse;

pdi

ts

pdi: object;

pdi.query

ts

query: PatchDataItemsQuery;

pdi.result

ts

result: PatchDataItemsResult;

perm

ts

perm: object;

perm.query

ts

query: SendPermanentTokenRequestQuery;

perm.result

ts

result: SendOAuthRequestResponse;

r

ts

r: object;

r.query

ts

query: ReloadExtensionQuery;

r.result

ts

result: ReloadExtensionResult;

rp

ts

rp: object;

rp.query

ts

query: RegisterPanelQuery;

rp.result

ts

result: RegisterPanelResult;

ru

ts

ru: object;

ru.query

ts

query: RegisterUnfurlQuery;

ru.result

ts

result: RegisterUnfurlResult;

scp

ts

scp: object;

scp.query

ts

query: SetCurrentPageQuery;

scp.result

ts

result: SetCurrentPageResult;

sdc

ts

sdc: object;

sdc.query

ts

query: StartDragBlockToCanvasQuery;

sdc.result

ts

result: StartDragBlockToCanvasResult;

sleep

ts

sleep: object;

sleep.query

ts

query: SleepForTestCaseQuery;

sleep.result

ts

result: SleepForTestCaseResult;

sm

ts

sm: object;

sm.query

ts

query: ShowModalQuery;

sm.result

ts

result: ShowModalResult;

sp

ts

sp: object;

sp.query

ts

query: SetPropertyQuery;

sp.result

ts

result: SetPropertyResult;

spn

ts

spn: object;

spn.query

ts

query: ShowPanelQuery;

spn.result

ts

result: ShowPanelResult;

sps

ts

sps: object;

sps.query

ts

query: SetPackageSettingsQuery;

sps.result

ts

result: SetPackageSettingsResult;

spsm

ts

spsm: object;

spsm.query

ts

query: ShowPackageSettingsModalQuery;

spsm.result

ts

result: ShowPackageSettingsModalResult;

srk

ts

srk: object;

srk.query

ts

query: SetReferenceKeyQuery;

srk.result

ts

result: SetReferenceKeyResult;

ss

ts

ss: object;

ss.query

ts

query: SetSelectionQuery;

ss.result

ts

result: SetSelectionResult;

ssd

ts

ssd: object;

ssd.query

ts

query: SetShapeDataQuery;

ssd.result

ts

result: SetShapeDataResult;

st

ts

st: object;

st.query

ts

query: SetTextQuery;

st.result

ts

result: SetTextResult;

sts

ts

sts: object;

sts.query

ts

query: SetTextStyleQuery;

sts.result

ts

result: SetTextStyleResult;

suim

ts

suim: object;

suim.query

ts

query: SendUIMessageQuery;

suim.result

ts

result: SendUIMessageResult;

tauth

ts

tauth: object;

tauth.query

ts

query: TriggerAuthFlowQuery;

tauth.result

ts

result: TriggerAuthFlowResult;

throw

ts

throw: object;

throw.query

ts

query: ThrowForTestCaseQuery;

throw.result

ts

result: ThrowForTestCaseResult;

uac

ts

uac: object;

uac.query

ts

query: UnhookAllChangesQuery;

uac.result

ts

result: UnhookAllChangesResult;

uci

ts

uci: object;

uci.query

ts

query: UnhookCreateItemsQuery;

uci.result

ts

result: UnhookCreateItemsResult;

udi

ts

udi: object;

udi.query

ts

query: UnhookDeleteItemsQuery;

udi.result

ts

result: UnhookDeleteItemsResult;

us

ts

us: object;

us.query

ts

query: UnhookSelectionQuery;

us.result

ts

result: UnhookSelectionResult;

ute

ts

ute: object;

ute.query

ts

query: UnhookTextEditQuery;

ute.result

ts

result: UnhookTextEditResult;

wm

ts

wm: object;

wm.query

ts

query: WithMutexQuery;

wm.result

ts

result: WithMutexResult;

wsa

ts

wsa: object;

wsa.query

ts

query: WithSilentActionsQuery;

wsa.result

ts

result: WithSilentActionsResult;

xhr

ts

xhr: object;

xhr.query

ts

query: SendXHRQuery;

xhr.result

ts

result: SendXHRResponse;

z

ts

z: object;

z.query

ts

query: ZOrderQuery;

z.result

ts

result: ZOrderResult;