NotificationRecipientEmails Interface

public interface NotificationRecipientEmails

Resource collection API of NotificationRecipientEmails.

Method Summary

Modifier and Type Method and Description
abstract boolean checkEntityExists(String resourceGroupName, String serviceName, NotificationName notificationName, String email)

Determine if Notification Recipient Email subscribed to the notification.

abstract Response<Boolean> checkEntityExistsWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, Context context)

Determine if Notification Recipient Email subscribed to the notification.

abstract RecipientEmailContract createOrUpdate(String resourceGroupName, String serviceName, NotificationName notificationName, String email)

Adds the Email address to the list of Recipients for the Notification.

abstract Response<RecipientEmailContract> createOrUpdateWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, Context context)

Adds the Email address to the list of Recipients for the Notification.

abstract void delete(String resourceGroupName, String serviceName, NotificationName notificationName, String email)

Removes the email from the list of Notification.

abstract Response<Void> deleteWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, Context context)

Removes the email from the list of Notification.

abstract RecipientEmailCollection listByNotification(String resourceGroupName, String serviceName, NotificationName notificationName)

Gets the list of the Notification Recipient Emails subscribed to a notification.

abstract Response<RecipientEmailCollection> listByNotificationWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, Context context)

Gets the list of the Notification Recipient Emails subscribed to a notification.

Method Details

checkEntityExists

public abstract boolean checkEntityExists(String resourceGroupName, String serviceName, NotificationName notificationName, String email)

Determine if Notification Recipient Email subscribed to the notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
email - Email identifier.

Returns:

whether resource exists.

checkEntityExistsWithResponse

public abstract Response checkEntityExistsWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, Context context)

Determine if Notification Recipient Email subscribed to the notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
email - Email identifier.
context - The context to associate with this operation.

Returns:

whether resource exists along with Response<T>.

createOrUpdate

public abstract RecipientEmailContract createOrUpdate(String resourceGroupName, String serviceName, NotificationName notificationName, String email)

Adds the Email address to the list of Recipients for the Notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
email - Email identifier.

Returns:

recipient Email details.

createOrUpdateWithResponse

public abstract Response createOrUpdateWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, Context context)

Adds the Email address to the list of Recipients for the Notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
email - Email identifier.
context - The context to associate with this operation.

Returns:

recipient Email details along with Response<T>.

delete

public abstract void delete(String resourceGroupName, String serviceName, NotificationName notificationName, String email)

Removes the email from the list of Notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
email - Email identifier.

deleteWithResponse

public abstract Response deleteWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, String email, Context context)

Removes the email from the list of Notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
email - Email identifier.
context - The context to associate with this operation.

Returns:

listByNotification

public abstract RecipientEmailCollection listByNotification(String resourceGroupName, String serviceName, NotificationName notificationName)

Gets the list of the Notification Recipient Emails subscribed to a notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.

Returns:

the list of the Notification Recipient Emails subscribed to a notification.

listByNotificationWithResponse

public abstract Response listByNotificationWithResponse(String resourceGroupName, String serviceName, NotificationName notificationName, Context context)

Gets the list of the Notification Recipient Emails subscribed to a notification.

Parameters:

resourceGroupName - The name of the resource group. The name is case insensitive.
serviceName - The name of the API Management service.
notificationName - Notification Name Identifier.
context - The context to associate with this operation.

Returns:

the list of the Notification Recipient Emails subscribed to a notification along with Response<T>.

Applies to