1 /**
2 * This file Copyright (c) 2012-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.api.app;
35
36 import info.magnolia.ui.api.context.UiContext;
37 import info.magnolia.ui.api.location.Location;
38 import info.magnolia.ui.api.message.Message;
39
40 import java.util.Collection;
41 import java.util.Collections;
42
43 /**
44 * Provides functionality used by an app to interact with the Magnolia shell.
45 */
46 public interface AppContext extends AppView.Listener, UiContext {
47
48 void sendUserMessage(String user, Message message);
49
50 void sendGroupMessage(String group, Message message);
51
52 void sendLocalMessage(Message message);
53
54 void broadcastMessage(Message message);
55
56 void showConfirmationMessage(String message);
57
58 String getName();
59
60 String getLabel();
61
62 AppView getView();
63
64 void openSubApp(Location location);
65
66 void closeSubApp(String instanceId);
67
68 void updateSubAppLocation(SubAppContext subAppContext, Location location);
69
70 SubAppDescriptor getDefaultSubAppDescriptor();
71
72 SubAppContext getActiveSubAppContext();
73
74 AppDescriptor getAppDescriptor();
75
76 default Collection<SubAppContext> getSubAppContexts() {
77 return Collections.emptyList();
78 }
79
80 }