61 строка
5.6 KiB
YAML
61 строка
5.6 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.communication.messages.MessageTemplateClient"
|
|
fullName: "com.azure.communication.messages.MessageTemplateClient"
|
|
name: "MessageTemplateClient"
|
|
nameWithType: "MessageTemplateClient"
|
|
summary: "Initializes a new instance of the synchronous Message<wbr>Template<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 **MessageTemplateClient**"
|
|
methods:
|
|
- uid: "com.azure.communication.messages.MessageTemplateClient.listTemplates(java.lang.String)"
|
|
fullName: "com.azure.communication.messages.MessageTemplateClient.listTemplates(String channelId)"
|
|
name: "listTemplates(String channelId)"
|
|
nameWithType: "MessageTemplateClient.listTemplates(String channelId)"
|
|
summary: "List all templates for given Azure Communication Services channel."
|
|
parameters:
|
|
- description: "The registration ID of the channel."
|
|
name: "channelId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PagedIterable<MessageTemplateItem> listTemplates(String channelId)"
|
|
desc: "List all templates for given Azure Communication Services channel."
|
|
returns:
|
|
description: "paged collection of MessageTemplateItem items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.communication.messages.models.MessageTemplateItem?alt=com.azure.communication.messages.models.MessageTemplateItem&text=MessageTemplateItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.communication.messages.MessageTemplateClient.listTemplates(java.lang.String,com.azure.core.http.rest.RequestOptions)"
|
|
fullName: "com.azure.communication.messages.MessageTemplateClient.listTemplates(String channelId, RequestOptions requestOptions)"
|
|
name: "listTemplates(String channelId, RequestOptions requestOptions)"
|
|
nameWithType: "MessageTemplateClient.listTemplates(String channelId, RequestOptions requestOptions)"
|
|
summary: "List all templates for given Azure Communication Services channel."
|
|
parameters:
|
|
- description: "The registration ID of the channel."
|
|
name: "channelId"
|
|
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 PagedIterable<BinaryData> listTemplates(String channelId, RequestOptions requestOptions)"
|
|
desc: "List all templates for given Azure Communication Services channel.\n\n**Query Parameters**\n\n | ----------- | ------- | -------- | ------------------------------------- |\n | Name | Type | Required | Description |\n | maxpagesize | Integer | No | Number of objects to return per page. |\n\nYou can add these to a request with <xref uid=\"com.azure.core.http.rest.RequestOptions.addQueryParam\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RequestOptions#addQueryParam\"></xref>\n\n**Response Body Schema**\n\n```java\n{\n name: String (Required)\n language: String (Required)\n status: String(approved/rejected/pending/paused) (Required)\n }\n```"
|
|
returns:
|
|
description: "paged collection of MessageTemplateItem items as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
|
|
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Initializes a new instance of the synchronous MessageTemplateClient type."
|
|
metadata: {}
|
|
package: "com.azure.communication.messages"
|
|
artifact: com.azure:azure-communication-messages:1.0.6
|