Skip to main content

@dialstack/sdk / react / DialPlanProps

Interface: DialPlanProps

Defined in: sdk/src/react/DialPlan.tsx:69

Properties​

className?​

optional className?: string;

Defined in: sdk/src/react/DialPlan.tsx:93

Optional CSS class name for the container

dialPlanId?​

optional dialPlanId?: string;

Defined in: sdk/src/react/DialPlan.tsx:71

The ID of the dial plan to fetch and display

locale?​

optional locale?: DialPlanLocale;

Defined in: sdk/src/react/DialPlan.tsx:75

Locale strings for node labels and exits

mode?​

optional mode?: DialPlanMode;

Defined in: sdk/src/react/DialPlan.tsx:73

Display mode: 'view' (default), 'edit', or 'preview' (static thumbnail)

onCreateResource?​

optional onCreateResource?: (type, options?) => Promise<
  | {
  extension_number?: string;
  id: string;
  name: string;
}
| undefined>;

Defined in: sdk/src/react/DialPlan.tsx:102

Optional callback to create a new resource from a config panel select. Provided by the host app. options carries per-type hints (currently notifyEligible for voice apps) so the create dialog can skip choices incompatible with the current edit context.

Parameters​

type​

ResourceType

options?​

ListResourcesOptions

Returns​

Promise< | { extension_number?: string; id: string; name: string; } | undefined>

onDirtyChange?​

optional onDirtyChange?: (isDirty) => void;

Defined in: sdk/src/react/DialPlan.tsx:87

Callback fired when dirty state changes (edit mode)

Parameters​

isDirty​

boolean

Returns​

void

onError?​

optional onError?: (error) => void;

Defined in: sdk/src/react/DialPlan.tsx:89

Alias for onLoadError, used in edit mode

Parameters​

error​

Error

Returns​

void

onLoaderEnd?​

optional onLoaderEnd?: (dialPlan) => void;

Defined in: sdk/src/react/DialPlan.tsx:81

Callback fired when the dial plan finishes loading

Parameters​

dialPlan​

DialPlanData

Returns​

void

onLoadError?​

optional onLoadError?: (error) => void;

Defined in: sdk/src/react/DialPlan.tsx:83

Callback fired when there's an error

Parameters​

error​

Error

Returns​

void

onLoaderStart?​

optional onLoaderStart?: () => void;

Defined in: sdk/src/react/DialPlan.tsx:79

Callback fired when the dial plan starts loading

Returns​

void

onNodeClick?​

optional onNodeClick?: (nodeId, node) => void;

Defined in: sdk/src/react/DialPlan.tsx:77

Callback fired when a node is clicked (view mode)

Parameters​

nodeId​

string

node​

DialPlanNode

Returns​

void

onOpenResource?​

optional onOpenResource?: (resourceId) => void;

Defined in: sdk/src/react/DialPlan.tsx:107

Optional callback to open a resource in a new tab. Provided by the host app.

Parameters​

resourceId​

string

Returns​

void

onSave?​

optional onSave?: (dialPlan) => void;

Defined in: sdk/src/react/DialPlan.tsx:85

Callback fired when the dial plan is saved (edit mode)

Parameters​

dialPlan​

DialPlanData

Returns​

void

style?​

optional style?: CSSProperties;

Defined in: sdk/src/react/DialPlan.tsx:95

Optional inline styles for the container

theme?​

optional theme?: "light" | "dark";

Defined in: sdk/src/react/DialPlan.tsx:91

Color theme: 'light' (default) or 'dark'