Interface ScmHistoryProvider

interface ScmHistoryProvider {
    currentHistoryItemBaseRef?: ScmHistoryItemRef;
    currentHistoryItemRef?: ScmHistoryItemRef;
    currentHistoryItemRemoteRef?: ScmHistoryItemRef;
    onDidChangeCurrentHistoryItemRefs: Event<void>;
    onDidChangeHistoryItemRefs: Event<ScmHistoryItemRefsChangeEvent>;
    provideHistoryItemChanges(
        historyItemId: string,
        historyItemParentId: undefined | string,
        token: CancellationToken,
    ): Promise<undefined | ScmHistoryItemChange[]>;
    provideHistoryItemRefs(
        historyItemRefs: undefined | string[],
        token: CancellationToken,
    ): Promise<undefined | ScmHistoryItemRef[]>;
    provideHistoryItems(
        options: ScmHistoryOptions,
        token: CancellationToken,
    ): Promise<undefined | ScmHistoryItem[]>;
    resolveHistoryItem(
        historyItemId: string,
        token: CancellationToken,
    ): Promise<undefined | ScmHistoryItem>;
    resolveHistoryItemRefsCommonAncestor(
        historyItemRefs: string[],
        token: CancellationToken,
    ): Promise<undefined | string>;
}

Implemented by

PluginScmHistoryProvider

Index

Properties

currentHistoryItemBaseRef? currentHistoryItemRef? currentHistoryItemRemoteRef? onDidChangeCurrentHistoryItemRefs onDidChangeHistoryItemRefs

Methods

provideHistoryItemChanges provideHistoryItemRefs provideHistoryItems resolveHistoryItem resolveHistoryItemRefsCommonAncestor

Properties

`Optional` `Readonly`currentHistoryItemBaseRef

currentHistoryItemBaseRef?: ScmHistoryItemRef

`Optional` `Readonly`currentHistoryItemRef

currentHistoryItemRef?: ScmHistoryItemRef

`Optional` `Readonly`currentHistoryItemRemoteRef

currentHistoryItemRemoteRef?: ScmHistoryItemRef

`Readonly`onDidChangeCurrentHistoryItemRefs

onDidChangeCurrentHistoryItemRefs: Event<void>

`Readonly`onDidChangeHistoryItemRefs

onDidChangeHistoryItemRefs: Event<ScmHistoryItemRefsChangeEvent>

Methods

provideHistoryItemChanges

provideHistoryItemChanges(
    historyItemId: string,
    historyItemParentId: undefined | string,
    token: CancellationToken,
): Promise<undefined | ScmHistoryItemChange[]>
Parameters
- historyItemId: string
- historyItemParentId: undefined | string
- token: CancellationToken
Returns Promise<undefined | ScmHistoryItemChange[]>
- Defined in packages/scm/src/browser/scm-provider.ts:169

provideHistoryItemRefs

provideHistoryItemRefs(
historyItemRefs: undefined | string[],
token: CancellationToken,
): Promise<undefined | ScmHistoryItemRef[]>
Parameters
- historyItemRefs: undefined | string[]
- token: CancellationToken
Returns Promise<undefined | ScmHistoryItemRef[]>
- Defined in packages/scm/src/browser/scm-provider.ts:167

provideHistoryItems

provideHistoryItems(
options: ScmHistoryOptions,
token: CancellationToken,
): Promise<undefined | ScmHistoryItem[]>
Parameters
- options: ScmHistoryOptions
- token: CancellationToken
Returns Promise<undefined | ScmHistoryItem[]>
- Defined in packages/scm/src/browser/scm-provider.ts:168

resolveHistoryItem

resolveHistoryItem(
historyItemId: string,
token: CancellationToken,
): Promise<undefined | ScmHistoryItem>
Parameters
- historyItemId: string
- token: CancellationToken
Returns Promise<undefined | ScmHistoryItem>
- Defined in packages/scm/src/browser/scm-provider.ts:170

resolveHistoryItemRefsCommonAncestor

resolveHistoryItemRefsCommonAncestor(
historyItemRefs: string[],
token: CancellationToken,
): Promise<undefined | string>
Parameters
- historyItemRefs: string[]
- token: CancellationToken
Returns Promise<undefined | string>
- Defined in packages/scm/src/browser/scm-provider.ts:171