MobileServiceClient.InvokeApiAsync Method (String, JToken, HttpMethod, IDictionary<String, String>)

Invokes a user-defined custom API of a Azure Mobile Service using the specified HTTP method. 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

public Task<JToken> InvokeApiAsync(
    string apiName,
    JToken body,
    HttpMethod method,
    IDictionary<string, string> parameters
)

public:
virtual Task<JToken^>^ InvokeApiAsync(
    String^ apiName,
    JToken^ body,
    HttpMethod^ method,
    IDictionary<String^, String^>^ parameters
) sealed

abstract InvokeApiAsync : 
        apiName:string *
        body:JToken *
        method:HttpMethod *
        parameters:IDictionary<string, string> -> Task<JToken>
override InvokeApiAsync : 
        apiName:string *
        body:JToken *
        method:HttpMethod *
        parameters:IDictionary<string, string> -> Task<JToken>

Public Function InvokeApiAsync (
    apiName As String,
    body As JToken,
    method As HttpMethod,
    parameters As IDictionary(Of String, String)
) As Task(Of JToken)

Parameters

• apiName
  Type: System.String

  The name of the custom API.

• body
  Type: Newtonsoft.Json.Linq.JToken

  The value to be sent as the HTTP body.

• method
  Type: System.Net.Http.HttpMethod

  The HTTP Method.

• 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<JToken>

The response content from the custom api invocation.

Implements

IMobileServiceClient.InvokeApiAsync(String, JToken, HttpMethod, IDictionary<String, String>)

See Also

InvokeApiAsync Overload
MobileServiceClient Class
Microsoft.WindowsAzure.MobileServices Namespace

Return to top