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

92 строки
9.5 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.communication.messages.NotificationMessagesAsyncClient"
fullName: "com.azure.communication.messages.NotificationMessagesAsyncClient"
name: "NotificationMessagesAsyncClient"
nameWithType: "NotificationMessagesAsyncClient"
summary: "Initializes a new instance of the asynchronous Notification<wbr>Messages<wbr>Client type."
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 **NotificationMessagesAsyncClient**"
methods:
- uid: "com.azure.communication.messages.NotificationMessagesAsyncClient.downloadMedia(java.lang.String)"
fullName: "com.azure.communication.messages.NotificationMessagesAsyncClient.downloadMedia(String mediaId)"
name: "downloadMedia(String mediaId)"
nameWithType: "NotificationMessagesAsyncClient.downloadMedia(String mediaId)"
summary: "Download the Media payload from a User to Business message."
parameters:
- description: "The stream ID."
name: "mediaId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<BinaryData> downloadMedia(String mediaId)"
desc: "Download the Media payload from a User to Business message."
returns:
description: "the response body on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.messages.NotificationMessagesAsyncClient.downloadMediaWithResponse(java.lang.String,com.azure.core.http.rest.RequestOptions)"
fullName: "com.azure.communication.messages.NotificationMessagesAsyncClient.downloadMediaWithResponse(String mediaId, RequestOptions requestOptions)"
name: "downloadMediaWithResponse(String mediaId, RequestOptions requestOptions)"
nameWithType: "NotificationMessagesAsyncClient.downloadMediaWithResponse(String mediaId, RequestOptions requestOptions)"
summary: "Download the Media payload from a User to Business message."
parameters:
- description: "The stream ID."
name: "mediaId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The options to configure the HTTP request before HTTP client sends it."
name: "requestOptions"
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<BinaryData>> downloadMediaWithResponse(String mediaId, RequestOptions requestOptions)"
desc: "Download the Media payload from a User to Business message.\n\n**Response Body Schema**\n\n```java\nBinaryData\n```"
returns:
description: "the response body along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.communication.messages.NotificationMessagesAsyncClient.send(com.azure.communication.messages.models.NotificationContent)"
fullName: "com.azure.communication.messages.NotificationMessagesAsyncClient.send(NotificationContent notificationContent)"
name: "send(NotificationContent notificationContent)"
nameWithType: "NotificationMessagesAsyncClient.send(NotificationContent notificationContent)"
summary: "Sends a notification message from Business to User."
parameters:
- description: "Details of the message to send."
name: "notificationContent"
type: "<xref href=\"com.azure.communication.messages.models.NotificationContent?alt=com.azure.communication.messages.models.NotificationContent&text=NotificationContent\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<SendMessageResult> send(NotificationContent notificationContent)"
desc: "Sends a notification message from Business to User."
returns:
description: "result of the send message operation on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.communication.messages.models.SendMessageResult?alt=com.azure.communication.messages.models.SendMessageResult&text=SendMessageResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.communication.messages.NotificationMessagesAsyncClient.sendWithResponse(com.azure.core.util.BinaryData,com.azure.core.http.rest.RequestOptions)"
fullName: "com.azure.communication.messages.NotificationMessagesAsyncClient.sendWithResponse(BinaryData notificationContent, RequestOptions requestOptions)"
name: "sendWithResponse(BinaryData notificationContent, RequestOptions requestOptions)"
nameWithType: "NotificationMessagesAsyncClient.sendWithResponse(BinaryData notificationContent, RequestOptions requestOptions)"
summary: "Sends a notification message from Business to User."
parameters:
- description: "Details of the message to send."
name: "notificationContent"
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
- description: "The options to configure the HTTP request before HTTP client sends it."
name: "requestOptions"
type: "<xref href=\"com.azure.core.http.rest.RequestOptions?alt=com.azure.core.http.rest.RequestOptions&text=RequestOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<BinaryData>> sendWithResponse(BinaryData notificationContent, RequestOptions requestOptions)"
desc: "Sends a notification message from Business to User.\n\n**Header Parameters**\n\n | ------------------------ | ------ | -------- | -------------------------------------------- |\n | Name | Type | Required | Description |\n | repeatability-request-id | String | No | Repeatability request ID header |\n | repeatability-first-sent | String | No | Repeatability first sent header as HTTP-date |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addHeader\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addHeader\"></xref>\n\n**Request Body Schema**\n\n```java\n{\n channelRegistrationId: String (Required)\n to (Required): [\n String (Required)\n ]\n }\n```\n\n**Response Body Schema**\n\n```java\n{\n receipts (Required): [\n (Required){\n messageId: String (Required)\n to: String (Required)\n }\n ]\n }\n```"
returns:
description: "result of the send message operation along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of\n <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
type: "class"
desc: "Initializes a new instance of the asynchronous NotificationMessagesClient type."
metadata: {}
package: "com.azure.communication.messages"
artifact: com.azure:azure-communication-messages:1.0.6