Skip navigation

Skip to main content

API reference
Intents: design
API reference

appProcess.requestClose

API reference for the appProcess.requestClose method.

Requests the termination of the specified app process.

Once called, this method:

  1. Transitions the state of the process to "closing".
  2. Invokes all registered setOnDispose callbacks.
  3. Waits for the process to finish closing.
  4. Transitions the state of the process to "closed".

Each time the state changes, all of the registerOnStateChange callbacks are called.

Usage

Close a process

import { appProcess, type AppProcessId } from '@canva/platform';


const placeholderProcessId = "PLACEHOLDER_PROCESS_ID" as AppProcessId;


await appProcess.requestClose(placeholderProcessId, { reason: 'completed' });
TYPESCRIPT

Pass structured data to a process as it closes

import { appProcess, type AppProcessId, type CloseParams } from '@canva/platform';


type DetailedCloseParams = CloseParams & {
  savePoint: string;
  timestamp: number;
  userInitiated: boolean;
};


const placeholderProcessId = "PLACEHOLDER_PROCESS_ID" as AppProcessId;


await appProcess.requestClose<DetailedCloseParams>(placeholderProcessId, {
  reason: 'completed',
  savePoint: 'auto_backup_1',
  timestamp: Date.now(),
  userInitiated: true
});
TYPESCRIPT

Parameters

targetAppProcessId
Required

The ID of an app process.

paramsT
Required

Parameters to pass to the setOnDispose callback. Any kind of structured data can be passed via this property.

reasonCloseReason
Required

The reason the app process is closing.

Available values:

  • "completed"
  • "aborted"

Returns

Promise<void>