IMobileServiceClient.InvokeApiAsync Method (String, HttpContent, HttpMethod, IDictionary<String, String>, IDictionary<String, String>)

Invokes a user-defined custom API of a Azure Mobile Service using the specified HttpMethod. Additional data can be sent though the HTTP content or the query string.

Namespace:   Microsoft.WindowsAzure.MobileServices
Assembly:  Microsoft.WindowsAzure.Mobile (in Microsoft.WindowsAzure.Mobile.dll)

Syntax

Task<HttpResponseMessage> InvokeApiAsync(
    string apiName,
    HttpContent content,
    HttpMethod method,
    IDictionary<string, string> requestHeaders,
    IDictionary<string, string> parameters
)

Task<HttpResponseMessage^>^ InvokeApiAsync(
    String^ apiName,
    HttpContent^ content,
    HttpMethod^ method,
    IDictionary<String^, String^>^ requestHeaders,
    IDictionary<String^, String^>^ parameters
)

abstract InvokeApiAsync : 
        apiName:string *
        content:HttpContent *
        method:HttpMethod *
        requestHeaders:IDictionary<string, string> *
        parameters:IDictionary<string, string> -> Task<HttpResponseMessage>

Function InvokeApiAsync (
    apiName As String,
    content As HttpContent,
    method As HttpMethod,
    requestHeaders As IDictionary(Of String, String),
    parameters As IDictionary(Of String, String)
) As Task(Of HttpResponseMessage)

Parameters

• apiName
  Type: System.String

  The name of the custom API.

• content
  Type: System.Net.Http.HttpContent

  The HTTP content.

• method
  Type: System.Net.Http.HttpMethod

  The HTTP method.

• requestHeaders
  Type: System.Collections.Generic.IDictionary<String, String>

  A dictionary of user-defined headers to include in the HttpRequest.

• parameters
  Type: System.Collections.Generic.IDictionary<String, String>

  A dictionary of user-defined parameters and values to include in the request URI query string.

Return Value

Type: System.Threading.Tasks.Task<HttpResponseMessage>

The HTTP Response from the custom api invocation.

See Also

InvokeApiAsync Overload
IMobileServiceClient Interface
Microsoft.WindowsAzure.MobileServices Namespace

Return to top