Telerik.Sitefinity.Services.Notifications

Declares common properties for any sender profile

Gets or sets the name.

The name.

Gets or sets the type of the profile.

The type of the profile.

Gets or sets if the sender profile is the default one for the specified profile type.

If the profile is default for the given type.

Gets or sets the custom properties of the subscriber. For example Mobile Phone, which could be used later by a custom message sender

The properties.

A proxy class which declares properties for sender profile

Initializes a new instance of the class.

The profile.

A proxy class which declares properties required to configure a smtp client

The type that specifies usage of smtp profile

Initializes a new instance of the class.

The sender profile.

Gets or sets the host.

The host.

Gets or sets the port.

The port.

Gets or sets the value which determines if authentication against the smtp server will be used.

Gets or sets the username.

The username.

Gets or sets the password.

The password.

Gets or sets if the smtp server will use SSL.

Gets or sets the default sender email address.

The default sender email address.

Gets or sets the size of the batch.

The size of the batch.

Gets or sets the batch pause interval.

The batch pause interval.

Contains constants that can be used as keys for the SMTP sender profile specific configurations.

Key for the ProfileType value.

Key for the UseSsl value.

Key for the DefaultSenderEmailAddress value.

Key for the Password value.

Key for the Username value.

Key for the Host value.

Key for the Port value.

Key for the UseAuthentication value.

Key for the BatchSize value.

Key for the BatchPauseInterval value.

Declares members needed for an object which is grouping a set of subscribers. It contains the unique system identifier of the persisted subscription list.

Declares members needed for an object which is grouping a set of subscribers.

Gets or sets the resolve key used for mapping this subscription list with one from external storage.

The resolve key.

Gets or sets the title of the subscription list.

The list title.

Gets or sets the description.

The description.

Gets the unique identity of the data item.

The id.

Inherits and contains the identifier of the internal persistent object that can be used for a retrieval of Subscriber information.

Declares members needed for an object to receive a notification message. Contains all information related to the receiver of notification messages.

Gets or sets the email.

The email.

Gets or sets the first name.

The first name.

Gets or sets the last name.

The last name.

Gets or sets the resolve key used for mapping this subscriber with a user from external storage.

The resolve key.

Gets or sets indication whether the subscriber should receive notifications or not.

True if the subscriber is active; otherwise false;

Gets or sets the custom properties of the subscriber. For example Mobile Phone, which could be used later by a custom message sender

The properties.

Gets or sets the unique id of the subscriber.

The id.

Contains the information for the notification message that was persisted in the notification system.

Contains the information used to construct the content of notification message

Gets or sets the subject.

The subject.

Gets or sets the HTML text of the body.

The body HTML.

Gets or sets the plain text version of the body.

The plain text version.

Gets or sets custom headers for this message.

The custom headers for this message.

Gets or sets the unique id of the message template.

The id.

Contains the returned information for the message job

Contains information required by the Send method of to send a message

Gets the template id.

The template id.

Gets the message.

The message.

Gets the subscriptions list id which contains the subscribers. This property is treated with a higher priority compared to the property, meaning that if this property is present, the latter is ignored.

Gets the excluded resolved keys, by which the excluded subscribers can be identified.

Stores information if the subscription list and subscribers that are not part of other list will be cleared after the job finishes.

Gets the subscribers. This property is treated with a lower priority compared to the property, meaning that if the latter is present, this property will be ignored.

Gets the sender email address.

The sender email address.

Gets the name of the sender.

The name of the sender.

Gets the type of the sender profile. (e.g. SMTP)

The type of the profile.

Gets the name the settings profile.

The name of the sender profile.

Gets or sets the description.

The description.

Gets or sets the custom message headers for the message.

The custom message headers for the message.

Gets or sets the id.

The id.

Gets or sets the message job state.

The status.

Gets or sets the failure information.

The failed job description.

Gets or sets the last activity date of the message job.

The last activity date.

The contract for NotificationService operations. Provides the ability to send notifications and manage the sender profiles, subscriptions and message templates.

Gets the default sender profile for the given type. If it doesn't exist tries to find the first from that type. Returns null if there is no profile for the given profile type.

The context. Type of the profile. The default or first sender profile for the given type.

Gets the sender profile.

The context of the application which invokes the method. Name of the profile. Returns the associate sender profile.

Gets the sender profiles for the specified context.

The query params. Returns the sender profiles for the specified context.

Saves the sender profile.

The context of the application which invokes the method. The profile.

Deletes the sender profile.

The context of the application which invokes the method. Name of the profile.

Creates a subscription list.

The context of the application which invokes the method. The subscription list. Returns the subscription list Id of the newly created subscription list.

Gets the subscription list.

The context of the application which invokes the method. The subscription list Id. Returns the associate subscription list.

Gets the subscription list.

The context of the application which invokes the method. Unique identifier in the bounds of the specified context. The resolveKey is designed to be used for handling the synchronization with external modules or systems. Returns the associate subscription list.

Gets the subscription lists.

The context of the application which invokes the method. The query params. Returns subscription lists for the given filters.

Updates the subscription list.

The context. The subscription list id. The new subscription list.

Updates the subscription list.

The context. Unique identifier in the bounds of the specified context. The resolveKey is designed to be used for handling the synchronization with external modules or systems. The new subscription list.

Deletes the subscription list.

The context of the application which invokes the method. The list Id.

Deletes the subscription list.

Determines whether a subscriber is subscribed to given subscription list.

The context of the application which invokes the method. The subscription list Id. Unique identifier in the bounds of the specified context. The resolveKey is designed to be used for handling the synchronization with external modules or systems. true if the specified subscriber is subscribed to the specified subscription list; otherwise, false.

Subscribes the specified subscriber to subscription list.

The context of the application which invokes the method. The subscription list Id. The subscriber.

Subscribes existing subscriber to subscription list.

The context of the application which invokes the method. The subscription list Id. The subscriber Id.

Removes the subscriber from the specified subscription list.

The context of the application which invokes the method. The subscription list Id. The subscriber Id

Creates subscriber.

The context of the application which invokes the method. An object which contains the required information for creating subscriber. Returns an object which contains all information related to the subscriber of notification messages

Gets the subscribers for the given subscription list.

The context of the application which invokes the method. The list id. The query params. Returns the subscribers for the given subscription list.

Gets the resolve keys of the subscribers that are part of the given list.

The context of the application which invokes the method. The list id. The query params. Returns the resolve keys of the subscribers that are part of the given list.

Gets the subscriber. Returns null if it cannot be found.

Gets the subscriber. Returns an exception if it cannot be found.

The context of the application which invokes the method. The subscriber Id. Returns the subscriber with the given id or an exception if there is no such.

Updates the subscriber.

The context of the application which invokes the method. The subscriber Id. The new subscriber information.

Updates the subscriber.

Deletes subscriber.

The context of the application which invokes the method. The subscriber Id.

Gets the message template. It throws an exception if there is no such template with the given id.

The context of the application which invokes the method. The template Id. Returns the message template with the given id.

Gets the message templates.

The context of the application which invokes the method. The query params. Returns the message templates for the given filters.

Creates the message template.

The context of the application which invokes the method. The template. Returns the message template Id of the newly created message template

Updates the message template.

The context of the application which invokes the method. The message template id. The new template.

Deletes the message template.

The context of the application which invokes the method. The template id.

Sends the specified message job.

The context of the application which invokes the method. The message job. The context items to bind to the template. The message job id.

Gets the message job.

The context of the application which invokes the method. The message job id. Returns the message job with the given id or an exception if there is no such.

Gets the message jobs.

The context of the application which invokes the method. The query params. Returns the message jobs for the given filters.

Deletes the message job.

The context of the application which invokes the method. The message job id.

Gets the resolve keys of subscribers of a specific notification job, to which messages had been successfully sent. Used, for example, by external invokers of the notification service (e.g. the NewslettersManager) in order to keep track of the subscribers, by their resolve-keys. This method can safely return data only while the job is executing. Once the job is done, it may be removed with all its subscription records.

The message job id. An IEnumerable collection of the resolve keys of subscribers of the specific notification job, to which delivery was successful.

Gets the resolve keys of subscribers of a specific notification job, to which messages had failed to send. Used, for example, by external invokers of the notification service (e.g. the NewslettersManager) in order to retrieve statistcics of failed deliveries, by their resolve-keys. This method can safely return data while the job is running or after it's complete, as the failed deliveries are persisted.

The message job id. IEnumerable collection of the resolve keys of subscribers of the specific notification job, to which delivery was unsuccessful.

Contains the available message job states.

The message job is persisted and ready to be started.

The message job has been started and subscribers are notified with the given message.

The message job has been stopped.

The message job has been finished and messages are sent.

The message job has failed.

The message job is still initializing and not ready to run yet.

Helper class that provides an implementation of the that can be instantiated and used in NotificationService communication

Initializes a new instance of the class.

Gets or sets custom headers for this message.

The custom headers for this message.

Helper class that provides an implementation of the ISubscriptionListRequest that can be instantiated and used in NotificationService communication

Contains parameters that will be applied to the selecting query

The number of elements to skip before returning the remaining elements.

The number of skipped items.

The number of elements to return.

Contains information about module and application consuming the service

Initializes a new instance of the class.

Account name. Module name.

Gets the application key (a secret key to filter the data by owner).

The application key.

Gets the name of the module (e.g. Forums).

The name of the module.

Helper class that provides an implementation of the ISubscriberRequest that can be instantiated and used in NotificationService communication