Interface ActionGetResponse

Response body payload returned from the initial Action GET Request

note: type is optional for backwards compatibility

interface ActionGetResponse {
    description: string;
    disabled?: boolean;
    error?: ActionError;
    icon: string;
    label: string;
    links?: {
        actions: LinkedAction[];
    };
    title: string;
    type?: "action";
}

Hierarchy

  • Omit<Action, "type">
    • ActionGetResponse

Properties

description disabled? error? icon label links? title type?

Properties

description

description: string

brief summary of the action to be performed

Optionaldisabled

disabled?: boolean

UI state for the button being rendered to the user

Optionalerror

error?: ActionError

non-fatal error message to be displayed to the user

icon

icon: string

image url that represents the source of the action request

label

label: string

button text rendered to the user

Optionallinks

links?: {
    actions: LinkedAction[];
}

Type declaration

  • actions: LinkedAction[]

    list of related Actions a user could perform

title

title: string

describes the source of the action request

Optionaltype

type?: "action"

Settings

Member Visibility

On This Page

Properties