CommandArgs

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

a: object;

a.query

query: AlertQuery;

a.result

result: AlertResult;

aafh

aafh: object;

aafh.query

query: AddAuthorizationFlowHandlerQuery;

aafh.result

result: AddAuthorizationFlowHandlerResult;

aci

aci: object;

aci.query

query: AddCardIntegrationQuery;

aci.result

result: AddCardIntegrationResult;

adfm

adfm: object;

adfm.query

query: AddDiagramFromMermaidQuery;

adfm.result

result: AddDiagramFromMermaidResult;

adft

adft: object;

adft.query

query: AddDiagramFromTextQuery;

adft.result

result: AddDiagramFromTextResult;

adi

adi: object;

adi.query

query: AwaitDataSourceImportQuery;

adi.result

result: AwaitDataSourceImportResult;

ai

ai: object;

ai.query

query: AwaitImportQuery;

ai.result

result: AwaitImportResult;

alta

alta: object;

alta.query

query: AddLineTextAreaQuery;

alta.result

result: AddLineTextAreaResult;

ami

ami: object;

ami.query

query: AddMenuItemQuery;

ami.result

result: AddMenuItemResult;

aoauth

aoauth: object;

aoauth.query

query: SendAsyncOAuthRequestQuery;

aoauth.result

result: SendOAuthRequestResponse;

aqa

aqa: object;

aqa.query

query: AddQuickActionQuery;

aqa.result

result: AddQuickActionResult;

asd

asd: object;

asd.query

query: AddShapeDataQuery;

asd.result

result: AddShapeDataResult;

asi

asi: object;

asi.query

query: AddSpreadsheetIntegrationQuery;

asi.result

result: AddSpreadsheetIntegrationResult;

atc

atc: object;

atc.query

query: AddTableColumnQuery;

atc.result

result: AddTableColumnResult;

atr

atr: object;

atr.query

query: AddTableRowQuery;

atr.result

result: AddTableRowResult;

av

av: object;

av.query

query: AnimateViewportQuery;

av.result

result: AnimateViewportResult;

b

b: object;

b.query

query: BootstrapQuery;

b.result

result: BootstrapResult;

c

c: object;

c.query

query: ConfirmQuery;

c.result

result: ConfirmResult;

ca

ca: object;

ca.query

query: CreateCardsQuery;

ca.result

result: CreateCardsResult;

cb

cb: object;

cb.query

query: CreateBlockQuery;

cb.result

result: CreateBlockResult;

cc

cc: object;

cc.query

query: CreateCollectionQuery;

cc.result

result: CreateCollectionResult;

cdc

cdc: object;

cdc.query

query: CancelDragBlockToCanvasQuery;

cdc.result

result: CancelDragBlockToCanvasResult;

cde

cde: object;

cde.query

query: CreateDocumentElementQuery;

cde.result

result: CreateDocumentElementResult;

cds

cds: object;

cds.query

query: CreateDataSourceQuery;

cds.result

result: CreateDataSourceResult;

ceps

ceps: object;

ceps.query

query: CanEditPackageSettingsQuery;

ceps.result

result: CanEditPackageSettingsResult;

cg

cg: object;

cg.query

query: CreateGroupQuery;

cg.result

result: CreateGroupResult;

cl

cl: object;

cl.query

query: CreateLineQuery;

cl.result

result: CreateLineResult;

cp

cp: object;

cp.query

query: CreatePageQuery;

cp.result

result: CreatePageResult;

cui

cui: object;

cui.query

query: CreateUserImageQuery;

cui.result

result: CreateUserImageResult;

d

d: object;

d.query

query: DownloadQuery;

d.result

result: DownloadResult;

da

da: object;

da.query

query: DataActionQuery;

da.result

result: DataActionResult;

dde

dde: object;

dde.query

query: DeleteDocumentElementQuery;

dde.result

result: DeleteDocumentElementResult;

di

di: object;

di.query

query: DeleteItemQuery;

di.result

result: DeleteItemResult;

die

die: object;

die.query

query: DataItemExistsQuery;

die.result

result: DataItemExistsResult;

dis

dis: object;

dis.query

query: DuplicateItemsQuery;

dis.result

result: DuplicateItemsResult;

dp

dp: object;

dp.query

query: DeletePageQuery;

dp.result

result: DeletePageResult;

dpm

dpm: object;

dpm.query

query: DragPointerMoveQuery;

dpm.result

result: DragPointerMoveResult;

dpu

dpu: object;

dpu.query

query: DragPointerUpQuery;

dpu.result

result: DragPointerUpResult;

dsd

dsd: object;

dsd.query

query: DeleteShapeDataQuery;

dsd.result

result: DeleteShapeDataResult;

dtc

dtc: object;

dtc.query

query: DeleteTableColumnQuery;

dtc.result

result: DeleteTableColumnResult;

dtr

dtr: object;

dtr.query

query: DeleteTableRowQuery;

dtr.result

result: DeleteTableRowResult;

ee

ee: object;

ee.query

query: ElementExistsQuery;

ee.result

result: ElementExistsResult;

ef

ef: object;

ef.query

query: ExecuteFormulaQuery;

ef.result

result: ExecuteFormulaResult;

fas

fas: object;

fas.query

query: FindAvailableSpaceQuery;

fas.result

result: FindAvailableSpaceResult;

fbe

fbe: object;

fbe.query

query: FireBeaconEventQuery;

fbe.result

result: FireBeaconEventResult;

gcl

gcl: object;

gcl.query

query: GetConnectedLinesQuery;

gcl.result

result: GetConnectedLinesResult;

gcp

gcp: object;

gcp.query

query: GetCurrentPageQuery;

gcp.result

result: GetCurrentPageResult;

gcs

gcs: object;

gcs.query

query: GetCustomShapeQuery;

gcs.result

result: GetCustomShapeResult;

gdap

gdap: object;

gdap.query

query: GetDocumentAccessPermissionQuery;

gdap.result

result: GetDocumentAccessPermissionResult;

gdc

gdc: object;

gdc.query

query: GetDocumentChunksQuery;

gdc.result

result: GetDocumentChunksResult;

gdid

gdid: object;

gdid.query

query: GetDocumentIdQuery;

gdid.result

result: GetDocumentIdResult;

gdif

gdif: object;

gdif.query

query: GetDataItemFieldQuery;

gdif.result

result: GetDataItemFieldResult;

gec

gec: object;

gec.query

query: GetEnvironmentConfigQuery;

gec.result

result: GetEnvironmentConfigResult;

get

get: object;

get.query

query: GetElementTypeQuery;

get.result

result: GetElementTypeResult;

gia

gia: object;

gia.query

query: GetItemsAtQuery;

gia.result

result: GetItemsAtResult;

gip

gip: object;

gip.query

query: GetItemPageIdQuery;

gip.result

result: GetItemPageIdResult;

goci

goci: object;

goci.query

query: GetOAuthClientIdQuery;

goci.result

result: GetOAuthClientIdResult;

got

got: object;

got.query

query: GetOAuthTokenQuery;

got.result

result: GetOAuthTokenResult;

gp

gp: object;

gp.query

query: GetPropertyQuery;

gp.result

result: GetPropertyResult;

gpr

gpr: object;

gpr.query

query: GetProductQuery;

gpr.result

result: GetProductResult;

gps

gps: object;

gps.query

query: GetPackageSettingsQuery;

gps.result

result: GetPackageSettingsResult;

grk

grk: object;

grk.query

query: GetReferenceKeyQuery;

grk.result

result: GetReferenceKeyResult;

grlp

grlp: object;

grlp.query

query: GetRelativeLinePositionQuery;

grlp.result

result: GetRelativeLinePositionResult;

gs

gs: object;

gs.query

query: GetSelectionQuery;

gs.result

result: GetSelectionResult;

gsd

gsd: object;

gsd.query

query: GetShapeDataQuery;

gsd.result

result: GetShapeDataResult;

gsvg

gsvg: object;

gsvg.query

query: GetSvgQuery;

gsvg.result

result: GetSvgResult;

gts

gts: object;

gts.query

query: GetTextStyleQuery;

gts.result

result: GetTextStyleResult;

guid

guid: object;

guid.query

query: GetUserIdQuery;

guid.result

result: GetUserIdResult;

gvr

gvr: object;

gvr.query

query: GetVisibleRectQuery;

gvr.result

result: GetVisibleRectResult;

hac

hac: object;

hac.query

query: HookAllChangesQuery;

hac.result

result: HookAllChangesResult;

hci

hci: object;

hci.query

query: HookCreateItemsQuery;

hci.result

result: HookCreateItemsResult;

hdi

hdi: object;

hdi.query

query: HookDeleteItemsQuery;

hdi.result

result: HookDeleteItemsResult;

hm

hm: object;

hm.query

query: HideModalQuery;

hm.result

result: HideModalResult;

hp

hp: object;

hp.query

query: HidePanelQuery;

hp.result

result: HidePanelResult;

hs

hs: object;

hs.query

query: HookSelectionQuery;

hs.result

result: HookSelectionResult;

hsh

hsh: object;

hsh.query

query: CalculateHashQuery;

hsh.result

result: CalculateHashResult;

hte

hte: object;

hte.query

query: HookTextEditQuery;

hte.result

result: HookTextEditResult;

ic

ic: object;

ic.query

query: ImportCardsQuery;

ic.result

result: ImportCardsResult;

il

il: object;

il.query

query: ImportLinksQuery;

il.result

result: ImportLinksResult;

imp

imp: object;

imp.query

query: ImportPageQuery;

imp.result

result: ImportPageResult;

k

k: object;

k.query

query: KillExtensionQuery;

k.result

result: KillExtensionResult;

lb

lb: object;

lb.query

query: ListChildrenQuery;

lb.result

result: ListChildrenResult;

lbc

lbc: object;

lbc.query

query: LoadBlockClassesQuery;

lbc.result

result: LoadBlockClassesResult;

lc

lc: object;

lc.query

query: ListCollectionsQuery;

lc.result

result: ListCollectionsResult;

lcf

lcf: object;

lcf.query

query: ListCollectionFieldsQuery;

lcf.result

result: ListCollectionFieldsResult;

lde

lde: object;

lde.query

query: ListDocumentElementsQuery;

lde.result

result: ListDocumentElementsResult;

ldi

ldi: object;

ldi.query

query: ListDataItemsQuery;

ldi.result

result: ListDataItemsResult;

lds

lds: object;

lds.query

query: ListDataSourcesQuery;

lds.result

result: ListDataSourcesResult;

lg

lg: object;

lg.query

query: ListChildrenQuery;

lg.result

result: ListChildrenResult;

ll

ll: object;

ll.query

query: ListChildrenQuery;

ll.result

result: ListChildrenResult;

llm

llm: object;

llm.query

query: GetLLMContextFromItemsQuery;

llm.result

result: GetLLMContextFromItemsResult;

log

log: object;

log.query

query: JsonSerializable;

log.result

result: JsonSerializable;

lp

lp: object;

lp.query

query: ListPagesQuery;

lp.result

result: ListPagesResult;

lpr

lpr: object;

lpr.query

query: ListPropertiesQuery;

lpr.result

result: ListPropertiesResult;

lrk

lrk: object;

lrk.query

query: ListReferenceKeysQuery;

lrk.result

result: ListReferenceKeysResult;

lsd

lsd: object;

lsd.query

query: ListShapeDataQuery;

lsd.result

result: ListShapeDataResult;

lta

lta: object;

lta.query

query: ListTextAreasQuery;

lta.result

result: ListTextAreasResult;

luma

luma: object;

luma.query

query: AddDiagramFromLumaQuery;

luma.result

result: AddDiagramFromLumaResult;

mt

mt: object;

mt.query

query: MeasureTextQuery;

mt.result

result: MeasureTextResult;

oauth

oauth: object;

oauth.query

query: SendOAuthRequestQuery;

oauth.result

result: SendOAuthRequestResponse;

oi

oi: object;

oi.query

query: OffsetItemsQuery;

oi.result

result: OffsetItemsResult;

p

p: object;

p.query

query: PromptQuery;

p.result

result: PromptResult;

pdf

pdf: object;

pdf.query

query: StartPDFUploadRequestQuery;

pdf.result

result: StartPDFUploadRequestResponse;

pdi

pdi: object;

pdi.query

query: PatchDataItemsQuery;

pdi.result

result: PatchDataItemsResult;

perm

perm: object;

perm.query

query: SendPermanentTokenRequestQuery;

perm.result

result: SendOAuthRequestResponse;

r

r: object;

r.query

query: ReloadExtensionQuery;

r.result

result: ReloadExtensionResult;

rp

rp: object;

rp.query

query: RegisterPanelQuery;

rp.result

result: RegisterPanelResult;

ru

ru: object;

ru.query

query: RegisterUnfurlQuery;

ru.result

result: RegisterUnfurlResult;

scp

scp: object;

scp.query

query: SetCurrentPageQuery;

scp.result

result: SetCurrentPageResult;

sdc

sdc: object;

sdc.query

query: StartDragBlockToCanvasQuery;

sdc.result

result: StartDragBlockToCanvasResult;

sleep

sleep: object;

sleep.query

query: SleepForTestCaseQuery;

sleep.result

result: SleepForTestCaseResult;

sm

sm: object;

sm.query

query: ShowModalQuery;

sm.result

result: ShowModalResult;

sp

sp: object;

sp.query

query: SetPropertyQuery;

sp.result

result: SetPropertyResult;

spn

spn: object;

spn.query

query: ShowPanelQuery;

spn.result

result: ShowPanelResult;

sps

sps: object;

sps.query

query: SetPackageSettingsQuery;

sps.result

result: SetPackageSettingsResult;

spsm

spsm: object;

spsm.query

query: ShowPackageSettingsModalQuery;

spsm.result

result: ShowPackageSettingsModalResult;

srk

srk: object;

srk.query

query: SetReferenceKeyQuery;

srk.result

result: SetReferenceKeyResult;

ss

ss: object;

ss.query

query: SetSelectionQuery;

ss.result

result: SetSelectionResult;

ssd

ssd: object;

ssd.query

query: SetShapeDataQuery;

ssd.result

result: SetShapeDataResult;

st

st: object;

st.query

query: SetTextQuery;

st.result

result: SetTextResult;

sts

sts: object;

sts.query

query: SetTextStyleQuery;

sts.result

result: SetTextStyleResult;

suim

suim: object;

suim.query

query: SendUIMessageQuery;

suim.result

result: SendUIMessageResult;

tauth

tauth: object;

tauth.query

query: TriggerAuthFlowQuery;

tauth.result

result: TriggerAuthFlowResult;

throw

throw: object;

throw.query

query: ThrowForTestCaseQuery;

throw.result

result: ThrowForTestCaseResult;

uac

uac: object;

uac.query

query: UnhookAllChangesQuery;

uac.result

result: UnhookAllChangesResult;

uci

uci: object;

uci.query

query: UnhookCreateItemsQuery;

uci.result

result: UnhookCreateItemsResult;

udi

udi: object;

udi.query

query: UnhookDeleteItemsQuery;

udi.result

result: UnhookDeleteItemsResult;

us

us: object;

us.query

query: UnhookSelectionQuery;

us.result

result: UnhookSelectionResult;

ute

ute: object;

ute.query

query: UnhookTextEditQuery;

ute.result

result: UnhookTextEditResult;

wm

wm: object;

wm.query

query: WithMutexQuery;

wm.result

result: WithMutexResult;

wsa

wsa: object;

wsa.query

query: WithSilentActionsQuery;

wsa.result

result: WithSilentActionsResult;

xhr

xhr: object;

xhr.query

query: SendXHRQuery;

xhr.result

result: SendXHRResponse;

z

z: object;

z.query

query: ZOrderQuery;

z.result

result: ZOrderResult;