IHostedEmailExtension Interface

 

Indicates a hosted email extension.

Namespace:   Microsoft.WindowsServerSolutions.Administration.ObjectModel.Adorners
Assembly:  Wssg.HostedEmailBase (in Wssg.HostedEmailBase.dll)

Syntax

public interface IHostedEmailExtension

public interface class IHostedEmailExtension

Public Interface IHostedEmailExtension

Methods

	Name	Description
	GetAddinId()	Retrieves the ID of the associated add-in.

Remarks

An adorner that is part of a hosted email add-in should also implement this interface to associate itself with the hosted email add-in. For more information, see How to: Extend an Existing Dialog or Wizard.

Examples

The following example describes a class that is derived from IHostedEmailExtension. For the full example code, see Quickstart: Creating a Hosted Email Adapter.

public class DistributionGroupAdorner : FormContentAdorner, IHostedEmailExtension
{
    private DistributionGroupTabContent content = null;
    public DistributionGroupAdorner()
        : base(new Guid("B00F3F8D-176B-4A85-A1C9-3022A6E5B9BC"), Resources.DGAdorner_Name, Resources.DGAdorner_Des)
    {
    }

    public override ICollection<AddinPageContent> CreatePages(FormPropertyBag propertyBag)
    {
        List<AddinPageContent> list = new List<AddinPageContent>();
        content = new DistributionGroupTabContent(propertyBag)
        {
            Title = Resources.DGTab_Name,
            HelpLink = null,
            HelpLinkText = null
        }; 
        list.Add(content);
        return list;
    }

    public override ICollection<Task> CreatePostExecutionTasks(FormPropertyBag propertyBag)
    {
        return null;
    }

    public override ICollection<Task> CreatePreExecutionTasks(FormPropertyBag propertyBag)
    {
        if (content == null) return null;
        List<Task> tasks = new List<Task>();
        tasks.Add(new Task(() => content.UpdateDistributionGroups()));
        return tasks;
    }

    #region IHostedEmailExtension
    Guid IHostedEmailExtension.GetAddinId()
    {
        return Constants.AdaptorId;
    }
    #endregion
}

See Also

Microsoft.WindowsServerSolutions.Administration.ObjectModel.Adorners Namespace

Return to top