Class NotificationsApi

Hierarchy

NotificationsApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NotificationsApi(basePath?: string): NotificationsApi

- Defined in api/api.ts:51126
Parameters
- Optional basePath: string
Returns NotificationsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createTestNotification

createTestNotification(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Notification>

- Defined in api/api.ts:51142
Sends a test notification. This is useful for verifying the configuration of an updated or new service hooks subscription.

Parameters
- params: object
  - apiVersion: string
  - body: Notification
  - organization: string
  - Optional useRealData?: boolean
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Notification>

getNotification

getNotification(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Notification>

- Defined in api/api.ts:51201
Get a specific notification for a subscription.

Parameters
- params: object
  - apiVersion: string
  - notificationId: number
  - organization: string
  - subscriptionId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<Notification>

getNotifications

getNotifications(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Notification>>

- Defined in api/api.ts:51261
Get a list of notifications for a specific subscription. A notification includes details about the event, the request to and the response from the consumer service.

Parameters
- params: object
  - apiVersion: string
  - Optional maxResults?: number
  - organization: string
  - Optional result?: string
  - Optional status?: string
  - subscriptionId: string
- Optional extraQueryParams: any
- Optional extraFetchParams: any
Returns Promise<ArrayWrapper<Notification>>

queryNotifications

queryNotifications(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<NotificationsQuery>

- Defined in api/api.ts:51325
Query for notifications. A notification includes details about the event, the request to and the response from the consumer service.

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

Generated using TypeDoc