@azure-rest/communication-messages package

インターフェイス

AudioNotificationContent	オーディオ通知を送信する要求。
DocumentNotificationContent	ドキュメント通知を送信する要求。
GetMedia
GetMedia200Headers
GetMedia200Response	要求は成功しました。
GetMediaDefaultHeaders
GetMediaDefaultResponse
GetMediaHeaderParam
GetMediaHeaders
ImageNotificationContent	イメージ通知を送信する要求。
ListTemplates
ListTemplates200Headers
ListTemplates200Response	要求は成功しました。
ListTemplatesDefaultHeaders
ListTemplatesDefaultResponse
ListTemplatesHeaderParam
ListTemplatesHeaders
ListTemplatesQueryParam
ListTemplatesQueryParamProperties
MediaNotificationContent
MessageReceiptOutput	1 つのメッセージを送信したメッセージの受信。
MessageTemplate	テンプレートの作成に使用するテンプレート オブジェクト。
MessageTemplateBindingsParent	テンプレート固有の場所に値をリンクするバインディング オブジェクト
MessageTemplateDocument	メッセージ テンプレートのドキュメント値情報。
MessageTemplateImage	メッセージ テンプレートの画像値情報。
MessageTemplateItemOutputParent	サービスから返されたメッセージ テンプレート。
MessageTemplateLocation	メッセージ テンプレートの場所の値情報。
MessageTemplateQuickAction	メッセージ テンプレートのクイック アクション値情報。
MessageTemplateText	メッセージ テンプレートのテキスト値情報。
MessageTemplateValueParent	このクラスは、テンプレートのパラメーターを記述します。
MessageTemplateVideo	メッセージ テンプレートのビデオ値情報。
MessagesServiceClientOptions	クライアントの省略可能なパラメーター
NotificationContentParent	送信するメッセージの詳細。
PagingOptions	ページング ヘルパーのオプション
Routes
Send
Send202Headers
Send202Response	要求は処理のために受け入れ済みですが、処理はまだ完了していません。
SendBodyParam
SendDefaultHeaders
SendDefaultResponse
SendHeaderParam
SendHeaders
SendMessageResultOutput	メッセージ送信操作の結果。
TemplateNotificationContent	テンプレート通知を送信する要求。
TextNotificationContent	テキスト通知を送信する要求。
VideoNotificationContent	ビデオ通知を送信する要求。
WhatsAppMessageTemplateBindings	WhatsApp のテンプレート バインド
WhatsAppMessageTemplateBindingsButton	WhatsApp のテンプレート バインド コンポーネント ボタン
WhatsAppMessageTemplateBindingsComponent	WhatsApp のテンプレート バインド コンポーネント
WhatsAppMessageTemplateItemOutput	WhatsApp 固有のテンプレート応答コントラクト

型エイリアス

CommunicationMessageKind	CommunicationMessageKind のエイリアス
CommunicationMessagesChannelOutput	CommunicationMessagesChannelOutput のエイリアス
GetArrayType	配列の型を抽出するヘルパー型
GetMediaParameters
GetPage	ページの取得方法と、次のページへのリンク (ある場合) を定義するカスタム関数の型。
ListTemplatesParameters
MessageTemplateBindings	テンプレート固有の場所に値をリンクするバインディング オブジェクト
MessageTemplateBindingsKind	MessageTemplateBindingsKind のエイリアス
MessageTemplateItemOutput	サービスから返されたメッセージ テンプレート。
MessageTemplateStatusOutput	MessageTemplateStatusOutput のエイリアス
MessageTemplateValue	このクラスは、テンプレートのパラメーターを記述します。
MessageTemplateValueKind	MessageTemplateValueKind のエイリアス
MessagesServiceClient
NotificationContent	送信するメッセージの詳細。
PagedMessageTemplateItemOutput	MessageTemplateItem 項目の Paged コレクション
PaginateReturn	応答型からページングされた要素の型を推測するヘルパー型。この型は、ページアイテムが見つかった応答のプロパティを示す itemName プロパティに対する x-ms-pageable の swagger 情報に基づいて生成されます。 既定値は valueです。 この型を使用すると、2 番目のパラメーターとして取得する応答に基づいて、厳密に型指定された反復子を提供できます
RepeatabilityResultOutput	RepeatabilityResultOutput のエイリアス
SendParameters
WhatsAppMessageButtonSubType	WhatsAppMessageButtonSubType のエイリアス

関数

default(string, ClientOptions)	MessagesServiceClient の新しいインスタンスを初期化する
default(string, KeyCredential | TokenCredential, ClientOptions)	MessagesServiceClient の新しいインスタンスを初期化する
isUnexpected(GetMedia200Response | GetMediaDefaultResponse)
isUnexpected(Send202Response | SendDefaultResponse)
isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Autorest x-ms-pageable 拡張機能の仕様に従った最初の応答からの結果を改ページするヘルパー

関数の詳細

default(string, ClientOptions)

MessagesServiceClient の新しいインスタンスを初期化する

function default(connectionString: string, options?: ClientOptions): MessagesServiceClient

パラメーター

connectionString

string

Communication Services リソースの connectionString または URL。

options

ClientOptions

すべての省略可能なパラメーターのパラメーター

戻り値

MessagesServiceClient

default(string, KeyCredential | TokenCredential, ClientOptions)

MessagesServiceClient の新しいインスタンスを初期化する

function default(endpoint: string, credential: KeyCredential | TokenCredential, options?: ClientOptions): MessagesServiceClient

パラメーター

endpoint

string

Communication Services リソースのエンドポイント。

credential

KeyCredential | TokenCredential

キーまたはトークンの資格情報。

options

ClientOptions

すべての省略可能なパラメーターのパラメーター

戻り値

MessagesServiceClient

isUnexpected(GetMedia200Response | GetMediaDefaultResponse)

function isUnexpected(response: GetMedia200Response | GetMediaDefaultResponse): response

パラメーター

response

GetMedia200Response | GetMediaDefaultResponse

戻り値

response

isUnexpected(Send202Response | SendDefaultResponse)

function isUnexpected(response: Send202Response | SendDefaultResponse): response

パラメーター

response

Send202Response | SendDefaultResponse

戻り値

response

isUnexpected(ListTemplates200Response | ListTemplatesDefaultResponse)

function isUnexpected(response: ListTemplates200Response | ListTemplatesDefaultResponse): response

パラメーター

response

ListTemplates200Response | ListTemplatesDefaultResponse

戻り値

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Autorest x-ms-pageable 拡張機能の仕様に従った最初の応答からの結果を改ページするヘルパー

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

パラメーター

client

Client

次のページ要求の送信に使用するクライアント

initialResponse

TResponse

nextLink と要素の現在のページを含む初期応答

options

PagingOptions<TResponse>

戻り値

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator を使用して要素を反復処理する