aadhttpclient.yml

### YamlMime:TSType
name: AadHttpClient
uid: '@microsoft/sp-http-base!AadHttpClient:class'
package: '@microsoft/sp-http-base!'
fullName: AadHttpClient
summary: AadHttpClient is used to perform REST calls against an Azure AD Application.
remarks: >-
  This class is marked as `@sealed`. Subclasses should not extend it.


  For communicating with SharePoint, use the [SPHttpClient](xref:@microsoft/sp-http-base!SPHttpClient:class) class
  instead. For communicating with Microsoft Graph, use the
  [MSGraphClient](xref:@microsoft/sp-http-msgraph!MSGraphClient:class) class.
isPreview: false
isDeprecated: false
type: class
constructors:
  - name: '(constructor)(serviceScope, resourceEndpoint, options)'
    uid: '@microsoft/sp-http-base!AadHttpClient:constructor(1)'
    package: '@microsoft/sp-http-base!'
    fullName: '(constructor)(serviceScope, resourceEndpoint, options)'
    summary: Constructs a new instance of the `AadHttpClient` class
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'constructor(serviceScope: ServiceScope, resourceEndpoint: string, options?: IAadHttpClientOptions);'
      parameters:
        - id: serviceScope
          description: The service scope is needed to retrieve some of the class's internal components.
          type: '<xref uid="@microsoft/sp-core-library!ServiceScope:class" />'
        - id: resourceEndpoint
          description: The resource for which the token should be obtained.
          type: string
        - id: options
          description: Configuration options for the request to get an access token.
          type: '<xref uid="@microsoft/sp-http-base!IAadHttpClientOptions:interface" />'
properties:
  - name: configurations
    uid: '@microsoft/sp-http-base!AadHttpClient.configurations:member'
    package: '@microsoft/sp-http-base!'
    fullName: configurations
    summary: The standard predefined AadHttpClientConfiguration objects for use with the AadHttpClient class.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'static readonly configurations: IAadHttpClientConfigurations;'
      return:
        type: '<xref uid="@microsoft/sp-http-base!IAadHttpClientConfigurations:interface" />'
methods:
  - name: 'fetch(url, configuration, options)'
    uid: '@microsoft/sp-http-base!AadHttpClient#fetch:member(1)'
    package: '@microsoft/sp-http-base!'
    fullName: 'fetch(url, configuration, options)'
    summary: Performs a REST service call.
    remarks: >-
      Although the AadHttpClient subclass adds additional enhancements, the parameters and semantics for
      HttpClient.fetch() are essentially the same as the WHATWG API standard that is documented here:
      https://fetch.spec.whatwg.org/
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        fetch(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions):
        Promise<HttpClientResponse>;
      parameters:
        - id: url
          description: The endpoint URL that fetch will be called on.
          type: string
        - id: configuration
          description: >-
            Determines the default behavior of HttpClient; normally this should be the latest version number from
            HttpClientConfigurations.
          type: '<xref uid="@microsoft/sp-http-base!AadHttpClientConfiguration:class" />'
        - id: options
          description: Additional options that affect the request.
          type: '<xref uid="@microsoft/sp-http-base!IHttpClientOptions:interface" />'
      return:
        type: 'Promise&lt;<xref uid="@microsoft/sp-http-base!HttpClientResponse:class" />&gt;'
        description: A promise that will return the result.
  - name: 'get(url, configuration, options)'
    uid: '@microsoft/sp-http-base!AadHttpClient#get:member(1)'
    package: '@microsoft/sp-http-base!'
    fullName: 'get(url, configuration, options)'
    summary: 'Calls fetch(), but sets the method to "GET".'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        get(url: string, configuration: AadHttpClientConfiguration, options?: IHttpClientOptions):
        Promise<HttpClientResponse>;
      parameters:
        - id: url
          description: The endpoint URL that fetch will be called on.
          type: string
        - id: configuration
          description: >-
            Determines the default behavior of HttpClient; normally this should be the latest version number from
            HttpClientConfigurations.
          type: '<xref uid="@microsoft/sp-http-base!AadHttpClientConfiguration:class" />'
        - id: options
          description: Additional options that affect the request.
          type: '<xref uid="@microsoft/sp-http-base!IHttpClientOptions:interface" />'
      return:
        type: 'Promise&lt;<xref uid="@microsoft/sp-http-base!HttpClientResponse:class" />&gt;'
        description: A promise that will return the result.
  - name: 'post(url, configuration, options)'
    uid: '@microsoft/sp-http-base!AadHttpClient#post:member(1)'
    package: '@microsoft/sp-http-base!'
    fullName: 'post(url, configuration, options)'
    summary: 'Calls fetch(), but sets the method to "POST".'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        post(url: string, configuration: AadHttpClientConfiguration, options: IHttpClientOptions):
        Promise<HttpClientResponse>;
      parameters:
        - id: url
          description: The endpoint URL that fetch will be called on.
          type: string
        - id: configuration
          description: >-
            Determines the default behavior of HttpClient; normally this should be the latest version number from
            HttpClientConfigurations.
          type: '<xref uid="@microsoft/sp-http-base!AadHttpClientConfiguration:class" />'
        - id: options
          description: Additional options that affect the request.
          type: '<xref uid="@microsoft/sp-http-base!IHttpClientOptions:interface" />'
      return:
        type: 'Promise&lt;<xref uid="@microsoft/sp-http-base!HttpClientResponse:class" />&gt;'
        description: A promise that will return the result.