137 строки
10 KiB
YAML
137 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser"
|
|
name: "MethodParser"
|
|
nameWithType: "MethodParser"
|
|
summary: "Representation of a single Direct Method Access collection with a Json serializer and deserializer."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **MethodParser**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.MethodParser()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.MethodParser()"
|
|
name: "MethodParser()"
|
|
nameWithType: "MethodParser.MethodParser()"
|
|
summary: "CONSTRUCTOR Create a Method<wbr>Parser instance with provided values."
|
|
syntax: "public MethodParser()"
|
|
desc: "CONSTRUCTOR Create a MethodParser instance with provided values."
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.MethodParser(java.lang.Object)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.MethodParser(Object payload)"
|
|
name: "MethodParser(Object payload)"
|
|
nameWithType: "MethodParser.MethodParser(Object payload)"
|
|
summary: "CONSTRUCTOR Create a Method<wbr>Parser instance with provided values."
|
|
parameters:
|
|
- description: "- Object that contains the payload defined by the user. It can be <code>null</code>."
|
|
name: "payload"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MethodParser(Object payload)"
|
|
desc: "CONSTRUCTOR Create a MethodParser instance with provided values."
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.MethodParser(java.lang.String,java.lang.Long,java.lang.Long,java.lang.Object)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.MethodParser(String name, Long responseTimeout, Long connectTimeout, Object payload)"
|
|
name: "MethodParser(String name, Long responseTimeout, Long connectTimeout, Object payload)"
|
|
nameWithType: "MethodParser.MethodParser(String name, Long responseTimeout, Long connectTimeout, Object payload)"
|
|
summary: "CONSTRUCTOR Create a Method<wbr>Parser instance with provided values."
|
|
parameters:
|
|
- description: "- method name [required]."
|
|
name: "name"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- maximum interval of time, in seconds, that the Direct Method will wait for answer. It can be <code>null</code>."
|
|
name: "responseTimeout"
|
|
type: "<xref href=\"java.lang.Long?alt=java.lang.Long&text=Long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- maximum interval of time, in seconds, that the Direct Method will wait for the connection. It can be <code>null</code>."
|
|
name: "connectTimeout"
|
|
type: "<xref href=\"java.lang.Long?alt=java.lang.Long&text=Long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "- Object that contains the payload defined by the user. It can be <code>null</code>."
|
|
name: "payload"
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public MethodParser(String name, Long responseTimeout, Long connectTimeout, Object payload)"
|
|
exceptions:
|
|
- description: "This exception is thrown if the one of the provided information do not fits the requirements."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "CONSTRUCTOR Create a MethodParser instance with provided values."
|
|
methods:
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.fromJson(java.lang.String)"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.fromJson(String json)"
|
|
name: "fromJson(String json)"
|
|
nameWithType: "MethodParser.fromJson(String json)"
|
|
summary: "Set the Method collection with the provided information in the json."
|
|
modifiers:
|
|
- "synchronized"
|
|
parameters:
|
|
- description: "- Json with the information to change the collection.\n - If contains `methodName`, it is a full method including `methodName`, `responseTimeoutInSeconds`, `connectTimeoutInSeconds`, and `payload`.\n - If contains `status`, it is a response with `status` and `payload`.\n - Otherwise, it is only `payload`."
|
|
name: "json"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public synchronized void fromJson(String json)"
|
|
exceptions:
|
|
- description: "This exception is thrown if the one of the provided information do not fits the requirements."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Set the Method collection with the provided information in the json."
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.getPayload()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.getPayload()"
|
|
name: "getPayload()"
|
|
nameWithType: "MethodParser.getPayload()"
|
|
summary: "Return an Object with the payload."
|
|
syntax: "public Object getPayload()"
|
|
desc: "Return an Object with the payload."
|
|
returns:
|
|
description: "An Object with the payload. It can be <code>null</code>."
|
|
type: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.getStatus()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.getStatus()"
|
|
name: "getStatus()"
|
|
nameWithType: "MethodParser.getStatus()"
|
|
summary: "Return an Integer with the response status."
|
|
syntax: "public Integer getStatus()"
|
|
exceptions:
|
|
- description: "This exception is thrown if the operation is not type of `response`."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Return an Integer with the response status."
|
|
returns:
|
|
description: "An integer with the status of the response. It can be <code>null</code>."
|
|
type: "<xref href=\"java.lang.Integer?alt=java.lang.Integer&text=Integer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.toJson()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.toJson()"
|
|
name: "toJson()"
|
|
nameWithType: "MethodParser.toJson()"
|
|
summary: "Create a String with a json content that represents all the information in the method collection."
|
|
syntax: "public String toJson()"
|
|
exceptions:
|
|
- description: "This exception is thrown if the one of the provided information do not fits the requirements."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Create a String with a json content that represents all the information in the method collection."
|
|
returns:
|
|
description: "String with the json content."
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.toJsonElement()"
|
|
fullName: "com.microsoft.azure.sdk.iot.deps.serializer.MethodParser.toJsonElement()"
|
|
name: "toJsonElement()"
|
|
nameWithType: "MethodParser.toJsonElement()"
|
|
summary: "Create a Json<wbr>Element with a content that represents all the information in the method collection."
|
|
syntax: "public JsonElement toJsonElement()"
|
|
exceptions:
|
|
- description: "This exception is thrown if the one of the provided information do not fits the requirements."
|
|
type: "<xref href=\"java.lang.IllegalArgumentException?alt=java.lang.IllegalArgumentException&text=IllegalArgumentException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Create a JsonElement with a content that represents all the information in the method collection."
|
|
returns:
|
|
description: "JsonElement with the content."
|
|
type: "<xref href=\"com.google.gson.JsonElement?alt=com.google.gson.JsonElement&text=JsonElement\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Representation of a single Direct Method Access collection with a Json serializer and deserializer."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.sdk.iot.deps.serializer"
|
|
artifact: com.microsoft.azure.sdk.iot:iot-deps:0.12.0
|