salesforce-alm/dist/lib/connect/services/ConnectResource.d.ts

This package contains tools, and APIs, for an improved salesforce.com developer experience.

import { JsonCollection } from '@salesforce/ts-types';
/**
 * Describe of a connect api resource
 * T - type of return type for success/failure
 */
export interface ConnectResource<T> {
    /**
     * Fetch the relative url of the connect end point
     */
    fetchRelativeConnectUrl(): Promise<string>;
    /**
     * 'GET' or 'POST'
     */
    getRequestMethod(): string;
    /**
     * This will be called only when this#getRequestMethod() is 'POST'
     * Return the post params in stringified version
     */
    fetchPostParams(): Promise<string>;
    /**
     * Called if the request is successful
     *
     * @param result - the result returned by the request
     */
    handleSuccess(result: JsonCollection): T;
    /**
     * Called if the request errored out
     *
     * @param error - the corresponding error
     */
    handleError(error: Error): T;
}