Interface SourceControlHistoryProvider

interface SourceControlHistoryProvider {
    currentHistoryItemBaseRef?: SourceControlHistoryItemRef;
    currentHistoryItemRef?: SourceControlHistoryItemRef;
    currentHistoryItemRemoteRef?: SourceControlHistoryItemRef;
    onDidChangeCurrentHistoryItemRefs: Event<void>;
    onDidChangeHistoryItemRefs: Event<SourceControlHistoryItemRefsChangeEvent>;
    provideHistoryItemChanges(
        historyItemId: string,
        historyItemParentId: undefined | string,
        token: CancellationToken,
    ): ProviderResult<SourceControlHistoryItemChange[]>;
    provideHistoryItemRefs(
        historyItemRefs: undefined | string[],
        token: CancellationToken,
    ): ProviderResult<SourceControlHistoryItemRef[]>;
    provideHistoryItems(
        options: SourceControlHistoryOptions,
        token: CancellationToken,
    ): ProviderResult<SourceControlHistoryItem[]>;
    resolveHistoryItem(
        historyItemId: string,
        token: CancellationToken,
    ): ProviderResult<SourceControlHistoryItem>;
    resolveHistoryItemRefsCommonAncestor(
        historyItemRefs: string[],
        token: CancellationToken,
    ): ProviderResult<string>;
}

Index

Properties

currentHistoryItemBaseRef? currentHistoryItemRef? currentHistoryItemRemoteRef? onDidChangeCurrentHistoryItemRefs onDidChangeHistoryItemRefs

Methods

provideHistoryItemChanges provideHistoryItemRefs provideHistoryItems resolveHistoryItem resolveHistoryItemRefsCommonAncestor

Properties

`Optional` `Readonly`currentHistoryItemBaseRef

currentHistoryItemBaseRef?: SourceControlHistoryItemRef

`Optional` `Readonly`currentHistoryItemRef

currentHistoryItemRef?: SourceControlHistoryItemRef

`Optional` `Readonly`currentHistoryItemRemoteRef

currentHistoryItemRemoteRef?: SourceControlHistoryItemRef

`Readonly`onDidChangeCurrentHistoryItemRefs

onDidChangeCurrentHistoryItemRefs: Event<void>

`Readonly`onDidChangeHistoryItemRefs

onDidChangeHistoryItemRefs: Event<SourceControlHistoryItemRefsChangeEvent>

Methods

provideHistoryItemChanges

provideHistoryItemChanges(
    historyItemId: string,
    historyItemParentId: undefined | string,
    token: CancellationToken,
): ProviderResult<SourceControlHistoryItemChange[]>
Parameters
- historyItemId: string
- historyItemParentId: undefined | string
- token: CancellationToken
Returns ProviderResult<SourceControlHistoryItemChange[]>
- Defined in packages/plugin/src/theia.d.ts:12773

provideHistoryItemRefs

provideHistoryItemRefs(
historyItemRefs: undefined | string[],
token: CancellationToken,
): ProviderResult<SourceControlHistoryItemRef[]>
Parameters
- historyItemRefs: undefined | string[]
- token: CancellationToken
Returns ProviderResult<SourceControlHistoryItemRef[]>
- Defined in packages/plugin/src/theia.d.ts:12771

provideHistoryItems

provideHistoryItems(
options: SourceControlHistoryOptions,
token: CancellationToken,
): ProviderResult<SourceControlHistoryItem[]>
Parameters
- options: SourceControlHistoryOptions
- token: CancellationToken
Returns ProviderResult<SourceControlHistoryItem[]>
- Defined in packages/plugin/src/theia.d.ts:12772

resolveHistoryItem

resolveHistoryItem(
historyItemId: string,
token: CancellationToken,
): ProviderResult<SourceControlHistoryItem>
Parameters
- historyItemId: string
- token: CancellationToken
Returns ProviderResult<SourceControlHistoryItem>
- Defined in packages/plugin/src/theia.d.ts:12774

resolveHistoryItemRefsCommonAncestor

resolveHistoryItemRefsCommonAncestor(
historyItemRefs: string[],
token: CancellationToken,
): ProviderResult<string>
Parameters
- historyItemRefs: string[]
- token: CancellationToken
Returns ProviderResult<string>
- Defined in packages/plugin/src/theia.d.ts:12775