Skip to main content

@slack/web-api / EntityPresentDetailsArguments

Type Alias: EntityPresentDetailsArguments

type EntityPresentDetailsArguments = TokenOverridable & object;

Defined in: src/types/request/entity.ts:5

Type Declaration​

error?​

optional error: object;

Description​

Error response preventing flexpane data from being returned.

error.actions?​

optional actions: EntityActionButton[];
Description​

Set of action buttons to be shown in case of a specific error.

error.custom_message?​

optional custom_message: string;
Description​

If status is 'custom', you can use this field to provide a message to the client.

error.custom_title?​

optional custom_title: string;
Description​

If status is 'custom', you can use this field to provide a title to the client.

error.message_format?​

optional message_format: string;
Description​

String format, eg. 'markdown'.

error.status​

status: string;
Description​

Error status indicating why the entity could not be presented.

metadata?​

optional metadata: EntityMetadata;

Description​

Entity metadata to be presented in the flexpane.

trigger_id​

trigger_id: string;

Description​

A reference to the original user action that initated the request.

user_auth_required?​

optional user_auth_required: boolean;

Description​

Set user_auth_required to true to indicate that the user must authenticate to view the full flexpane data. Defaults to false.

user_auth_url?​

optional user_auth_url: string;

Description​

A custom URL to which users are directed for authentication if required. Example: "https://example.com/onboarding?user_id=xxx"