Solicitud de recursos de aplicaciones Windows

improve this page | report issue

Visión general

Las aplicaciones MobileFirst Operations Console pueden acceder a los recursos utilizando la API REST WorklightResourceRequest.
La API REST funciona con todos los adaptadores y recursos externos.

Requisitos previos:

WLResourceRequest

La clase WorklightResourceRequest maneja solicitudes de recursos para recursos externos o adaptadores.

Cree un objeto WorklightResourceRequest y especifique la vía de acceso al recurso y el método HTTP.
Los métodos disponibles son: GET, POST, PUT y DELETE.

URI adapterPath = new URI("/adapters/JavaAdapter/users",UriKind.Relative);
WorklightResourceRequest request = WorklightClient.ResourceRequest(adapterPath,"GET");
  • Para adaptadores JavaScript, utilice /adapters/{AdapterName}/{procedureName}
  • Para adaptadores Java, utilice /adapters/{AdapterName}/{path}. La vía de acceso depende de la forma en que haya definido sus anotaciones @Path en su código Java. También debería incluir todos los @PathParam que utilice.
  • Para acceder a recursos fuera del proyecto, utilice el URL completo según los requisitos del servidor externo.
  • timeout: Opcional, tiempo de espera de la solicitud en milisegundos.
  • scope: Opcional, ámbito que está protegiendo el recurso. Si especifica este ámbito, podría hacer que la solicitud fuese más eficiente.

Envío de la solicitud

Solicite el recurso mediante el método .send().

WorklightResponse response = await request.send();

Utilice el objeto WorklightResponse response para obtener los datos que se recuperan desde el adaptador.

El objeto response contiene los datos de respuesta. Utilice todos sus métodos y propiedades para recuperar la información necesaria. Las propiedades habitualmente utilizadas son ResponseText, ResponseJSON (si la respuesta está en JSON), Success (si la invocación fue satisfactoria o anómala) y HTTPStatus (el estado HTTP de la respuesta).

Parámetros

Antes de enviar su solicitud, podría desea añadir parámetros según sea necesario.

Parámetros de vía de acceso

Tal como se ha explicado anteriormente, los parámetros de vía de acceso (/path/value1/value2) se establecen durante la creación del objeto WorklightResourceRequest:

Uri adapterPath = new Uri("/adapters/JavaAdapter/users/value1/value2",UriKind.Relative);
WorklightResourceRequest request = WorklightClient.createInstance(adapterPath,"GET");

Parámetros de consulta

Para enviar parámetros de consulta (/path?param1=value1...) utilice el método SetQueryParameter para cada parámetro:

request.SetQueryParameter("param1","value1");
request.SetQueryParameter("param2","value2");

Adaptadores JavaScript

Los adaptadores JavaScript utilizan parámetros sin nombre ordenados. Para pasar parámetros a un adaptador JavaScript, establezca una matriz de parámetros con el nombre params:

request.SetQueryParameter("params","['value1', 'value2']");

Esto se debería utilizar con GET.

Parámetros de formulario

Para enviar parámetros de formulario en el cuerpo, utilice .Send(Dictionary<string, string> formParameters) en lugar de .Send():

Dictionary<string,string> formParams = new Dictionary<string,string>();
formParams.Add("height", height.getText().toString());
request.Send(formParams);

Adaptadores JavaScript

Los adaptadores JavaScript utilizan parámetros sin nombre ordenados. Para pasar parámetros a un adaptador JavaScript, establezca una matriz de parámetros con el nombre params:

formParams.Add("params","['value1', 'value2']");

Esto se debería utilizar con POST.

Parámetros de cabecera

Para enviar un parámetro como una cabecera HTTP utilice la API .SetHeader():

request.SetHeader(KeyValuePair<string,string> header);

Otros parámetros de cuerpo personalizados

  • .Send(requestBody) permite establecer una serie arbitraria en el cuerpo.
  • .Send(JObject json) permite establecer un diccionario arbitrario en el cuerpo.
  • .Send(byte[] data) permite establecer un matriz de bytes arbitraria en el cuerpo.

La respuesta

El objeto WorklightResponse contiene los datos de respuesta. Utilice todos sus métodos y propiedades para recuperar la información necesaria. Las propiedades utilizadas habitualmente son ResponseText (String), ResponseJSON (JSONObject) (si la respuesta está en JSON) y success (boolean) (estado de éxito de la respuesta).

En caso de una respuesta anómala, el objeto de respuesta también contiene una propiedad error.

Para obtener más información

Para obtener más información sobre WLResourceRequest, consulte la API de referencia.https://public.dhe.ibm.com/software/products/en/MobileFirstPlatform/docs/v800/mfpf_csharp_win8_native_client_api.pdf

Imagen de la aplicación de ejemplo

Aplicación de ejemplo

Los proyectos ResourceRequestWin8 y ResourceRequestWin10 contienen una aplicación nativa Windows 8 Universal/Windows 10 UWP que toma una solicitud de recurso mediante un adaptador Java.
El proyecto Maven de adaptador contiene el adaptador Java utilizado durante la llamada de solicitud de recurso.

Pulse para descargar el proyecto de Windows 8.1 Universal.
Pulse para descargar el proyecto de Windows 10 UWP.
Pulse para descargar el proyecto Maven del adaptador.

Uso de ejemplo

Siga el archivo README.md de ejemplo para obtener instrucciones.

Inclusive terminology note: The Mobile First Platform team is making changes to support the IBM® initiative to replace racially biased and other discriminatory language in our code and content with more inclusive language. While IBM values the use of inclusive language, terms that are outside of IBM's direct influence are sometimes required for the sake of maintaining user understanding. As other industry leaders join IBM in embracing the use of inclusive language, IBM will continue to update the documentation to reflect those changes.
Last modified on January 25, 2023