interface INotificationApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    createSubscription(
        createParameters: NotificationSubscriptionCreateParameters,
    ): Promise<NotificationSubscription>;
    deleteSubscription(subscriptionId: string): Promise<void>;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getEventType(eventType: string): Promise<NotificationEventType>;
    getNotificationReasons(notificationId: number): Promise<NotificationReason>;
    getSettings(): Promise<NotificationAdminSettings>;
    getSubscriber(subscriberId: string): Promise<NotificationSubscriber>;
    getSubscription(
        subscriptionId: string,
        queryFlags?: SubscriptionQueryFlags,
    ): Promise<NotificationSubscription>;
    getSubscriptionDiagnostics(
        subscriptionId: string,
    ): Promise<SubscriptionDiagnostics>;
    getSubscriptionTemplates(): Promise<NotificationSubscriptionTemplate[]>;
    listEventTypes(publisherId?: string): Promise<NotificationEventType[]>;
    listLogs(
        source: string,
        entryId?: string,
        startTime?: Date,
        endTime?: Date,
    ): Promise<INotificationDiagnosticLog[]>;
    listNotificationReasons(
        notificationIds?: number,
    ): Promise<NotificationReason[]>;
    listSubscriptions(
        targetId?: string,
        ids?: string[],
        queryFlags?: SubscriptionQueryFlags,
    ): Promise<NotificationSubscription[]>;
    performBatchNotificationOperations(
        operation: BatchNotificationOperation,
    ): Promise<void>;
    publishEvent(
        notificationEvent: VssNotificationEvent,
    ): Promise<VssNotificationEvent>;
    publishTokenEvent(
        notificationEvent: VssNotificationEvent,
    ): Promise<VssNotificationEvent>;
    queryEventTypes(
        inputValuesQuery: FieldValuesQuery,
        eventType: string,
    ): Promise<NotificationEventField[]>;
    querySubscriptions(
        subscriptionQuery: SubscriptionQuery,
    ): Promise<NotificationSubscription[]>;
    transformEvent(
        transformRequest: EventTransformRequest,
    ): Promise<EventTransformResult>;
    updateSettings(
        updateParameters: NotificationAdminSettingsUpdateParameters,
    ): Promise<NotificationAdminSettings>;
    updateSubscriber(
        updateParameters: NotificationSubscriberUpdateParameters,
        subscriberId: string,
    ): Promise<NotificationSubscriber>;
    updateSubscription(
        updateParameters: NotificationSubscriptionUpdateParameters,
        subscriptionId: string,
    ): Promise<NotificationSubscription>;
    updateSubscriptionDiagnostics(
        updateParameters: UpdateSubscripitonDiagnosticsParameters,
        subscriptionId: string,
    ): Promise<SubscriptionDiagnostics>;
    updateSubscriptionUserSettings(
        userSettings: SubscriptionUserSettings,
        subscriptionId: string,
        userId: string,
    ): Promise<SubscriptionUserSettings>;
}

Hierarchy (View Summary)

Implemented by

Properties

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

Methods