Release 4.0.0-preview1-00201
[platform/core/csapi/tizenfx.git] / Artifacts / bin / public / Tizen.Applications.RemoteView.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3     <assembly>\r
4         <name>Tizen.Applications.RemoteView</name>\r
5     </assembly>\r
6     <members>\r
7         <member name="T:Tizen.Applications.RemoteView">\r
8             <summary>\r
9             Represents the proxy class for the widget application.\r
10             </summary>\r
11         </member>\r
12         <member name="T:Tizen.Applications.RemoteView.Event">\r
13             <summary>\r
14             The event types to send.\r
15             </summary>\r
16         </member>\r
17         <member name="F:Tizen.Applications.RemoteView.Event.FeedMouseUp">\r
18             <summary>\r
19             Type for feeding the mouse-up event to the widget application.\r
20             </summary>\r
21         </member>\r
22         <member name="F:Tizen.Applications.RemoteView.Event.CancelClick">\r
23             <summary>\r
24             Type for canceling the click event procedure.\r
25             </summary>\r
26         </member>\r
27         <member name="P:Tizen.Applications.RemoteView.Layout">\r
28             <summary>\r
29             Layout object including preview image, overlay text, loading text, and remote screen image.\r
30             </summary>\r
31             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
32         </member>\r
33         <member name="P:Tizen.Applications.RemoteView.Id">\r
34             <summary>\r
35             The widget ID.\r
36             </summary>\r
37             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
38         </member>\r
39         <member name="P:Tizen.Applications.RemoteView.Period">\r
40             <summary>\r
41             The update period.\r
42             </summary>\r
43             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
44         </member>\r
45         <member name="P:Tizen.Applications.RemoteView.Content">\r
46             <summary>\r
47             Contents of the widget.\r
48             </summary>\r
49             <remarks>\r
50             This string can be used for creating contents of the widget again after rebooting a device or it can be recovered from a crash (abnormal status).\r
51             </remarks>\r
52             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
53         </member>\r
54         <member name="P:Tizen.Applications.RemoteView.Title">\r
55             <summary>\r
56             Summarized string of the widget content for accessibility.\r
57             </summary>\r
58             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
59         </member>\r
60         <member name="M:Tizen.Applications.RemoteView.PauseAll">\r
61             <summary>\r
62             Pauses all the connected widget applications.\r
63             </summary>\r
64             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
65             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>\r
66             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>\r
67             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>\r
68         </member>\r
69         <!-- "M:Tizen.Applications.RemoteView.ResumeAll" 멤버에 대해 잘못된 형식의 XML 주석은 무시됩니다. -->\r
70         <member name="M:Tizen.Applications.RemoteView.Pause">\r
71             <summary>\r
72             Pauses the widget application which is connected on this proxy.\r
73             </summary>\r
74             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
75             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>\r
76             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>\r
77             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>\r
78         </member>\r
79         <member name="M:Tizen.Applications.RemoteView.Resume">\r
80             <summary>\r
81             Resumes the widget application which is connected on this proxy.\r
82             </summary>\r
83             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
84             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>\r
85             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>\r
86             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>\r
87         </member>\r
88         <member name="M:Tizen.Applications.RemoteView.SendEvent(Tizen.Applications.RemoteView.Event)">\r
89             <summary>\r
90             Sends the event to the widget application which is connected on this proxy.\r
91             </summary>\r
92             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
93             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>\r
94             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>\r
95         </member>\r
96         <member name="T:Tizen.Applications.RemoteViewFactory">\r
97             <summary>\r
98             Represents a factory class for making the RemoteView objects.\r
99             </summary>\r
100         </member>\r
101         <member name="M:Tizen.Applications.RemoteViewFactory.Init(ElmSharp.EvasObject)">\r
102             <summary>\r
103             Initializes RemoteViewFactory.\r
104             </summary>\r
105             <param name="win">Window object that will contain RemoteViews that are generated by RemoteViewFactory.\r
106             All the remote views will be located in the specified window object.\r
107             </param>\r
108             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
109             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>\r
110             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>\r
111             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>\r
112         </member>\r
113         <member name="M:Tizen.Applications.RemoteViewFactory.Create(ElmSharp.EvasObject,System.String,System.String,System.Double,System.Boolean,System.Boolean,System.Boolean)">\r
114             <summary>\r
115             Creates a RemoteView object.\r
116             </summary>\r
117             <param name="parent">Parent object.</param>\r
118             <param name="widgetId">Widget ID.</param>\r
119             <param name="content">Contents that will be given to the widget instance.</param>\r
120             <param name="period">Update period.</param>\r
121             <param name="previewImage">True if you want to show the preview image.</param>\r
122             <param name="overlayText">True if you want to show the overlay text.</param>\r
123             <param name="loadingMessage">True if you want to show the loading message.</param>\r
124             <returns>RemoteView object.</returns>\r
125             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
126             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>\r
127             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>\r
128             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>\r
129         </member>\r
130         <member name="M:Tizen.Applications.RemoteViewFactory.Shutdown">\r
131             <summary>\r
132             Finalizes the RemoteViewFactory.\r
133             </summary>\r
134             <privilege>http://tizen.org/privilege/widget.viewer</privilege>\r
135             <exception cref="T:System.InvalidOperationException">Thrown when this operation failed.</exception>\r
136             <exception cref="T:System.UnauthorizedAccessException">Thrown when this operation is denied.</exception>\r
137             <exception cref="T:System.NotSupportedException">Thrown when this operation is not supported for this device.</exception>\r
138         </member>\r
139     </members>\r
140 </doc>\r