Package com.novomind.ecom.api.imail.common.frontend.message

Interface MessageViewContext

All Superinterfaces:

MessageInfo, TicketProvider, UserProvider, ViewContext

All Known Subinterfaces:

IncomingMessageViewContext, SentMessageViewContext

public interface MessageViewContext
extends ViewContext, MessageInfo, TicketProvider

This interface provides information and functionality for view context sensitive data and operations.

Since:

10.0.132

Method Summary

Modifier and Type	Method	Description
String	getViewUrl(String viewPath)	This method should be used to prepare the message view url

Methods inherited from interface com.novomind.ecom.api.imail.model.MessageInfo

getTicketId

Methods inherited from interface com.novomind.ecom.api.imail.provider.TicketProvider

getTicket

Methods inherited from interface com.novomind.ecom.api.iagent.frontend.ViewContext

getUser

Method Details

getViewUrl

String getViewUrl(String viewPath)

This method should be used to prepare the message view url

Parameters:

viewPath - the relative path to the view (.xhtml) or an absolute url. Supported formats: 1. Absolute path without protocol: //host.domain.com/... 2. Absolute path with protocol: http://host.domain.com/... https://host.domain.com/... 3. Relative path to .xhtml file: /mailinfo/helloworld/helloWorldBacklog.xhtml Example:

         public class HelloWorldMessageTab implements MessageTabProvider {
           @Override
           public MessageTab getMessageTab(IncomingMessageViewContext context) {
             return new MessageTab(name, displayName, context.getViewUrl("/message/helloworld/helloWorld.xhtml"));
           }
         }
         

Returns:

the correct url to render the view that can be passed to MessageTab

Since:

10.0.132