interface ICoreApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createConnectedService(
        connectedServiceCreationData: WebApiConnectedServiceDetails,
        projectId: string,
    ): Promise<WebApiConnectedService>;
    createIdentityMru(mruData: IdentityData, mruName: string): Promise<void>;
    createOrUpdateProxy(proxy: Proxy): Promise<Proxy>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createTeam(team: WebApiTeam, projectId: string): Promise<WebApiTeam>;
    deleteIdentityMru(mruData: IdentityData, mruName: string): Promise<void>;
    deleteProxy(proxyUrl: string, site?: string): Promise<void>;
    deleteTeam(projectId: string, teamId: string): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getAllTeams(
        mine?: boolean,
        top?: number,
        skip?: number,
        expandIdentity?: boolean,
    ): Promise<WebApiTeam[]>;
    getConnectedServiceDetails(
        projectId: string,
        name: string,
    ): Promise<WebApiConnectedServiceDetails>;
    getConnectedServices(
        projectId: string,
        kind?: ConnectedServiceKind,
    ): Promise<WebApiConnectedService[]>;
    getIdentityMru(mruName: string): Promise<IdentityRef[]>;
    getProcessById(processId: string): Promise<Process>;
    getProcesses(): Promise<Process[]>;
    getProject(
        projectId: string,
        includeCapabilities?: boolean,
        includeHistory?: boolean,
    ): Promise<TeamProject>;
    getProjectCollection(collectionId: string): Promise<TeamProjectCollection>;
    getProjectCollections(
        top?: number,
        skip?: number,
    ): Promise<TeamProjectCollectionReference[]>;
    getProjectHistoryEntries(minRevision?: number): Promise<ProjectInfo[]>;
    getProjectProperties(
        projectId: string,
        keys?: string[],
    ): Promise<ProjectProperty[]>;
    getProjects(
        stateFilter?: any,
        top?: number,
        skip?: number,
        continuationToken?: number,
        getDefaultTeamImageUrl?: boolean,
    ): Promise<PagedList<TeamProjectReference>>;
    getProjectsProperties(
        projectIds: string[],
        properties?: string[],
    ): Promise<ProjectProperties[]>;
    getProjectTeamsByCategory(
        projectId: string,
        expandIdentity?: boolean,
        top?: number,
        skip?: number,
    ): Promise<CategorizedWebApiTeams>;
    getProxies(proxyUrl?: string): Promise<Proxy[]>;
    getTeam(
        projectId: string,
        teamId: string,
        expandIdentity?: boolean,
    ): Promise<WebApiTeam>;
    getTeamMembersWithExtendedProperties(
        projectId: string,
        teamId: string,
        top?: number,
        skip?: number,
    ): Promise<TeamMember[]>;
    getTeams(
        projectId: string,
        mine?: boolean,
        top?: number,
        skip?: number,
        expandIdentity?: boolean,
    ): Promise<WebApiTeam[]>;
    queueCreateProject(
        projectToCreate: TeamProject,
    ): Promise<OperationReference>;
    queueDeleteProject(projectId: string): Promise<OperationReference>;
    removeProjectAvatar(projectId: string): Promise<void>;
    setProjectAvatar(
        avatarBlob: ProjectAvatar,
        projectId: string,
    ): Promise<void>;
    setProjectProperties(
        customHeaders: any,
        projectId: string,
        patchDocument: JsonPatchDocument,
    ): Promise<void>;
    updateIdentityMru(mruData: IdentityData, mruName: string): Promise<void>;
    updateProject(
        projectUpdate: TeamProject,
        projectId: string,
    ): Promise<OperationReference>;
    updateTeam(
        teamData: WebApiTeam,
        projectId: string,
        teamId: string,
    ): Promise<WebApiTeam>;
}

Hierarchy (View Summary)

Implemented by

Properties

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

Methods

  • Parameters

    • projectId: string
    • Optionalmine: boolean
    • Optionaltop: number
    • Optionalskip: number
    • OptionalexpandIdentity: boolean

    Returns Promise<WebApiTeam[]>