PrizmDoc Viewer v13.14 - Updated
API Reference / Viewer Control / Namespace: PCCViewer / Class: AjaxResponse
In This Topic
    Class: AjaxResponse
    In This Topic

    PCCViewer. AjaxResponse

    new AjaxResponse(response)

    This object provides a public API for AJAX Responses. It should be instantiated with every new AJAX response inside of Viewer Control.

    Parameters:

    Name Type Description
    response Object
    Properties
    Name Type Description
    headers Object
    status Number
    statusText String
    responseText String

    Properties:

    Name Description
    status : Number
    statusText : String
    responseText : String

    Methods

    getResponseHeader(header) → {String}

    Gets the value of a header

    Parameters:

    Name Type Description
    header String

    Returns:

    Type
    String

    Example

    // Get the header with a case-insensitive argument
    var response = new PCCViewer.AjaxResponse({
        headers: { 'Content-Type': 'application/json', 'X-Powered-By': 'Express' },
        status: 200,
        statusText: 'OK',
        responseText: 'Success!'
    });
    
    response.getResponseHeader('Content-Type'); // returns 'application/json'
    response.getResponseHeader('content-type'); // returns 'application/json'
    response.getResponseHeader('CONTENT-TYPE'); // returns 'application/json'
    

    Documentation generated by JSDoc 3.3.3 on Mon Aug 31 2020 17:04:09 GMT-0400 (Eastern Daylight Time)