Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SubscriptionsApi

Hierarchy

  • SubscriptionsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

createSubscription

  • createSubscription(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Subscription>

  • Create a subscription.

    Parameters

    • params: object
      • apiVersion: string
      • body: Subscription
      • organization: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Subscription>

createSubscription_1

  • createSubscription_1(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<NotificationSubscription>

createSubscriptionsQuery

  • createSubscriptionsQuery(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<SubscriptionsQuery>

deleteSubscription

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

  • Delete a specific service hooks subscription.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • subscriptionId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

deleteSubscription_2

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

  • Delete a subscription.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • subscriptionId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<__type>

getSubscription

  • getSubscription(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Subscription>

  • Get a specific service hooks subscription.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • subscriptionId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Subscription>

getSubscriptionTemplates

getSubscription_3

  • Get a notification subscription by its ID.

    Parameters

    • params: object
      • apiVersion: string
      • organization: string
      • Optional queryFlags?: string
      • subscriptionId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<NotificationSubscription>

listSubscriptions

  • listSubscriptions(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Subscription>>

  • Get a list of subscriptions.

    Parameters

    • params: object
      • apiVersion: string
      • Optional consumerActionId?: string
      • Optional consumerId?: string
      • Optional eventType?: string
      • organization: string
      • Optional publisherId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<Subscription>>

listSubscriptions_4

  • Parameters

    • params: object
      • apiVersion: string
      • Optional ids?: string
      • organization: string
      • Optional queryFlags?: string
      • Optional targetId?: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<NotificationSubscription>>

querySubscriptions

replaceSubscription

  • replaceSubscription(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Subscription>

  • Update a subscription. <param name="subscriptionId">ID for a subscription that you wish to update.</param>

    Parameters

    • params: object
      • apiVersion: string
      • body: Subscription
      • organization: string
      • subscriptionId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<Subscription>

updateSubscription

  • Update an existing subscription. Depending on the type of subscription and permissions, the caller can update the description, filter settings, channel (delivery) settings and more.

    Parameters

    Returns Promise<NotificationSubscription>

updateSubscriptionUserSettings

  • updateSubscriptionUserSettings(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<SubscriptionUserSettings>

  • Update the specified user's settings for the specified subscription. This API is typically used to opt in or out of a shared subscription. User settings can only be applied to shared subscriptions, like team subscriptions or default subscriptions.

    Parameters

    • params: object
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<SubscriptionUserSettings>

Generated using TypeDoc