NotificationRecipientUser interface
表示 NotificationRecipientUser 的介面。
方法
方法詳細資料
checkEntityExists(string, string, string, string, NotificationRecipientUserCheckEntityExistsOptionalParams)
判斷通知收件者使用者是否已訂閱通知。
function checkEntityExists(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserCheckEntityExistsOptionalParams): Promise<NotificationRecipientUserCheckEntityExistsResponse>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- notificationName
-
string
通知名稱識別碼。
- userId
-
string
使用者識別碼。 在目前API 管理服務實例中必須是唯一的。
選項參數。
傳回
createOrUpdate(string, string, string, string, NotificationRecipientUserCreateOrUpdateOptionalParams)
將API 管理使用者新增至通知的收件者清單。
function createOrUpdate(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserCreateOrUpdateOptionalParams): Promise<RecipientUserContract>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- notificationName
-
string
通知名稱識別碼。
- userId
-
string
使用者識別碼。 在目前API 管理服務實例中必須是唯一的。
選項參數。
傳回
Promise<RecipientUserContract>
delete(string, string, string, string, NotificationRecipientUserDeleteOptionalParams)
從通知清單中移除API 管理使用者。
function delete(resourceGroupName: string, serviceName: string, notificationName: string, userId: string, options?: NotificationRecipientUserDeleteOptionalParams): Promise<void>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- notificationName
-
string
通知名稱識別碼。
- userId
-
string
使用者識別碼。 在目前API 管理服務實例中必須是唯一的。
選項參數。
傳回
Promise<void>
listByNotification(string, string, string, NotificationRecipientUserListByNotificationOptionalParams)
取得已訂閱通知的通知收件者使用者清單。
function listByNotification(resourceGroupName: string, serviceName: string, notificationName: string, options?: NotificationRecipientUserListByNotificationOptionalParams): Promise<RecipientUserCollection>參數
- resourceGroupName
-
string
資源群組的名稱。 名稱不區分大小寫。
- serviceName
-
string
API 管理服務的名稱。
- notificationName
-
string
通知名稱識別碼。
傳回
Promise<RecipientUserCollection>