azure-docs-sdk-java/docs-ref-autogen/com.azure.communication.sms...

104 строки
6.5 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.communication.sms.models.SmsSendResult"
fullName: "com.azure.communication.sms.models.SmsSendResult"
name: "SmsSendResult"
nameWithType: "SmsSendResult"
summary: "The Sms<wbr>Send<wbr>Result model."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **SmsSendResult**"
constructors:
- uid: "com.azure.communication.sms.models.SmsSendResult.SmsSendResult(java.lang.String,java.lang.String,int,boolean,java.lang.String)"
fullName: "com.azure.communication.sms.models.SmsSendResult.SmsSendResult(String to, String messageId, int httpStatusCode, boolean isSuccessful, String errorMessage)"
name: "SmsSendResult(String to, String messageId, int httpStatusCode, boolean isSuccessful, String errorMessage)"
nameWithType: "SmsSendResult.SmsSendResult(String to, String messageId, int httpStatusCode, boolean isSuccessful, String errorMessage)"
summary: "Constructor to wrap the sms<wbr>Send<wbr>Response<wbr>Item"
parameters:
- description: "The recipient's phone number in E.164 format."
name: "to"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The identifier of the outgoing Sms message. Only present if message processed."
name: "messageId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The httpStatusCode property: HTTP Status code."
name: "httpStatusCode"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- description: "The successful property: Indicates if the message is processed successfully or not."
name: "isSuccessful"
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- description: "Optional error message in case of 4xx/5xx/repeatable errors."
name: "errorMessage"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public SmsSendResult(String to, String messageId, int httpStatusCode, boolean isSuccessful, String errorMessage)"
desc: "Constructor to wrap the smsSendResponseItem"
methods:
- uid: "com.azure.communication.sms.models.SmsSendResult.getErrorMessage()"
fullName: "com.azure.communication.sms.models.SmsSendResult.getErrorMessage()"
name: "getErrorMessage()"
nameWithType: "SmsSendResult.getErrorMessage()"
summary: "Get the error<wbr>Message property: Optional error message in case of 4xx/5xx/repeatable errors."
syntax: "public String getErrorMessage()"
desc: "Get the errorMessage property: Optional error message in case of 4xx/5xx/repeatable errors."
returns:
description: "the errorMessage value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.communication.sms.models.SmsSendResult.getHttpStatusCode()"
fullName: "com.azure.communication.sms.models.SmsSendResult.getHttpStatusCode()"
name: "getHttpStatusCode()"
nameWithType: "SmsSendResult.getHttpStatusCode()"
summary: "Get the http<wbr>Status<wbr>Code property: HTTP Status code."
syntax: "public int getHttpStatusCode()"
desc: "Get the httpStatusCode property: HTTP Status code."
returns:
description: "the httpStatusCode value."
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.communication.sms.models.SmsSendResult.getMessageId()"
fullName: "com.azure.communication.sms.models.SmsSendResult.getMessageId()"
name: "getMessageId()"
nameWithType: "SmsSendResult.getMessageId()"
summary: "Get the message<wbr>Id property: The identifier of the outgoing Sms message."
syntax: "public String getMessageId()"
desc: "Get the messageId property: The identifier of the outgoing Sms message. Only present if message processed."
returns:
description: "the messageId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.communication.sms.models.SmsSendResult.getTo()"
fullName: "com.azure.communication.sms.models.SmsSendResult.getTo()"
name: "getTo()"
nameWithType: "SmsSendResult.getTo()"
summary: "Get the to property: The recipient's phone number in E.164 format."
syntax: "public String getTo()"
desc: "Get the to property: The recipient's phone number in E.164 format."
returns:
description: "the to value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.communication.sms.models.SmsSendResult.isSuccessful()"
fullName: "com.azure.communication.sms.models.SmsSendResult.isSuccessful()"
name: "isSuccessful()"
nameWithType: "SmsSendResult.isSuccessful()"
summary: "Get the successful property: Indicates if the message is processed successfully or not."
syntax: "public boolean isSuccessful()"
desc: "Get the successful property: Indicates if the message is processed successfully or not."
returns:
description: "the successful value."
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "The SmsSendResult model."
metadata: {}
package: "com.azure.communication.sms.models"
artifact: com.azure:azure-communication-sms:1.1.29