Dela via

INotificationHubClient Interface

  • Reference

Definition

Namespace:
Microsoft.Azure.NotificationHubs
Assembly:
Microsoft.Azure.NotificationHubs.dll
Package:
Microsoft.Azure.NotificationHubs v4.1.0

Represents a notification hub client.

public interface INotificationHubClient
type INotificationHubClient = interface
Public Interface INotificationHubClient
Derived

Properties

EnableTestSend

Gets or sets a value indicating whether the client enables a test send.

Methods

CancelNotificationAsync(String)

Cancels the notification asynchronously.
CancelNotificationAsync(String, CancellationToken)

Cancels the notification asynchronously.
CreateAdmNativeRegistrationAsync(String)

Asynchronously creates a native administrative registration.
CreateAdmNativeRegistrationAsync(String, CancellationToken)

Asynchronously creates a native administrative registration.
CreateAdmNativeRegistrationAsync(String, IEnumerable<String>)

Asynchronously creates a native administrative registration.
CreateAdmNativeRegistrationAsync(String, IEnumerable<String>, CancellationToken)

Asynchronously creates a native administrative registration.
CreateAdmTemplateRegistrationAsync(String, String)

Asynchronously creates an administrative template registration.
CreateAdmTemplateRegistrationAsync(String, String, CancellationToken)

Asynchronously creates an administrative template registration.
CreateAdmTemplateRegistrationAsync(String, String, IEnumerable<String>)

Asynchronously creates an administrative template registration.
CreateAdmTemplateRegistrationAsync(String, String, IEnumerable<String>, CancellationToken)

Asynchronously creates an administrative template registration.
CreateAppleNativeRegistrationAsync(String)

Asynchronously creates an Apple native registration.
CreateAppleNativeRegistrationAsync(String, CancellationToken)

Asynchronously creates an Apple native registration.
CreateAppleNativeRegistrationAsync(String, IEnumerable<String>)

Asynchronously creates an Apple native registration.
CreateAppleNativeRegistrationAsync(String, IEnumerable<String>, CancellationToken)

Asynchronously creates an Apple native registration.
CreateAppleTemplateRegistrationAsync(String, String)

Asynchronously creates an Apple template registration. To specify additional properties at creation, use the CreateRegistrationAsync<T>(T) method.
CreateAppleTemplateRegistrationAsync(String, String, CancellationToken)

Asynchronously creates an Apple template registration. To specify additional properties at creation, use the CreateRegistrationAsync<T>(T) method.
CreateAppleTemplateRegistrationAsync(String, String, IEnumerable<String>)

Asynchronously creates an Apple template registration. To specify additional properties at creation, use the CreateRegistrationAsync<T>(T) method.
CreateAppleTemplateRegistrationAsync(String, String, IEnumerable<String>, CancellationToken)

Asynchronously creates an Apple template registration. To specify additional properties at creation, use the CreateRegistrationAsync<T>(T) method.
CreateBaiduNativeRegistrationAsync(String, String)

Creates the baidu native registration asynchronously.
CreateBaiduNativeRegistrationAsync(String, String, IEnumerable<String>)

Creates the baidu native registration asynchronously.
CreateBaiduTemplateRegistrationAsync(String, String, String)

Creates the baidu template registration asynchronously.
CreateBaiduTemplateRegistrationAsync(String, String, String, IEnumerable<String>)

Creates the baidu template registration asynchronously.
CreateFcmNativeRegistrationAsync(String)

Asynchronously creates FCM native registration.
CreateFcmNativeRegistrationAsync(String, CancellationToken)

Asynchronously creates FCM native registration.
CreateFcmNativeRegistrationAsync(String, IEnumerable<String>)

Asynchronously creates FCM native registration.
CreateFcmNativeRegistrationAsync(String, IEnumerable<String>, CancellationToken)

Asynchronously creates FCM native registration.
CreateFcmTemplateRegistrationAsync(String, String)

Asynchronously creates FCM template registration.
CreateFcmTemplateRegistrationAsync(String, String, CancellationToken)

Asynchronously creates FCM template registration.
CreateFcmTemplateRegistrationAsync(String, String, IEnumerable<String>)

Asynchronously creates FCM template registration.
CreateFcmTemplateRegistrationAsync(String, String, IEnumerable<String>, CancellationToken)

Asynchronously creates FCM template registration.
CreateMpnsNativeRegistrationAsync(String)

Asynchronously creates MPNS native registration.
CreateMpnsNativeRegistrationAsync(String, IEnumerable<String>)

Asynchronously creates MPNS native registration.
CreateMpnsTemplateRegistrationAsync(String, String)

Asynchronously creates MPNS template registration. To specify additional properties at creation, use the CreateRegistrationAsync<T>(T) method.
CreateMpnsTemplateRegistrationAsync(String, String, IEnumerable<String>)

Asynchronously creates MPNS template registration. To specify additional properties at creation, use the CreateRegistrationAsync<T>(T) method.
CreateOrUpdateInstallation(Installation)

Creates or updates a device installation.
CreateOrUpdateInstallationAsync(Installation)

Creates or updates a device installation asynchronously.
CreateOrUpdateInstallationAsync(Installation, CancellationToken)

Creates or updates a device installation asynchronously.
CreateOrUpdateRegistrationAsync<T>(T)

Asynchronously creates or updates the client registration.
CreateOrUpdateRegistrationAsync<T>(T, CancellationToken)

Asynchronously creates or updates the client registration.
CreateRegistrationAsync<T>(T)

Asynchronously creates a registration.
CreateRegistrationAsync<T>(T, CancellationToken)

Asynchronously creates a registration.
CreateRegistrationIdAsync()

Asynchronously creates a registration identifier.
CreateRegistrationIdAsync(CancellationToken)

Asynchronously creates a registration identifier.
CreateWindowsNativeRegistrationAsync(String)

Asynchronously creates Windows native registration.
CreateWindowsNativeRegistrationAsync(String, CancellationToken)

Asynchronously creates Windows native registration.
CreateWindowsNativeRegistrationAsync(String, IEnumerable<String>)

Asynchronously creates Windows native registration.
CreateWindowsNativeRegistrationAsync(String, IEnumerable<String>, CancellationToken)

Asynchronously creates Windows native registration.
CreateWindowsTemplateRegistrationAsync(String, String)

Asynchronously creates Windows template registration.
CreateWindowsTemplateRegistrationAsync(String, String, CancellationToken)

Asynchronously creates Windows template registration.
CreateWindowsTemplateRegistrationAsync(String, String, IEnumerable<String>)

Asynchronously creates Windows template registration.
CreateWindowsTemplateRegistrationAsync(String, String, IEnumerable<String>, CancellationToken)

Asynchronously creates Windows template registration.
DeleteInstallation(String)

Deletes the installation.
DeleteInstallationAsync(String)

Deletes the installation asynchronously.
DeleteInstallationAsync(String, CancellationToken)

Deletes the installation asynchronously.
DeleteRegistrationAsync(RegistrationDescription)

Asynchronously deletes the registration.
DeleteRegistrationAsync(RegistrationDescription, CancellationToken)

Asynchronously deletes the registration.
DeleteRegistrationAsync(String)

Asynchronously deletes the registration.
DeleteRegistrationAsync(String, CancellationToken)

Asynchronously deletes the registration.
DeleteRegistrationAsync(String, String)

Asynchronously deletes the registration.
DeleteRegistrationAsync(String, String, CancellationToken)

Asynchronously deletes the registration.
DeleteRegistrationsByChannelAsync(String)

Asynchronously deletes the registrations by channel.
DeleteRegistrationsByChannelAsync(String, CancellationToken)

Asynchronously deletes the registrations by channel.
GetAllRegistrationsAsync(Int32)

Asynchronously retrieves all registrations in this notification hub.
GetAllRegistrationsAsync(Int32, CancellationToken)

Asynchronously retrieves all registrations in this notification hub.
GetAllRegistrationsAsync(String, Int32)

Asynchronously retrieves all registrations in this notification hub.
GetAllRegistrationsAsync(String, Int32, CancellationToken)

Asynchronously retrieves all registrations in this notification hub.
GetBaseUri()

Returns the base URI for the notification hub client.
GetFeedbackContainerUriAsync()

Gets the feedback container URI asynchronously.
GetFeedbackContainerUriAsync(CancellationToken)

Gets the feedback container URI asynchronously.
GetInstallation(String)

Gets a device installation object.
GetInstallationAsync(String)

Gets the installation asynchronously.
GetInstallationAsync(String, CancellationToken)

Gets the installation asynchronously.
GetNotificationHubJobAsync(String)

Given a jobId, returns the associated NotificationHubJob. This method is used to get the status of the job to see if that job completed, failed, or is still in progress. This API is only available for Standard namespaces.
GetNotificationHubJobAsync(String, CancellationToken)

Given a jobId, returns the associated NotificationHubJob. This method is used to get the status of the job to see if that job completed, failed, or is still in progress. This API is only available for Standard namespaces.
GetNotificationHubJobsAsync()

Returns all known NotificationHubJobs. This method is used to get the status of all job to see if those jobs completed, failed, or are still in progress. This API is only available for Standard namespaces.
GetNotificationHubJobsAsync(CancellationToken)

Returns all known NotificationHubJobs. This method is used to get the status of all job to see if those jobs completed, failed, or are still in progress. This API is only available for Standard namespaces.
GetNotificationOutcomeDetailsAsync(String)

Retrieves the results of a Send* operation. This can retrieve intermediate results if the send is being processed or final results if the Send* has completed. This API can only be called for Standard namespaces.
GetNotificationOutcomeDetailsAsync(String, CancellationToken)

Retrieves the results of a Send* operation. This can retrieve intermediate results if the send is being processed or final results if the Send* has completed. This API can only be called for Standard namespaces.
GetRegistrationAsync<TRegistrationDescription>(String)

Asynchronously retrieves a registration with a given ID. The type of the registration depends upon the specified TRegistrationDescription parameter.
GetRegistrationAsync<TRegistrationDescription>(String, CancellationToken)

Asynchronously retrieves a registration with a given ID. The type of the registration depends upon the specified TRegistrationDescription parameter.
GetRegistrationsByChannelAsync(String, Int32)

Asynchronously gets the registrations by channel.
GetRegistrationsByChannelAsync(String, Int32, CancellationToken)

Asynchronously gets the registrations by channel.
GetRegistrationsByChannelAsync(String, String, Int32)

Asynchronously gets the registrations by channel.
GetRegistrationsByChannelAsync(String, String, Int32, CancellationToken)

Asynchronously gets the registrations by channel.
GetRegistrationsByTagAsync(String, Int32)

Asynchronously gets the registrations by tag.
GetRegistrationsByTagAsync(String, Int32, CancellationToken)

Asynchronously gets the registrations by tag.
GetRegistrationsByTagAsync(String, String, Int32)

Asynchronously gets the registrations by tag.
GetRegistrationsByTagAsync(String, String, Int32, CancellationToken)

Asynchronously gets the registrations by tag.
InstallationExists(String)

Determines whether the given installation exists based upon the installation identifier.
InstallationExistsAsync(String)

Determines whether the given installation exists based upon the installation identifier.
InstallationExistsAsync(String, CancellationToken)

Determines whether the given installation exists based upon the installation identifier.
PatchInstallation(String, IList<PartialUpdateOperation>)

Patches the installation.
PatchInstallationAsync(String, IList<PartialUpdateOperation>)

Patches the installation asynchronously.
PatchInstallationAsync(String, IList<PartialUpdateOperation>, CancellationToken)

Patches the installation asynchronously.
RegistrationExistsAsync(String)

Asynchronously indicates that the registration already exists.
RegistrationExistsAsync(String, CancellationToken)

Asynchronously indicates that the registration already exists.
ScheduleNotificationAsync(Notification, DateTimeOffset)

Schedules the notification asynchronously.
ScheduleNotificationAsync(Notification, DateTimeOffset, CancellationToken)

Schedules the notification asynchronously.
ScheduleNotificationAsync(Notification, DateTimeOffset, IEnumerable<String>)

Schedules the notification asynchronously.
ScheduleNotificationAsync(Notification, DateTimeOffset, IEnumerable<String>, CancellationToken)

Schedules the notification asynchronously.
ScheduleNotificationAsync(Notification, DateTimeOffset, String)

Schedules the notification asynchronously.
ScheduleNotificationAsync(Notification, DateTimeOffset, String, CancellationToken)

Schedules the notification asynchronously.
SendAdmNativeNotificationAsync(String)

Sends the Amazon Device Messaging (ADM) native notification.
SendAdmNativeNotificationAsync(String, CancellationToken)

Sends the Amazon Device Messaging (ADM) native notification.
SendAdmNativeNotificationAsync(String, IEnumerable<String>)

Sends the Amazon Device Messaging (ADM) native notification.
SendAdmNativeNotificationAsync(String, IEnumerable<String>, CancellationToken)

Sends the Amazon Device Messaging (ADM) native notification.
SendAdmNativeNotificationAsync(String, String)

Sends the Amazon Device Messaging (ADM) native notification.
SendAdmNativeNotificationAsync(String, String, CancellationToken)

Sends the Amazon Device Messaging (ADM) native notification.
SendAppleNativeNotificationAsync(String)

Sends an Apple native notification. To specify an expiry, use the SendNotificationAsync(Notification) method.
SendAppleNativeNotificationAsync(String, CancellationToken)

Sends an Apple native notification. To specify an expiry, use the SendNotificationAsync(Notification) method.
SendAppleNativeNotificationAsync(String, IEnumerable<String>)

Asynchronously sends an Apple native notification to a non-empty set of tags (maximum 20). This is equivalent to a tagged expression with boolean ORs ("||"). To specify an expiry, use the SendNotificationAsync(Notification) method.
SendAppleNativeNotificationAsync(String, IEnumerable<String>, CancellationToken)

Asynchronously sends an Apple native notification to a non-empty set of tags (maximum 20). This is equivalent to a tagged expression with boolean ORs ("||"). To specify an expiry, use the SendNotificationAsync(Notification) method.
SendAppleNativeNotificationAsync(String, String)

Asynchronously sends an Apple native notification to a tag expression (a single tag "tag" is a valid tag expression). To specify an expiry, use the SendNotificationAsync(Notification) method.
SendAppleNativeNotificationAsync(String, String, CancellationToken)

Asynchronously sends an Apple native notification to a tag expression (a single tag "tag" is a valid tag expression). To specify an expiry, use the SendNotificationAsync(Notification) method.
SendBaiduNativeNotificationAsync(String)

Sends a Baidu native notification.
SendBaiduNativeNotificationAsync(String, CancellationToken)

Sends a Baidu native notification.
SendBaiduNativeNotificationAsync(String, IEnumerable<String>)

Sends Baidu native notification to a tag expression (a single tag "tag" is a valid tag expression).
SendBaiduNativeNotificationAsync(String, IEnumerable<String>, CancellationToken)

Sends Baidu native notification to a tag expression (a single tag "tag" is a valid tag expression).
SendBaiduNativeNotificationAsync(String, String)

Sends Baidu native notification to a tag expression (a single tag "tag" is a valid tag expression).
SendBaiduNativeNotificationAsync(String, String, CancellationToken)

Sends Baidu native notification to a tag expression (a single tag "tag" is a valid tag expression).
SendDirectNotificationAsync(Notification, IList<String>)

Sends a notification directly to all devices listed in deviceHandles (a valid tokens as expressed by the Notification type). Users of this API do not use Registrations or Installations. Instead, users of this API manage all devices on their own and use Azure Notification Hub solely as a pass through service to communicate with the various Push Notification Services.
SendDirectNotificationAsync(Notification, IList<String>, CancellationToken)

Sends a notification directly to all devices listed in deviceHandles (a valid tokens as expressed by the Notification type). Users of this API do not use Registrations or Installations. Instead, users of this API manage all devices on their own and use Azure Notification Hub solely as a pass through service to communicate with the various Push Notification Services.
SendDirectNotificationAsync(Notification, String)

Sends a notification directly to a deviceHandle (a valid token as expressed by the Notification type). Users of this API do not use Registrations or Installations. Instead, users of this API manage all devices on their own and use Azure Notification Hub solely as a pass through service to communicate with the various Push Notification Services.
SendDirectNotificationAsync(Notification, String, CancellationToken)

Sends a notification directly to a deviceHandle (a valid token as expressed by the Notification type). Users of this API do not use Registrations or Installations. Instead, users of this API manage all devices on their own and use Azure Notification Hub solely as a pass through service to communicate with the various Push Notification Services.
SendFcmNativeNotificationAsync(String)

Sends Firebase Cloud Messaging (FCM) native notification.
SendFcmNativeNotificationAsync(String, CancellationToken)

Sends Firebase Cloud Messaging (FCM) native notification.
SendFcmNativeNotificationAsync(String, IEnumerable<String>)

Sends a FCM native notification to a non-empty set of tags (max 20). This is equivalent to a tag expression with boolean ORs ("||").
SendFcmNativeNotificationAsync(String, IEnumerable<String>, CancellationToken)

Sends a FCM native notification to a non-empty set of tags (max 20). This is equivalent to a tag expression with boolean ORs ("||").
SendFcmNativeNotificationAsync(String, String)

Sends FCM native notification to a tag expression (a single tag "tag" is a valid tag expression).
SendFcmNativeNotificationAsync(String, String, CancellationToken)

Sends FCM native notification to a tag expression (a single tag "tag" is a valid tag expression).
SendMpnsNativeNotificationAsync(String)

Sends a Microsoft Push Notification Service (MPNS) native notification. To specify headers for MPNS, use the SendNotificationAsync(Notification) method.
SendMpnsNativeNotificationAsync(String, CancellationToken)

Sends a Microsoft Push Notification Service (MPNS) native notification. To specify headers for MPNS, use the SendNotificationAsync(Notification) method.
SendMpnsNativeNotificationAsync(String, IEnumerable<String>)

Sends a Microsoft Push Notification Service (MPNS) native notification to a non-empty set of tags (maximum 20). This is equivalent to a tag expression with boolean ORs ("||"). To specify headers for MPNS, use the SendNotificationAsync(Notification) method.
SendMpnsNativeNotificationAsync(String, IEnumerable<String>, CancellationToken)

Sends a Microsoft Push Notification Service (MPNS) native notification to a non-empty set of tags (maximum 20). This is equivalent to a tag expression with boolean ORs ("||"). To specify headers for MPNS, use the SendNotificationAsync(Notification) method.
SendMpnsNativeNotificationAsync(String, String)

Sends a Microsoft Push Notification Service (MPNS) native notification to a tag expression (a single tag "tag" is a valid tag expression). To specify headers for MPNS, use the SendNotificationAsync(Notification) method.
SendMpnsNativeNotificationAsync(String, String, CancellationToken)

Sends a Microsoft Push Notification Service (MPNS) native notification to a tag expression (a single tag "tag" is a valid tag expression). To specify headers for MPNS, use the SendNotificationAsync(Notification) method.
SendNotificationAsync(Notification)

Sends a notification to a non-empty set of tags (max 20). This is equivalent to a tag expression with boolean ORs ("||").
SendNotificationAsync(Notification, CancellationToken)

Sends a notification to a non-empty set of tags (max 20). This is equivalent to a tag expression with boolean ORs ("||").
SendNotificationAsync(Notification, IEnumerable<String>)

Asynchronously sends a notification to a non-empty set of tags (max 20). This is equivalent to a tag expression with boolean ORs ("||").
SendNotificationAsync(Notification, IEnumerable<String>, CancellationToken)

Asynchronously sends a notification to a non-empty set of tags (max 20). This is equivalent to a tag expression with boolean ORs ("||").
SendNotificationAsync(Notification, String)

Sends a notification to a tag expression (a single tag "tag" is a valid tag expression).
SendNotificationAsync(Notification, String, CancellationToken)

Sends a notification to a tag expression (a single tag "tag" is a valid tag expression).
SendTemplateNotificationAsync(IDictionary<String,String>)

Sends a template notification.
SendTemplateNotificationAsync(IDictionary<String,String>, CancellationToken)

Sends a template notification.
SendTemplateNotificationAsync(IDictionary<String,String>, IEnumerable<String>)

Sends a template notification to a non-empty set of tags (maximum 20). This is equivalent to a tag expression with boolean ORs ("||").
SendTemplateNotificationAsync(IDictionary<String,String>, IEnumerable<String>, CancellationToken)

Sends a template notification to a non-empty set of tags (maximum 20). This is equivalent to a tag expression with boolean ORs ("||").
SendTemplateNotificationAsync(IDictionary<String,String>, String)

Sends a template notification to a tag expression (a single tag "tag" is a valid tag expression).
SendTemplateNotificationAsync(IDictionary<String,String>, String, CancellationToken)

Sends a template notification to a tag expression (a single tag "tag" is a valid tag expression).
SendWindowsNativeNotificationAsync(String)

Asynchronously sends a Windows native notification. To specify headers for WNS, use the SendNotificationAsync(Notification) method.
SendWindowsNativeNotificationAsync(String, CancellationToken)

Asynchronously sends a Windows native notification. To specify headers for WNS, use the SendNotificationAsync(Notification) method.
SendWindowsNativeNotificationAsync(String, IEnumerable<String>)

Asynchronously sends a Windows native notification to a non-empty set of tags (max 20). This is equivalent to a tag expression with boolean ORs ("||"). To specify headers for WNS, use the SendNotificationAsync(Notification) method.
SendWindowsNativeNotificationAsync(String, IEnumerable<String>, CancellationToken)

Asynchronously sends a Windows native notification to a non-empty set of tags (max 20). This is equivalent to a tag expression with boolean ORs ("||"). To specify headers for WNS, use the SendNotificationAsync(Notification) method.
SendWindowsNativeNotificationAsync(String, String)

Asynchronously sends a Windows native notification to a tag expression (a single tag "tag" is a valid tag expression). To specify headers for WNS, use the SendNotificationAsync(Notification) method.
SendWindowsNativeNotificationAsync(String, String, CancellationToken)

Asynchronously sends a Windows native notification to a tag expression (a single tag "tag" is a valid tag expression). To specify headers for WNS, use the SendNotificationAsync(Notification) method.
SubmitNotificationHubJobAsync(NotificationHubJob)

Creates a NotificationHubJob. This API is only available for Standard namespaces.
SubmitNotificationHubJobAsync(NotificationHubJob, CancellationToken)

Creates a NotificationHubJob. This API is only available for Standard namespaces.
UpdateRegistrationAsync<T>(T)

Asynchronously updates the registration.
UpdateRegistrationAsync<T>(T, CancellationToken)

Asynchronously updates the registration.

Applies to