Try your search with a different keyword or use * as a wildcard.
using Nop.Core.Domain.Blogs;
using Nop.Core.Domain.Catalog;
using Nop.Core.Domain.Customers;
using Nop.Core.Domain.Forums;
using Nop.Core.Domain.Messages;
using Nop.Core.Domain.News;
using Nop.Core.Domain.Orders;
using Nop.Core.Domain.Shipping;
using Nop.Core.Domain.Stores;
using Nop.Core.Domain.Vendors;
namespace Nop.Services.Messages;
///
/// Message token provider
///
public partial interface IMessageTokenProvider
{
///
/// Add store tokens
///
/// List of already added tokens
/// Store
/// Email account
/// A task that represents the asynchronous operation
Task AddStoreTokensAsync(IList tokens, Store store, EmailAccount emailAccount);
///
/// Add order tokens
///
/// List of already added tokens
///
/// Language identifier
/// Vendor identifier
/// A task that represents the asynchronous operation
Task AddOrderTokensAsync(IList tokens, Order order, int languageId, int vendorId = 0);
///
/// Add refunded order tokens
///
/// List of already added tokens
/// Order
/// Refunded amount of order
/// A task that represents the asynchronous operation
Task AddOrderRefundedTokensAsync(IList tokens, Order order, decimal refundedAmount);
///
/// Add shipment tokens
///
/// List of already added tokens
/// Shipment item
/// Language identifier
/// A task that represents the asynchronous operation
Task AddShipmentTokensAsync(IList tokens, Shipment shipment, int languageId);
///
/// Add order note tokens
///
/// List of already added tokens
/// Order note
/// A task that represents the asynchronous operation
Task AddOrderNoteTokensAsync(IList tokens, OrderNote orderNote);
///
/// Add recurring payment tokens
///
/// List of already added tokens
/// Recurring payment
/// A task that represents the asynchronous operation
Task AddRecurringPaymentTokensAsync(IList tokens, RecurringPayment recurringPayment);
///
/// Add return request tokens
///
/// List of already added tokens
/// Return request
/// Order item
/// Language identifier
/// A task that represents the asynchronous operation
Task AddReturnRequestTokensAsync(IList tokens, ReturnRequest returnRequest, OrderItem orderItem, int languageId);
///
/// Add gift card tokens
///
/// List of already added tokens
/// Gift card
/// Language identifier
/// A task that represents the asynchronous operation
Task AddGiftCardTokensAsync(IList tokens, GiftCard giftCard, int languageId);
///
/// Add customer tokens
///
/// List of already added tokens
/// Customer identifier
/// A task that represents the asynchronous operation
Task AddCustomerTokensAsync(IList tokens, int customerId);
///
/// Add customer tokens
///
/// List of already added tokens
/// Customer
/// A task that represents the asynchronous operation
Task AddCustomerTokensAsync(IList tokens, Customer customer);
///
/// Add vendor tokens
///
/// List of already added tokens
/// Vendor
/// A task that represents the asynchronous operation
Task AddVendorTokensAsync(IList tokens, Vendor vendor);
///
/// Add newsletter subscription tokens
///
/// List of already added tokens
/// Newsletter subscription
/// A task that represents the asynchronous operation
Task AddNewsLetterSubscriptionTokensAsync(IList tokens, NewsLetterSubscription subscription);
///
/// Add product review tokens
///
/// List of already added tokens
/// Product review
/// A task that represents the asynchronous operation
Task AddProductReviewTokensAsync(IList tokens, ProductReview productReview);
///
/// Add blog comment tokens
///
/// List of already added tokens
/// Blog post comment
/// A task that represents the asynchronous operation
Task AddBlogCommentTokensAsync(IList tokens, BlogComment blogComment);
///
/// Add news comment tokens
///
/// List of already added tokens
/// News comment
/// A task that represents the asynchronous operation
Task AddNewsCommentTokensAsync(IList tokens, NewsComment newsComment);
///
/// Add product tokens
///
/// List of already added tokens
/// Product
/// Language identifier
/// A task that represents the asynchronous operation
Task AddProductTokensAsync(IList tokens, Product product, int languageId);
///
/// Add product attribute combination tokens
///
/// List of already added tokens
/// Product attribute combination
/// Language identifier
/// A task that represents the asynchronous operation
Task AddAttributeCombinationTokensAsync(IList tokens, ProductAttributeCombination combination, int languageId);
///
/// Add forum tokens
///
/// List of already added tokens
/// Forum
/// A task that represents the asynchronous operation
Task AddForumTokensAsync(IList tokens, Forum forum);
///
/// Add forum topic tokens
///
/// List of already added tokens
/// Forum topic
/// Friendly (starts with 1) forum topic page to use for URL generation
/// Forum post identifier
/// A task that represents the asynchronous operation
Task AddForumTopicTokensAsync(IList tokens, ForumTopic forumTopic,
int? friendlyForumTopicPageIndex = null, int? appendedPostIdentifierAnchor = null);
///
/// Add forum post tokens
///
/// List of already added tokens
/// Forum post
/// A task that represents the asynchronous operation
Task AddForumPostTokensAsync(IList tokens, ForumPost forumPost);
///
/// Add private message tokens
///
/// List of already added tokens
/// Private message
/// A task that represents the asynchronous operation
Task AddPrivateMessageTokensAsync(IList tokens, PrivateMessage privateMessage);
///
/// Add tokens of BackInStock subscription
///
/// List of already added tokens
/// BackInStock subscription
/// A task that represents the asynchronous operation
Task AddBackInStockTokensAsync(IList tokens, BackInStockSubscription subscription);
///
/// Get collection of allowed (supported) message tokens for campaigns
///
///
/// A task that represents the asynchronous operation
/// The task result contains the collection of allowed (supported) message tokens for campaigns
///
Task> GetListOfCampaignAllowedTokensAsync();
///
/// Get collection of allowed (supported) message tokens
///
/// Collection of token groups; pass null to get all available tokens
///
/// A task that represents the asynchronous operation
/// The task result contains the collection of allowed message tokens
///
Task> GetListOfAllowedTokensAsync(IEnumerable tokenGroups = null);
///
/// Get token groups of message template
///
/// Message template
/// Collection of token group names
IEnumerable GetTokenGroups(MessageTemplate messageTemplate);
}