org.sakaiproject.lti.api.SiteEmailPreferenceSetter Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of basiclti-api Show documentation

There is a newer version: 23.3

/**
 * Copyright (c) 2009 The Sakai Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *             http://www.opensource.org/licenses/ECL-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.sakaiproject.lti.api;

import java.util.Map;

import org.sakaiproject.site.api.Site;
import org.sakaiproject.user.api.User;

/**
 *  @author Adrian Fish 
 */
public interface SiteEmailPreferenceSetter {

    /**
     * Picks up the ext_email_delivery_preference parameter, if supplied, and reflects it in the user's preferences
     * as a site override for the tool being launched. This is *not* an official part of the LTI 1.1 spec; this
     * functionality will probably become part of a LTI 2.0 consumer preferences service.
     */
    public void setupUserEmailPreferenceForSite(Map payload, User user, Site site, boolean isTrustedConsumer);
}