Interface HistoryMetadata

Details of issue history metadata.

interface HistoryMetadata {
    activityDescription?: string;
    activityDescriptionKey?: string;
    actor?: HistoryMetadataParticipant;
    cause?: HistoryMetadataParticipant;
    description?: string;
    descriptionKey?: string;
    emailDescription?: string;
    emailDescriptionKey?: string;
    extraData?: {
        [key: string]: string;
    };
    generator?: HistoryMetadataParticipant;
    type?: string;
}

Hierarchy

  • Record<string, unknown>
    • HistoryMetadata

Properties

activityDescription? activityDescriptionKey? actor? cause? description? descriptionKey? emailDescription? emailDescriptionKey? extraData? generator? type?

Properties

OptionalactivityDescription

activityDescription?: string

The activity described in the history record.

OptionalactivityDescriptionKey

activityDescriptionKey?: string

The key of the activity described in the history record.

Optionalactor

actor?: HistoryMetadataParticipant

Details of the user whose action created the history record.

Optionalcause

cause?: HistoryMetadataParticipant

Details of the cause that triggered the creation the history record.

Optionaldescription

description?: string

The description of the history record.

OptionaldescriptionKey

descriptionKey?: string

The description key of the history record.

OptionalemailDescription

emailDescription?: string

The description of the email address associated the history record.

OptionalemailDescriptionKey

emailDescriptionKey?: string

The description key of the email address associated the history record.

OptionalextraData

extraData?: {
    [key: string]: string;
}

Additional arbitrary information about the history record.

Optionalgenerator

generator?: HistoryMetadataParticipant

Details of the system that generated the history record.

Optionaltype

type?: string

The type of the history record.

Settings

Member Visibility

On This Page

Properties