Class FeedManagementApi

Hierarchy

FeedManagementApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FeedManagementApi(basePath?: string): FeedManagementApi

- Defined in api/api.ts:43766
Parameters
- Optional basePath: string
Returns FeedManagementApi

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

createFeed

createFeed(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Feed>

- Defined in api/api.ts:43781
Create a feed, a container for various package types.

Parameters
- params: object
  - apiVersion: string
  - body: Feed
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Feed>

createFeedView

createFeedView(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<FeedView>

- Defined in api/api.ts:43836
Create a new view on the referenced feed.

Parameters
- params: object
  - apiVersion: string
  - body: FeedView
  - feedId: string
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<FeedView>

deleteFeed

deleteFeed(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:43895
Remove a feed and all its packages. The action does not result in packages moving to the RecycleBin and is not reversible.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

deleteFeedView

deleteFeedView(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<__type>

- Defined in api/api.ts:43948
Delete a feed view.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - viewId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<__type>

getFeed

getFeed(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Feed>

- Defined in api/api.ts:44006
Get the settings for a specific feed.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - Optional includeDeletedUpstreams?: boolean
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Feed>

getFeedPermissions

getFeedPermissions(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<FeedPermission>>

- Defined in api/api.ts:44065
Get the permissions for a feed.

Parameters
- params: object
  - apiVersion: string
  - Optional excludeInheritedPermissions?: boolean
  - feedId: string
  - Optional identityDescriptor?: string
  - Optional includeIds?: boolean
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<FeedPermission>>

getFeedView

getFeedView(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<FeedView>

- Defined in api/api.ts:44130
Get a view by Id.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
  - viewId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<FeedView>

getFeedViews

getFeedViews(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<FeedView>>

- Defined in api/api.ts:44187
Get all views for a feed.

Parameters
- params: object
  - apiVersion: string
  - feedId: string
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<FeedView>>

getFeeds

getFeeds(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Feed>>

- Defined in api/api.ts:44240
Get all feeds in an account where you have the provided role access.

Parameters
- params: object
  - apiVersion: string
  - Optional feedRole?: string
  - Optional includeDeletedUpstreams?: boolean
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<Feed>>

setFeedPermissions

setFeedPermissions(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<FeedPermission>>

- Defined in api/api.ts:44296
Update the permissions on a feed.

Parameters
- params: object
  - apiVersion: string
  - body: Array<FeedPermission>
  - feedId: string
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<FeedPermission>>

updateFeed

updateFeed(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Feed>

- Defined in api/api.ts:44356
Change the attributes of a feed.

Parameters
- params: object
  - apiVersion: string
  - body: FeedUpdate
  - feedId: string
  - organization: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Feed>

updateFeedView

updateFeedView(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<FeedView>

- Defined in api/api.ts:44417
Update a view.

Parameters
- params: object
  - apiVersion: string
  - body: FeedView
  - feedId: string
  - organization: string
  - viewId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<FeedView>

Generated using TypeDoc