/** * ------------------------------------------------------------------------------------------- * Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. * See License in the project root for license information. * ------------------------------------------------------------------------------------------- */ /** * @module BatchResponseContent */ /** * @interface * Signature represents key value pair object */ interface KeyValuePairObject { [key: string]: any; } /** * @interface * Signature representing Batch response body * @property {KeyValuePairObject[]} responses - An array of key value pair representing response object for every request * @property {string} [@odata.nextLink] - The nextLink value to get next set of responses in case of asynchronous batch requests */ export interface BatchResponseBody { responses: KeyValuePairObject[]; "@odata.nextLink"?: string; } /** * @class * Class that handles BatchResponseContent */ export declare class BatchResponseContent { /** * To hold the responses */ private responses; /** * Holds the next link url */ private nextLink; /** * @public * @constructor * Creates the BatchResponseContent instance * @param {BatchResponseBody} response - The response body returned for batch request from server * @returns An instance of a BatchResponseContent */ constructor(response: BatchResponseBody); /** * @private * Creates native Response object from the json representation of it. * @param {KeyValuePairObject} responseJSON - The response json value * @returns The Response Object instance */ private createResponseObject; /** * @public * Updates the Batch response content instance with given responses. * @param {BatchResponseBody} response - The response json representing batch response message * @returns Nothing */ update(response: BatchResponseBody): void; /** * @public * To get the response of a request for a given request id * @param {string} requestId - The request id value * @returns The Response object instance for the particular request */ getResponseById(requestId: string): Response; /** * @public * To get all the responses of the batch request * @returns The Map of id and Response objects */ getResponses(): Map; /** * @public * To get the iterator for the responses * @returns The Iterable generator for the response objects */ getResponsesIterator(): IterableIterator<[string, Response]>; } export {};