Interface ProblemTypeAlpha

Display information for a problem type.

Providers define multiple problem types (e.g., an Email Integration provider might have 'delivery-failed', 'validation-error', 'attachment-too-large'). ProblemType provides the human-readable display information for each type.

The platform retrieves this information via getType and getTypes to display problems with appropriate titles and icons.

Example

Implementing type methods in a provider

class EmailProblemProvider implements ProblemProvider {
    private types: ProblemType[] = [
        {
            id: 'delivery-failed',
            title: 'Delivery Failed',
            description: 'Email could not be delivered to the recipient',
            icon: 'envelope-exclamation'
        },
        {
            id: 'validation-error',
            title: 'Validation Error'
        }
    ];

    getTypes(): ProblemType[] {
        return this.types;
    }

    getType(type: string): ProblemType | undefined {
        return this.types.find(t => t.id === type);
    }
}

See

• getType
• getTypes
• type