NotificationHubClient Class

Definition

Represents a notification hub client.

public class NotificationHubClient
type NotificationHubClient = class
Public Class NotificationHubClient
Inheritance
System.Object
NotificationHubClient

Properties

EnableTestSend

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

Methods

CancelNotificationAsync(String)

Cancels the notification asynchronously.

CreateAdmNativeRegistrationAsync(String)

Asynchronously creates a native administrative registration.

CreateAdmNativeRegistrationAsync(String, IEnumerable<String>)

Asynchronously creates a native administrative registration.

CreateAdmTemplateRegistrationAsync(String, String)

Asynchronously creates an administrative template registration.

CreateAdmTemplateRegistrationAsync(String, String, IEnumerable<String>)

Asynchronously creates an administrative template registration.

CreateAppleNativeRegistrationAsync(String)

Asynchronously creates an Apple native registration.

CreateAppleNativeRegistrationAsync(String, IEnumerable<String>)

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, IEnumerable<String>)

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.

CreateClientFromConnectionString(String, String)

Creates a client from connection string.

CreateClientFromConnectionString(String, String, Boolean)

Creates a client from connection string.

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.

CreateOrUpdateRegistrationAsync<T>(T)

Asynchronously creates or updates the client registration.

CreateRegistrationAsync<T>(T)

Asynchronously creates a registration.

CreateRegistrationIdAsync()

Asynchronously creates a registration identifier.

CreateWindowsNativeRegistrationAsync(String)

Asynchronously creates Windows native registration.

CreateWindowsNativeRegistrationAsync(String, IEnumerable<String>)

Asynchronously creates Windows native registration.

CreateWindowsTemplateRegistrationAsync(String, String)

Asynchronously creates Windows template registration.

CreateWindowsTemplateRegistrationAsync(String, String, IEnumerable<String>)

Asynchronously creates Windows template registration.

DeleteInstallation(String)

Deletes the installation.

DeleteInstallationAsync(String)

Deletes the installation asynchronously.

DeleteRegistrationAsync(RegistrationDescription)

Asynchronously deletes the registration.

DeleteRegistrationAsync(String)

Asynchronously deletes the registration.

DeleteRegistrationAsync(String, String)

Asynchronously deletes the registration.

DeleteRegistrationsByChannelAsync(String)

Asynchronously deletes the registrations by channel.

GetAllRegistrationsAsync(Int32)

Asynchronously retrieves all registrations in this notification hub.

GetAllRegistrationsAsync(String, Int32)

Asynchronously retrieves all registrations in this notification hub.

GetBaseUri()

Gets the value of the BaseUri attached property.

GetInstallation(String)

Gets a device installation object.

GetInstallationAsync(String)

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.

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.

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.

GetRegistrationAsync<TRegistrationDescription>(String)

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, String, Int32)

Asynchronously gets the registrations by channel.

GetRegistrationsByTagAsync(String, Int32)

Asynchronously gets the registrations by tag.

GetRegistrationsByTagAsync(String, String, Int32)

Asynchronously gets the registrations by tag.

PatchInstallation(String, IList<PartialUpdateOperation>)

Patches the installation.

PatchInstallationAsync(String, IList<PartialUpdateOperation>)

Patches the installation asynchronously.

RegistrationExistsAsync(String)

Asynchronously indicates that the registration already exists.

ScheduleNotificationAsync(Notification, DateTimeOffset)

Schedules the notification asynchronously.

ScheduleNotificationAsync(Notification, DateTimeOffset, IEnumerable<String>)

Schedules the notification asynchronously.

ScheduleNotificationAsync(Notification, DateTimeOffset, String)

Schedules the notification asynchronously.

SendAdmNativeNotificationAsync(String)

Asynchronously sends the administrative native notification.

SendAdmNativeNotificationAsync(String, IEnumerable<String>)

Asynchronously sends the administrative native notification.

SendAdmNativeNotificationAsync(String, String)

Asynchronously sends the administrative native notification.

SendAppleNativeNotificationAsync(String)

Asynchronously 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, 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.

SendBaiduNativeNotificationAsync(String)

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, String)

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

SendMpnsNativeNotificationAsync(String)

Asynchronously sends MPNS native notification. To specify headers for MPNS, use the SendNotificationAsync(Notification) method.

SendMpnsNativeNotificationAsync(String, IEnumerable<String>)

Asynchronously sends 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)

Asynchronously sends 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)

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>)

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)

Asynchronously sends a notification to a tag expression (a single tag "tag" is a valid tag expression).

SendTemplateNotificationAsync(IDictionary<String,String>)

Asynchronously sends a template notification.

SendTemplateNotificationAsync(IDictionary<String,String>, IEnumerable<String>)

Asynchronously 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)

Asynchronously 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, 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, 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.

SubmitNotificationHubJobAsync(NotificationHubJob)

Creates a NotificationHubJob. This API is only available for Standard namespaces.

UpdateRegistrationAsync<T>(T)

Asynchronously updates the registration.

Applies to