interface ITaskApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    appendLogContent(
        customHeaders: any,
        contentStream: ReadableStream,
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        logId: number,
    ): Promise<TaskLog>;
    appendTimelineRecordFeed(
        lines: TimelineRecordFeedLinesWrapper,
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        recordId: string,
    ): Promise<void>;
    associateLog(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        logId: number,
        serializedBlobId: string,
        lineCount: number,
    ): Promise<TaskLog>;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createAttachment(
        customHeaders: any,
        contentStream: ReadableStream,
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        recordId: string,
        type: string,
        name: string,
    ): Promise<TaskAttachment>;
    createAttachmentFromArtifact(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        recordId: string,
        type: string,
        name: string,
        artifactHash: string,
        length: number,
    ): Promise<TaskAttachment>;
    createLog(
        log: TaskLog,
        scopeIdentifier: string,
        hubName: string,
        planId: string,
    ): Promise<TaskLog>;
    createOidcToken(
        claims: { [key: string]: string },
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        jobId: string,
        serviceConnectionId?: string,
    ): Promise<TaskHubOidcToken>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createTimeline(
        timeline: Timeline,
        scopeIdentifier: string,
        hubName: string,
        planId: string,
    ): Promise<Timeline>;
    deleteTimeline(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
    ): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getAttachment(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        recordId: string,
        type: string,
        name: string,
    ): Promise<TaskAttachment>;
    getAttachmentContent(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        recordId: string,
        type: string,
        name: string,
    ): Promise<ReadableStream>;
    getAttachments(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        recordId: string,
        type: string,
    ): Promise<TaskAttachment[]>;
    getJobInstance(
        scopeIdentifier: string,
        hubName: string,
        orchestrationId: string,
    ): Promise<TaskAgentJob>;
    getLines(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        recordId: string,
        stepId: string,
        endLine?: number,
        takeCount?: number,
        continuationToken?: string,
    ): Promise<TimelineRecordFeedLinesWrapper>;
    getLog(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        logId: number,
        startLine?: number,
        endLine?: number,
    ): Promise<string[]>;
    getLogs(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
    ): Promise<TaskLog[]>;
    getPlan(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
    ): Promise<TaskOrchestrationPlan>;
    getPlanAttachments(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        type: string,
    ): Promise<TaskAttachment[]>;
    getPlanGroupsQueueMetrics(
        scopeIdentifier: string,
        hubName: string,
    ): Promise<TaskOrchestrationPlanGroupsQueueMetrics[]>;
    getQueuedPlanGroup(
        scopeIdentifier: string,
        hubName: string,
        planGroup: string,
    ): Promise<TaskOrchestrationQueuedPlanGroup>;
    getQueuedPlanGroups(
        scopeIdentifier: string,
        hubName: string,
        statusFilter?: PlanGroupStatus,
        count?: number,
    ): Promise<TaskOrchestrationQueuedPlanGroup[]>;
    getRecords(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        changeId?: number,
    ): Promise<TimelineRecord[]>;
    getTimeline(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
        changeId?: number,
        includeRecords?: boolean,
    ): Promise<Timeline>;
    getTimelines(
        scopeIdentifier: string,
        hubName: string,
        planId: string,
    ): Promise<Timeline[]>;
    updateRecords(
        records: VssJsonCollectionWrapperV<TimelineRecord[]>,
        scopeIdentifier: string,
        hubName: string,
        planId: string,
        timelineId: string,
    ): Promise<TimelineRecord[]>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl: string
http: HttpClient
rest: RestClient
userAgent: string
vsoClient: VsoClient

Methods

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • logId: number

    Returns Promise<TaskLog>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • logId: number
    • serializedBlobId: string
    • lineCount: number

    Returns Promise<TaskLog>

  • Parameters

    • customHeaders: any
    • contentStream: ReadableStream
    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • timelineId: string
    • recordId: string
    • type: string
    • name: string

    Returns Promise<TaskAttachment>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • timelineId: string
    • recordId: string
    • type: string
    • name: string
    • artifactHash: string
    • length: number

    Returns Promise<TaskAttachment>

  • Parameters

    • claims: { [key: string]: string }
    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • jobId: string
    • OptionalserviceConnectionId: string

    Returns Promise<TaskHubOidcToken>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • timelineId: string

    Returns Promise<void>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • timelineId: string
    • recordId: string
    • type: string
    • name: string

    Returns Promise<TaskAttachment>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • timelineId: string
    • recordId: string
    • type: string
    • name: string

    Returns Promise<ReadableStream>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • timelineId: string
    • recordId: string
    • type: string

    Returns Promise<TaskAttachment[]>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • timelineId: string
    • recordId: string
    • stepId: string
    • OptionalendLine: number
    • OptionaltakeCount: number
    • OptionalcontinuationToken: string

    Returns Promise<TimelineRecordFeedLinesWrapper>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • logId: number
    • OptionalstartLine: number
    • OptionalendLine: number

    Returns Promise<string[]>

  • Parameters

    • scopeIdentifier: string
    • hubName: string
    • planId: string
    • timelineId: string
    • OptionalchangeId: number
    • OptionalincludeRecords: boolean

    Returns Promise<Timeline>