Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConsumersApi

Hierarchy

  • ConsumersApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

getConsumer

  • getConsumer(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<Consumer>

  • Get a specific consumer service. Optionally filter out consumer actions that do not support any event types for the specified publisher.

    Parameters

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

    Returns Promise<Consumer>

getConsumerAction

  • getConsumerAction(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ConsumerAction>

  • Get details about a specific consumer action.

    Parameters

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

    Returns Promise<ConsumerAction>

listConsumerActions

  • Get a list of consumer actions for a specific consumer.

    Parameters

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

    Returns Promise<ArrayWrapper<ConsumerAction>>

listConsumers

  • listConsumers(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<Consumer>>

  • Get a list of available service hook consumer services. Optionally filter by consumers that support at least one event type from the specific publisher.

    Parameters

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

    Returns Promise<ArrayWrapper<Consumer>>

Generated using TypeDoc